Skip to content

Add documentation for supported features selector #26882

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 2 commits into from
Apr 5, 2023
Merged

Add documentation for supported features selector #26882

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
168946b
Add docs for supported_features in selectors
bramkragten Apr 5, 2023
32ddc0e
Fix CI
frenck Apr 5, 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
20 changes: 19 additions & 1 deletion source/_docs/blueprint/selectors.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,12 @@ entity:
the selection to.
type: [device_class, list]
required: false
supported_features:
description: >
Limits the list of areas to areas that have entities with a certain
supported feature, for example, `light.LightEntityFeature.TRANSITION` or `climate.ClimateEntityFeature.TARGET_TEMPERATURE`. Should be a list of features.
type: list
required: false
multiple:
description: >
Allows selecting multiple areas. If set to `true`, the resulting value of
Expand Down Expand Up @@ -401,12 +407,18 @@ entity:
required: false
device_class:
description: >
Limits the list of entities to entities that have a certain device
Limits the list of devices to devices that have 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
supported_features:
description: >
Limits the list of devices to devices that have entities with a certain
supported feature, for example, `light.LightEntityFeature.TRANSITION` or `climate.ClimateEntityFeature.TARGET_TEMPERATURE`. Should be a list of features.
type: list
required: false
filter:
description: >
When filter options are provided, the list of devices is filtered by devices
Expand Down Expand Up @@ -563,6 +575,12 @@ filter:
or a list of string device_class to limit the selection to.
type: [device_class, list]
required: false
supported_features:
description: >
Limits the list of entities to entities that have a certain
supported feature, for example, `light.LightEntityFeature.TRANSITION` or `climate.ClimateEntityFeature.TARGET_TEMPERATURE`. Should be a list of features.
type: list
required: false
multiple:
description: >
Allows selecting multiple entities. If set to `true`, the resulting value of
Expand Down