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

/**
 * A temperature sensor that reports the current temperature
 *
 * @author Andy Lintner
 */
public interface TemperatureSensorAccessory extends HomekitAccessory {

  /**
   * Retrieves the current temperature, in celsius degrees.
   *
   * @return a future that will contain the temperature.
   */
  CompletableFuture getCurrentTemperature();

  /**
   * return the min value for current temperature. overwrite if you want to change the default
   * value.
   *
   * @return min current temperature
   */
  default double getMinCurrentTemperature() {
    return 0;
  }

  /**
   * return the max value for current temperature. overwrite if you want to change the default
   * value.
   *
   * @return max current temperature
   */
  default double getMaxCurrentTemperature() {
    return 100;
  }

  /**
   * return the min step value for current temperature. overwrite if you want to change the default
   * value.
   *
   * @return min step current temperature
   */
  default double getMinStepCurrentTemperature() {
    return 0.1;
  }

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

  /** Unsubscribes from changes in the current temperature. */
  void unsubscribeCurrentTemperature();

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