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

/**
 * A light sensor that reports current ambient light level.
 *
 * @author Gaston Dombiak
 */
public interface LightSensorAccessory extends HomekitAccessory {

  /**
   * Retrieves the current ambient light level.
   *
   * @return a future that will contain the luminance level expressed in LUX.
   */
  CompletableFuture getCurrentAmbientLightLevel();

  /**
   * Subscribes to changes in the current ambient light level.
   *
   * @param callback the function to call when the state changes.
   */
  void subscribeCurrentAmbientLightLevel(HomekitCharacteristicChangeCallback callback);

  /** Unsubscribes from changes in the current ambient light level. */
  void unsubscribeCurrentAmbientLightLevel();

  /**
   * return the min value for current ambient light level. overwrite if you want to change the
   * default value.
   *
   * @return min current ambient light level
   */
  default double getMinCurrentAmbientLightLevel() {
    return CurrentAmbientLightLevelCharacteristic.DEFAULT_MIN_VALUE;
  }

  /**
   * return the max value for current ambient light level. overwrite if you want to change the
   * default value.
   *
   * @return max current ambient light level
   */
  default double getMaxCurrentAmbientLightLevel() {
    return CurrentAmbientLightLevelCharacteristic.DEFAULT_MAX_VALUE;
  }

  /**
   * return the min step value for current ambient light level. overwrite if you want to change the
   * default value.
   *
   * @return min step current ambient light level
   */
  default double getMinStepCurrentAmbientLightLevel() {
    return CurrentAmbientLightLevelCharacteristic.DEFAULT_STEP;
  }

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