Skip to content

Add documentation for entity and device filters #26145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 6 commits into from
Mar 9, 2023
+99 −71
Merged

Add documentation for entity and device filters #26145

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0427e5a
Add documentation for entity and device filters
piitaya Feb 6, 2023
8528577
Allow array of entity or device options
piitaya Feb 6, 2023
43e8cb4
Remove deprecated options
piitaya Feb 7, 2023
1ece4a1
Merge branch 'next' into entity_filter_selector
piitaya Mar 7, 2023
2afd707
Merge branch 'next' into entity_filter_selector
piitaya Mar 9, 2023
096246c
Convert to list
piitaya Mar 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 99 additions & 71 deletions source/_docs/blueprint/selectors.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,9 @@ area:
device:
description: >
When device options are provided, the list of areas is filtered by areas
that at least provide one device that matches the given conditions.
type: map
that at least provide one device that matches the given conditions. Can be
either a object or a list of object.
type: list
keys:
integration:
description: >
Expand All @@ -140,8 +141,9 @@ device:
entity:
description: >
When entity options are provided, the list of areas is filtered by areas
that at least provide one entity that matches the given conditions.
type: map
that at least provide one entity that matches the given conditions. Can be
either a object or a list of object.
type: list
required: false
keys:
integration:
Expand All @@ -162,8 +164,10 @@ entity:
device_class:
description: >
Limits the list of areas to areas that have entities with a certain
device class, for example, `motion` or `window`.
type: device_class
device class(es), for example, `motion` or `window`. Can be either a string
with a single device_class, or a list of string device_class to limit
the selection to.
type: [device_class, list]
required: false
multiple:
description: >
Expand Down Expand Up @@ -208,10 +212,9 @@ integration. Multiple areas can be selected.
area:
multiple: true
device:
multiple: true
integration: deconz
manufacturer: IKEA of Sweden
model: TRADFRI remote control
- integration: deconz
manufacturer: IKEA of Sweden
model: TRADFRI remote control
```

## Attribute selector
Expand Down Expand Up @@ -354,28 +357,12 @@ device:
```

{% configuration device %}
integration:
description: >
Can be set to an integration domain. Limits the list of devices to devices
provided by the set integration domain.
type: string
required: false
manufacturer:
description: >
When set, it limits the list of devices to devices provided by the set
manufacturer name.
type: string
required: false
model:
description: >
When set, it limits the list of devices to devices that have the set model.
type: string
required: false
entity:
description: >
When entity options are provided, the list of devices is filtered by devices
that at least provide one entity that matches the given conditions.
type: map
that at least provide one entity that matches the given conditions. Can be
either a object or a list of object.
type: list
required: false
keys:
integration:
Expand All @@ -397,8 +384,35 @@ entity:
device_class:
description: >
Limits the list of entities to entities that have a certain device
class, for example, `motion` or `window`.
type: device_class
class(es), for example, `motion` or `window`. Can be either a string
with a single device_class, or a list of string device_class to limit
the selection to.
type: [device_class, list]
required: false
filter:
description: >
When filter options are provided, the list of devices is filtered by devices
that at least provide one entity that matches the given conditions. Can be either
a object or a list of object.
type: list
required: false
keys:
integration:
description: >
Can be set to an integration domain. Limits the list of devices to devices
provided by the set integration domain.
type: string
required: false
manufacturer:
description: >
When set, it limits the list of devices to devices provided by the set
manufacturer name.
type: string
required: false
model:
description: >
When set, it limits the list of devices to devices that have the set model.
type: string
required: false
multiple:
description: >
Expand Down Expand Up @@ -433,12 +447,13 @@ And this is what is looks like in YAML:

```yaml
device:
integration: deconz
manufacturer: Philips
model: RWL021
filter:
- integration: deconz
manufacturer: Philips
model: RWL021
entity:
domain: sensor
device_class: battery
- domain: sensor
device_class: battery
```

## Duration selector
Expand Down Expand Up @@ -499,28 +514,37 @@ include_entities:
description: List of entity IDs to limit the selectable list to.
type: list
required: false
integration:
description: >
Can be set to an integration domain. Limits the list of entities to entities
provided by the set integration domain, for example,
[`zha`](/integrations/zha).
type: string
required: false
domain:
description: >
Limits the list of entities to entities of a certain domain(s), for example,
[`light`](/integrations/light) or
[`binary_sensor`](/integrations/binary_sensor). Can be either a string
with a single domain, or a list of string domains to limit the selection
to.
type: [string, list]
required: false
device_class:
filter:
description: >
Limits the list of entities to entities that have a certain device class,
for example, `motion` or `window`.
type: device_class
When filter options are provided, the entities are limited by entities
that at least match the given conditions. Can be either a object or a list of object.
Can be either a object or a list of object.
type: list
required: false
keys:
integration:
description: >
Can be set to an integration domain. Limits the list of entities to entities
provided by the set integration domain, for example,
[`zha`](/integrations/zha).
type: string
required: false
domain:
description: >
Limits the list of entities to entities of a certain domain(s), for example,
[`light`](/integrations/light) or
[`binary_sensor`](/integrations/binary_sensor). Can be either a string
with a single domain, or a list of string domains to limit the selection
to.
type: [string, list]
required: false
device_class:
description: >
Limits the list of entities to entities that have a certain device class(es),
for example, `motion` or `window`. Can be either a string with a single device_class,
or a list of string device_class to limit the selection to.
type: [device_class, list]
required: false
multiple:
description: >
Allows selecting multiple entities. If set to `true`, the resulting value of
Expand Down Expand Up @@ -556,9 +580,10 @@ And this is what it looks like in YAML:
```yaml
entity:
multiple: true
integration: zha
domain: binary_sensor
device_class: motion
filter:
- integration: zha
domain: binary_sensor
device_class: motion
```

## Icon selector
Expand Down Expand Up @@ -895,8 +920,9 @@ target:
device:
description: >
When device options are provided, the targets are limited by devices
that at least match the given conditions.
type: map
that at least match the given conditions. Can be either a object or a list
of object.
type: list
keys:
integration:
description: >
Expand All @@ -918,8 +944,9 @@ device:
entity:
description: >
When entity options are provided, the targets are limited by entities
that at least match the given conditions.
type: map
that at least match the given conditions. Can be either a object or a list
of object.
type: list
required: false
keys:
integration:
Expand All @@ -940,9 +967,10 @@ entity:
required: false
device_class:
description: >
Limits the targets to entities with a certain
device class, for example, `motion` or `window`.
type: device_class
Limits the targets to entities with a certain device class(es), for example,
`motion` or `window`. Can be either a string with a single device_class,
or a list of string device_class to limit the selection to.
type: [device_class, list]
required: false
{% endconfiguration %}

Expand All @@ -967,8 +995,8 @@ or more lights, provided by the [ZHA](/integrations/zha) integration.
```yaml
target:
entity:
integration: zha
domain: light
- integration: zha
domain: light
```

Another example using the target selector, which only shows targets that
Expand All @@ -978,9 +1006,9 @@ provide one or more remote controls, provided by the
```yaml
target:
device:
integration: deconz
manufacturer: IKEA of Sweden
model: TRADFRI remote control
- integration: deconz
manufacturer: IKEA of Sweden
model: TRADFRI remote control
```

## Template selector
Expand Down