io.github.hapjava.accessories.GarageDoorOpenerAccessory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hap Show documentation

Homekit Accessory Protocol for Java

There is a newer version: 2.0.7

package io.github.hapjava.accessories;

import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
import io.github.hapjava.characteristics.impl.garagedoor.CurrentDoorStateEnum;
import io.github.hapjava.characteristics.impl.garagedoor.TargetDoorStateEnum;
import io.github.hapjava.services.Service;
import io.github.hapjava.services.impl.GarageDoorOpenerService;
import java.util.Collection;
import java.util.Collections;
import java.util.concurrent.CompletableFuture;

/**
 * garage door opener accessory with control and status of a garage door
 *
 * @author Andy Lintner
 */
public interface GarageDoorOpenerAccessory extends HomekitAccessory {

  /**
   * Retrieves the current state of the door
   *
   * @return a future which will contain the door's state
   */
  CompletableFuture getCurrentDoorState();

  /**
   * Retrieves the targeted state of the door
   *
   * @return a future which will contain the door's targeted state
   */
  CompletableFuture getTargetDoorState();

  /**
   * Retrieves an indicator of an obstruction detected by the door
   *
   * @return a future which will contain the indicator
   */
  CompletableFuture getObstructionDetected();

  /**
   * Sets the targeted state of the door.
   *
   * @param state the targeted state
   * @return a future that completes when the change is made
   * @throws Exception when the change cannot be made
   */
  CompletableFuture setTargetDoorState(TargetDoorStateEnum state) throws Exception;

  /**
   * Subscribes to changes in the door's state
   *
   * @param callback the function to call when the state changes
   */
  void subscribeCurrentDoorState(HomekitCharacteristicChangeCallback callback);

  /**
   * Subscribes to changes in the door's targeted state
   *
   * @param callback the function to call when the targeted state changes
   */
  void subscribeTargetDoorState(HomekitCharacteristicChangeCallback callback);

  /**
   * Subscribes to changes in the obstruction detected indicator
   *
   * @param callback the function to call when the indicator chnages
   */
  void subscribeObstructionDetected(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes in the door's state */
  void unsubscribeCurrentDoorState();

  /** Unsubscribes from changes in the door's targeted state */
  void unsubscribeTargetDoorState();

  /** Unsubscribes from changes in the door's obstruction detected indicator */
  void unsubscribeObstructionDetected();

  @Override
  default Collection getServices() {
    return Collections.singleton(new GarageDoorOpenerService(this));
  }
}