io.github.hapjava.accessories.HumiditySensorAccessory 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.HumiditySensorService;
import java.util.Collection;
import java.util.Collections;
import java.util.concurrent.CompletableFuture;

/**
 * A humidity sensor that reports the current relative humidity.
 *
 * @author Andy Lintner
 */
public interface HumiditySensorAccessory extends HomekitAccessory {

  /**
   * Retrieves the current relative humidity.
   *
   * @return a future that will contain the humidity as a value between 0 and 100
   */
  CompletableFuture getCurrentRelativeHumidity();

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

  /** Unsubscribes from changes in the current relative humidity. */
  void unsubscribeCurrentRelativeHumidity();

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