Document changed group behavior when members are unavailable or unknown (#23217)

This commit is contained in:
Erik Montnemery 2022-06-28 16:19:04 +02:00 committed by GitHub
parent 83e6331666
commit a72eaecd45
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -61,23 +61,26 @@ Binary sensor, light, and switch groups allow you set the "All entities" option.
### Cover groups
In short, when any group member entity is `open`, the group will also be `open`. A complete overview of how cover groups behave:
- The group state is `unknown` if all group members are `unknown` or `unavailable`.
- The group state is `unavailable` if all group members are `unavailable`.
- Otherwise, the group state is `unknown` if all group members are `unknown` or `unavailable`.
- Otherwise, the group state is `opening` if at least one group member is `opening`.
- Otherwise, the group state is `closing` if at least one group member is `closing`.
- Otherwise, the group state is `open` if at least one group member is `open`.
- Otherwise, the group state is `closed`.
### Fan groups
Fan groups don't support `unavailable` or `unknown` states.
In short, when any group member entity is `on`, the group will also be `on`. A complete overview of how fan groups behave:
- The group state is `on` if at least one group member is `on`.
- The group state is `unavailable` if all group members are `unavailable`.
- Otherwise, the group state is `unknown` if all group members are `unknown` or `unavailable`.
- Otherwise, The group state is `on` if at least one group member is `on`.
- Otherwise, the group state is `off`.
### Lock groups
In short, when any group member entity is `unlocked`, the group will also be `unlocked`. A complete overview of how fan groups behave:
- The group state is `unavailable` if all group members are `unavailable`.
- Otherwise, the group state is `unknown` if at least one group member is `unknown` or `unavailable`.
- Otherwise, the group state is `unknown` if all group members are `unknown` or `unavailable`.
- Otherwise, the group state is `jammed` if at least one group member is `jammed`.
- Otherwise, the group state is `locking` if at least one group member is `locking`.
- Otherwise, the group state is `unlocking` if at least one group member is `unlocking`.
@ -87,7 +90,7 @@ In short, when any group member entity is `unlocked`, the group will also be `un
### Media player groups
- The group state is `unavailable` if all group members are `unavailable`.
- Otherwise, the group state is `unknown` if all group members are `unknown`.
- Otherwise, the group state is `unknown` if all group members are `unknown` or `unavailable`.
- Otherwise, the group state is `buffering` if all group members are `buffering`.
- Otherwise, the group state is `idle` if all group members are `idle`.
- Otherwise, the group state is `paused` if all group members are `paused`.