Package io.github.zeroone3010.yahueapi

Interface Sensor

All Known Subinterfaces:
AmbientLightSensor, DaylightSensor, PresenceSensor, Switch, TemperatureSensor
All Known Implementing Classes:
AmbientLightSensorImpl
public interface Sensor
A sensor, physical or virtual, capable of producing input into the Hue Bridge so that the Bridge can react to it. A wall switch with one or more buttons, a motion detector, a temperature sensor, or any other such device.

  • Method Summary

    Modifier and Type Method Description
    String getId()
    Returns the id of the sensor, as assigned by the Bridge.
    ZonedDateTime getLastUpdated()
    Returns the last time the sensor status has been updated, or null if it has not been updated.
    String getName()
    Returns the human readable name of the sensor as set by the user, e.g.
    String getProductName()
    Returns the human readable name of the sensor product, e.g.
    SensorType getType()
    Returns the type of the sensor.

  • Method Details

    • getName

      String getName()
      Returns the human readable name of the sensor as set by the user, e.g. "Living room switch".
      Returns:
      Name of the sensor.

    • getProductName

      String getProductName()
      Returns the human readable name of the sensor product, e.g. "Hue motion sensor" or "Hue tap switch".
      Returns:
      Name of the sensor product. May be null.

    • getId

      String getId()
      Returns the id of the sensor, as assigned by the Bridge.
      Returns:
      The sensor id.

    • getType

      SensorType getType()
      Returns the type of the sensor.
      Returns:
      The type of the sensor as a SensorType enumeration value.

    • getLastUpdated

      ZonedDateTime getLastUpdated()
      Returns the last time the sensor status has been updated, or null if it has not been updated.
      Returns:
      The time when the sensor status was last updated, or null.