jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 06:46:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow area, device, and entity selectors to optionally support multiple selections like target selector (#20961)

Browse Source
This commit is contained in:
Richard T. Schaefer 2022-03-24 10:32:32 -05:00 committed by GitHub
parent 94a1700927
commit 8ece472082
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
source/_docs/blueprint/selectors.markdown
View File

@ -63,8 +63,7 @@ addon:
## Area selector ## Area selector
The area selector shows an area finder that can pick a single area. The value The area selector shows an area finder that can pick a single or multiple areas based on the selector configuration. The value of the input will be the area ID, or a list of area IDs, based on if 'multiple' is set to true.
of the input will be the area ID of the user-selected area.
An area selector can filter the list of areas, based on properties of the devices An area selector can filter the list of areas, based on properties of the devices
and entities that are assigned to those areas. For example, the areas list could and entities that are assigned to those areas. For example, the areas list could
@ -131,6 +130,12 @@ entity:
device class, for example, `motion` or `window`. device class, for example, `motion` or `window`.
type: device_class type: device_class
required: false required: false
multiple:
description: >
Allows selecting multiple areas.
type: boolean
default: false
required: false
{% endconfiguration %} {% endconfiguration %}
### Example area selectors ### Example area selectors
@ -152,6 +157,7 @@ integration.
```yaml ```yaml
area: area:
device: device:
multiple: True
integration: deconz integration: deconz
manufacturer: IKEA of Sweden manufacturer: IKEA of Sweden
model: TRADFRI remote control model: TRADFRI remote control
@ -176,8 +182,7 @@ boolean:
## Device selector ## Device selector
The device selector shows a device finder that can pick a single device. The device selector shows a device finder that can pick a single or multiple devices based on the selector configuration. The value of the input will contain the device ID or a list of device IDs, based on if 'multiple' is set to true.
The value of the input will contain the device ID of the user-selected device.
A device selector can filter the list of devices, based on things like the A device selector can filter the list of devices, based on things like the
manufacturer or model of the device, the entities the device provides or based manufacturer or model of the device, the entities the device provides or based
@ -237,6 +242,12 @@ entity:
class, for example, `motion` or `window`. class, for example, `motion` or `window`.
type: device_class type: device_class
required: false required: false
multiple:
description: >
Allows selecting multiple devices.
type: boolean
default: false
required: false
{% endconfiguration %} {% endconfiguration %}
### Example device selector ### Example device selector
@ -261,8 +272,8 @@ device:
## Entity selector ## Entity selector
The entity selector shows an entity finder that can pick a single entity. The entity selector shows an entity finder that can pick a single entity or a list of entities based on the selector configuration.
The value of the input will contain the entity ID of user-selected entity. The value of the input will contain the entity ID, or list of entity IDs, based on if 'multiple' is set to true.
An entity selector can filter the list of entities, based on things like the An entity selector can filter the list of entities, based on things like the
class of the device, the domain of the entity or the domain that provided the class of the device, the domain of the entity or the domain that provided the
@ -298,6 +309,12 @@ device_class:
for example, `motion` or `window`. for example, `motion` or `window`.
type: device_class type: device_class
required: false required: false
multiple:
description: >
Allows selecting multiple entities.
type: boolean
default: false
required: false
{% endconfiguration %} {% endconfiguration %}
### Example entity selector ### Example entity selector
@ -312,6 +329,7 @@ And this is what it looks like in YAML:
```yaml ```yaml
entity: entity:
multiple: True
integration: zha integration: zha
domain: binary_sensor domain: binary_sensor
device_class: motion device_class: motion