home-assistant.io/source/_integrations/light.group.markdown
Franck Nijhof 272086948a
Collection of domain & logo cleanups (#12299)
* Collection of domain & logo cleanups

* Fix build
2020-03-06 23:02:31 +01:00

1.6 KiB

title description ha_category ha_release ha_iot_class ha_quality_scale ha_domain
Light Group Instructions for how to setup light groups within Home Assistant.
Light
0.65 Local Push internal group

The group light platform lets you combine multiple lights into one entity. All child lights of a light group can still be used as usual, but controlling the state of the grouped light will forward the command to each child light.

To enable this platform in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
light:
  - platform: group
    name: Kitchen Lights
    entities:
      - light.kitchen_ceiling_lights
      - light.kitchen_under_cabinet_lights
      - light.kitchen_spot_lights
      - light.pendant_lights

{% configuration %} name: description: The name of the light group. Defaults to "Light Group". required: false type: string entities: description: A list of entities to be included in the light group. required: true type: [string, list] {% endconfiguration %}

Example of the light group "Kitchen Lights".

The supported features of all lights will be added together. For example, if you have one RGB light in a group of otherwise brightness-only lights, the light group will be shown with a color picker.

Script Example

Here's an example of a script using the above light group.

script:
  turn_on_kitchen_lights:
    alias: Kitchen lights on
    sequence:
      service: light.turn_on
      data:
        entity_id: light.kitchen_lights
        brightness: 100