Philips Hue | CLIP API | V2


Philips Hue CLIP API

This driver supports communication with a Philips Hue bridge, allowing to control lights, lighting groups, different sensors and activate scenes.

Connecting to the system

Connection to the system is done via a REST connection with the Philips Hue bridge. The following configuration is needed:

  1. Bridge host: The IP address or host name of the bridge.
  2. Bridge id: The internal identifier of the HUE bridge. This field is automatically updated when the connection is established.
  3. Bridge user: This user is automatically created when the button Create Philips HUE user on bridge is pressed, as described below.
  4. New color turns dimmers on: If this flag is set, and a new color is picked for a dimmer that is turned off, then the dimmer will be turned on with the new selected color.

If system connection can’t be established specifying Hue Bridge Hostname on Bridge host, bad configuration or absence of the DNS server on the BeoLiving Intelligence LAN could be responsible for the issue. Try using the IP address of the Bridge. Default Hostname of Hue Bridge is Philips-hue.

If the Bridge user is not defined or is invalid, then you can create a new one by pressing the link button on the bridge and then pressing the Create Philips HUE user on bridge within 30 seconds. If the action is successful, then a new user will be assigned, updating the value for Bridge user.

Available resources

The Philips Hue driver supports commanding the lights, groups, sensors and scenes that are available for the configured user.

The following resource types are available:

  • On Off Light: supports on/off control.
  • Dimmable Light: supports on/off control and dimming.
  • Color Temperature Light: supports on/off control, dimming and setting color temperature.
  • Color Light: supports on/off control, dimming and setting color in either hue or color coordinates.
  • Extended Color Light: supports on/off control, dimming, setting color (hue or color coordinates) and setting color temperature.
  • Group: a light groupt that supports on/off control, dimming, setting color and color temperature.
  • Motion: A motion sensor.
  • Motion Camera: A camera motion sensor.
  • Entertainment: Lighting experience that synchronizes with entertainment systems.
  • Scene: a scene activation.

Both lights and groups are mapped to the DIMMER Standard Resource type, and allow full control of every state variable, such as brightness, hue or color coordinates and color temperature depending on the above categories.

Also, as a DIMMER, they provide the SET LEVEL command which acts on the brightness and on state variables. As a simple example, setting the level to 100 implies setting “on” to true and “bri” to 255 on the Philips Hue bridge. When using an “On Off Light” the SET LEVEL command only sets “on” to true on the Philips Hue Bridge if LEVEL is greater than 0 (or “off” on the contrary).

Sensors and Entertainment are mapped to the GPIO Standard Resource type. Sensors provide state updates regarding the lectures, and the Entertainment can be turned on or off.

The scene is mapped to a BUTTON Standard Resource type, and the button PRESS recalls the scene on the Philips Hue bridge.

Warning have in mind that when you set a color maybe Philips hue could not map that color for the lights, and set the nearest coordinates for that color. So in the state, you can see a difference between the color you set in HSV format and the HSV color shown on the resource state.

Changelog

  • v1.0 First version