io.github.zeroone3010.yahueapi.Sensor 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;

import java.time.ZonedDateTime;

/**
 * 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.
 */
public interface Sensor {
  /**
   * Returns the human readable name of the sensor as set by the user, e.g. "Living room switch".
   *
   * @return Name of the sensor.
   */
  String getName();

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

  /**
   * Returns the id of the sensor, as assigned by the Bridge.
   *
   * @return The sensor id.
   */
  String getId();

  /**
   * Returns the type of the sensor.
   *
   * @return The type of the sensor as a {@code SensorType} enumeration value.
   */
  SensorType getType();

  /**
   * Returns the last time the sensor status has been updated, or null if it has not been updated.
   *
   * @return The time when the sensor status was last updated, or null.
   */
  ZonedDateTime getLastUpdated();
}