Add group attributes to documentation (#34325)

This commit is contained in:
Rick Auch 2024-09-23 06:41:46 -05:00 committed by GitHub
parent d08be78ad5
commit 22a7fa9e91
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -155,6 +155,14 @@ To add or remove entities from an existing group, click on `Group options`, all
![Group members](/images/integrations/group/Group_members.png) ![Group members](/images/integrations/group/Group_members.png)
### Group attributes
These are the attributes available for a group.
| Attribute | Data |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | List of all the `entity_id`'s in the group. |
## YAML configuration ## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML Alternatively, this integration can be configured and set up manually via YAML
@ -462,6 +470,16 @@ It is possible to create a group that the system cannot calculate a group state.
These groups can still be in templates with the `expand()` directive, called using the `homeassistant.turn_on` and `homeassistant.turn_off` actions, etc. These groups can still be in templates with the `expand()` directive, called using the `homeassistant.turn_on` and `homeassistant.turn_off` actions, etc.
### Attributes
These are the attributes available for an old-style group.
| Attribute | Data |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `entity_id` | List of all the `entity_id`'s in the group. |
| `order` | Integer representing the order in which the entity was created, starting with `0`. |
| `auto` | Boolean that will always be set to `true`. Only appears in groups that were created with the `set` action. |
### Actions ### Actions
This integration provides the following actions to modify groups and a action to reload the configuration without restarting Home Assistant itself. This integration provides the following actions to modify groups and a action to reload the configuration without restarting Home Assistant itself.