io.github.hapjava.accessories.OutletAccessory 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.services.Service;
import io.github.hapjava.services.impl.OutletService;
import java.util.Collection;
import java.util.Collections;
import java.util.concurrent.CompletableFuture;

/**
 * A power outlet with boolean power and usage states.
 *
 * @author Andy Lintner
 */
public interface OutletAccessory extends HomekitAccessory {

  /**
   * Retrieves the current binary state of the outlet's power.
   *
   * @return a future that will contain the binary state
   */
  CompletableFuture getPowerState();

  /**
   * Retrieves the current binary state indicating whether the outlet is in use.
   *
   * @return a future that will contain the binary state
   */
  CompletableFuture getOutletInUse();

  /**
   * Sets the binary state of the outlet's power.
   *
   * @param state the binary state to set
   * @return a future that completes when the change is made
   * @throws Exception when the change cannot be made
   */
  CompletableFuture setPowerState(boolean state) throws Exception;

  /**
   * Subscribes to changes in the binary state of the outlet's power.
   *
   * @param callback the function to call when the state changes.
   */
  void subscribePowerState(HomekitCharacteristicChangeCallback callback);

  /**
   * Subscribes to changes in the binary state indicating whether the outlet is in use.
   *
   * @param callback the function to call when the state changes.
   */
  void subscribeOutletInUse(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes in the binary state of the outlet's power. */
  void unsubscribePowerState();

  /** Unsubscribes from changes in the binary state indicating whether hte outlet is in use. */
  void unsubscribeOutletInUse();

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