io.github.zeroone3010.yahueapi.AmbientLightSensor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yetanotherhueapi Show documentation

A library for controlling Philips Hue lights.

There is a newer version: 3.0.0-rc

package io.github.zeroone3010.yahueapi;

public interface AmbientLightSensor extends Sensor {

  /**
   * Returns the current light level in lux.
   *
   * @return A {@code int} indicating the current light level in lux.
   */
  int getLightLevel();

  /**
   * Tells whether the current light level is above light threshold.
   *
   * @return {@code true} if above light threshold, {@code false} if not.
   */
  boolean isDaylight();

  /**
   * Tells whether the current light level is below darkness threshold.
   *
   * @return {@code true} if below darkness threshold, {@code false} if not.
   */
  boolean isDark();
}