io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithHumidityDehumidifierThreshold 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.optionalcharacteristic;

import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
import java.util.concurrent.CompletableFuture;

/** Dehumidifier with humidity threshold. */
public interface AccessoryWithHumidityDehumidifierThreshold {

  /**
   * Retrieves the humidity threshold.
   *
   * @return a future that will contain the humidity threshold.
   */
  CompletableFuture getHumidityThreshold();

  /**
   * Sets the humidity threshold above which the dehumidifier should be turned on.
   *
   * @param value the humidity threshold, in celsius degrees.
   * @throws Exception when the threshold cannot be changed.
   */
  void setHumidityThreshold(Double value) throws Exception;

  /**
   * Subscribes to changes in the humidity threshold.
   *
   * @param callback the function to call when the state changes.
   */
  void subscribeHumidityThreshold(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes in the humidity threshold. */
  void unsubscribeHumidityThreshold();
}