home-assistant.io/source/_integrations/hue.markdown

title, description, ha_category, ha_iot_class, featured, ha_release, ha_config_flow, ha_quality_scale, ha_codeowners, ha_domain, ha_ssdp, ha_homekit, ha_platforms, ha_zeroconf

title	description	ha_category	ha_iot_class	featured	ha_release	ha_config_flow	ha_quality_scale	ha_codeowners	ha_domain	ha_ssdp	ha_homekit	ha_platforms	ha_zeroconf
Philips Hue	Instructions on setting up Philips Hue within Home Assistant.	Hub Light	Local Push	true	0.60	true	platinum	@balloob @frenck	hue	true	true	binary_sensor light sensor	true

The Philips Hue integration allows you to control and monitor the lights and motion sensors connected to your Hue bridge.

There is currently support for the following device types within Home Assistant:

• Lights
• Motion sensors (including temperature and light level sensors)
• Hue switches (as device triggers for automations and also exposed as battery sensors when they are battery-powered)
  • Hue Dimmer Switch
  • Hue Tap Switch
  • Hue Smart Button
  • Hue Wall Switch Module
  • Friends of Hue Switch

{% include integrations/config_flow.md %}

Options

Options for the Hue integration can be set going to Configuration -> Integrations -> Hue -> Options.

{% configuration_basic %} Allow Hue groups: description: "Enabling this option, will create entities for each Hue group, so you can control your Hue light groups from Home Assistant." Allow unreachable bulbs to report their state correctly: description: "If a light is unavailable, it will show up as unavailable in Home Assistant as well. Enabling this option, will not mark the light unavailable, but instead show the last state known to the Hue bridge." {% endconfiguration_basic %}

Using Hue Scenes

The Hue platform has its own concept of scenes for setting the colors of a group of lights simultaneously. A Hue bridge could potentially have dozens of scenes stored on it, and many scenes across different rooms might share the same name (the default scenes, for example). To avoid user interface overload, we don't expose scenes directly. Instead there is a hue.hue_activate_scene service which can be used in an automation or script. This will have all the bulbs transitioned at once, instead of one at a time like when using standard scenes in Home Assistant.

For instance:

service: hue.hue_activate_scene
data:
  group_name: "Porch"
  scene_name: "Porch Orange"

Service data attribute	Optional	Description
group_name	no	The group/room name of the lights. Find this in the official Hue app.
scene_name	no	The name of the scene. Find this in the official Hue app.
transition	yes	The time in 100s of milliseconds to transition to the scene. For example, a value of 4 means 400 milliseconds.

Note: group_name is not a reference to a Home Assistant group name. It can only be the name of a group/room in the Hue app.

Finding Group and Scene Names

The easiest way to find Hue scene names is to only use the scenes from the 2nd generation Hue app, which are organized by room (group) and scene name. Use the room name and scene name that you see in the app. You can test that these work at Developer Tools > Services in your Home Assistant instance.

Alternatively, a more advanced method can be used to dump all rooms and scene names using this gist. This does not tell you which groups and scenes work together, but it is sufficient to get values that you can test at Developer Tools > Services.

Caveats

The Hue API doesn't activate scenes directly; rather, they must be associated with a Hue group (typically rooms). But Hue scenes don't actually reference their group, so heuristic matching is used.

Neither group names nor scene names are guaranteed unique in Hue. If you are observing unexpected behavior from calling Hue scenes in Home Assistant, make the names of your Hue scenes more specific in the Hue app.

The Hue hub has limited space for scenes and will delete scenes if new ones get created that would overflow that space. The API documentation says this is based on the scenes that are "least recently used."