Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 147a5ad

Browse files
authored
Update binary sensor group documentation (#22110)
1 parent 9ea0135 commit 147a5ad

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

source/_integrations/binary_sensor.group.markdown

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,12 @@ ha_domain: group
1111

1212
The group binary_sensor platform lets you combine multiple binary_sensors into one entity. This integration presents itself as a single binary sensor in the UI. This allows the UI to use the text and icon of the type of sensor you are grouping. The sensor doesn't know what device class it should be, so this should be set to match the device class of the items in the group.
1313

14-
## Group behavior
15-
16-
By default when any member of a group is `on` then the group will also be `on`. 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.
14+
## Configuration
1715

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

2018
```yaml
19+
# Example configuration.yaml entry
2120
binary_sensor:
2221
- platform: group
2322
name: Patio Doors
@@ -50,3 +49,18 @@ device_class:
5049
required: false
5150
type: string
5251
{% endconfiguration %}
52+
53+
## Group behavior
54+
55+
Group behavior differs depending on if the `all` option is `false` (the default) or `true`.
56+
If `all` is `false`(the default):
57+
- Group state is `unavailable` if all group members are `unavailable`
58+
- Otherwise, group state is `unknown` if all group members are `unknown`
59+
- Otherwise, group state is `on` if at least one group member is `on`
60+
- Otherwise, group state is `off`
61+
62+
If `all` is `true`(the default):
63+
- Group state is `unavailable` if all group members are `unavailable`
64+
- Otherwise, group state is `unknown` if at least one group member is `unknown` or `unavailable`
65+
- Otherwise, group state is `off` if at least one group member is `off`
66+
- Otherwise, group state is `on`

0 commit comments

Comments
 (0)