home-assistant.io/source/_components/light.group.markdown

layout	title	description	date	sidebar	comments	sharing	footer	ha_category	ha_release	ha_iot_class	logo	ha_qa_scale
page	Light Group	Instructions for how to setup light groups within Home Assistant.	2018-02-23 11:41	true	false	true	true	Light	0.65	Local Push	home-assistant.png	internal

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.

{% linkable_title 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