Configuration Variables

Set this to true if the group state should only turn on if all grouped entities are on.

Default value:

false

icon

(string)(Optional)

The icon that shows in the front end. The rest of this only applies to the deprecated UI /states. If the group is a view, this icon will show at the top in the frontend instead of the name. If the group is a view and both name and icon have been specified, the icon will appear at the top of the frontend and the name will be displayed as the mouse-over text.

view

(boolean)(Optional)

Only applies to the deprecated UI /states. If yes then the entry will be shown as a view (tab) at the top. Groups that are set to view: true cannot be used as entities in other views. Does not apply to Lovelace.

Default value:

false

control

(string)(Optional)

Only applies to the deprecated UI /states. Set value to hidden. If hidden then the group switch will be hidden. Does not apply to Lovelace.

Default groups

Some integrations automatically create special groups containing integration entities. These groups are named like group.all_..., for example:

group.all_switches

group.all_lights

group.all_devices

group.all_scripts

group.all_automations

You can see list of these groups in State page of the Developer Tools.

Group behavior

By default when any member of a group is on then the group will also be on. Similarly with a device tracker, when any member of the group is home then the group is home. If you set the all option to true though, this behavior is inverted and all members of the group have to be on for the group to turn on as well.

Old user interface

This section only applies if you’ve not moved off the deprecated /states user interface.

A group can be promoted to a view by setting view: true under the group definition. This will make the group available as a new tab in the frontend.

By default, every group appears in the HOME tab. If you create a group default_view it will REPLACE the contents of the HOME tab so you can customize the HOME tab as you wish.

If all entities in a group are switches or lights then Home Assistant adds a switch at the top of the card that turns them all on/off at once. If you want to hide this switch, set control to hidden.

You can create views (tabs) that contain other groups (but not other groups which are marked as view: true).
Notice in the example below that in order to refer to the group “Living Room”, you use group.living_room (lowercase and spaces replaced with underscores).