Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
98 commits
Select commit Hold shift + click to select a range
b9bfd1a
Allow override browse media in universal media player (#25697)
Drafteed Feb 23, 2023
ce8aea0
Add ISY994 services to set and delete lock codes (#26363)
shbatm Feb 26, 2023
5ec6fd6
Clarify the example is below the sentence (#26349)
frenck Feb 27, 2023
2ece741
Update Insteon documentation (#26399)
teharris1 Mar 1, 2023
3a9d92d
Merge branch 'current' into next
frenck Mar 1, 2023
745bebf
Add a section on enabled jinja extensions (#26397)
depoll Mar 1, 2023
6fb4715
Add Heltun integration (#26411)
b-uwe Mar 1, 2023
798353e
Add climate devices documentation for LIVISI integration (#25957)
StefanIacobLivisi Mar 3, 2023
25d531b
Add Camera to Prosegur (#25419)
dgomes Mar 3, 2023
177dc77
Adding Obihai codeowner (#26386)
Mar 3, 2023
dcc1bf4
HELTUN partnership announcement blog post (#26415)
b-uwe Mar 3, 2023
b837383
Update renault documentation - Add button section (#26260)
rodriguestiago0 Mar 4, 2023
cb47e61
Document energy_storage and volume_storage device classes (#26394)
emontnemery Mar 4, 2023
4fda11e
Add Config Flow to Obihai (#26354)
Mar 4, 2023
138028b
Add reolink button entities (#26355)
starkillerOG Mar 5, 2023
c2a25c2
device_class and state_class (#25742)
gjohansson-ST Mar 5, 2023
691a88e
Reolink add switch entities (#26353)
starkillerOG Mar 5, 2023
320c756
Add Reolink siren documentation (#26282)
starkillerOG Mar 5, 2023
70e2303
Add Reolink select entities (#26341)
starkillerOG Mar 5, 2023
9d17d76
Add new Reolink number entities (#26283)
starkillerOG Mar 6, 2023
85768af
Add reolink light entities (#26338)
starkillerOG Mar 6, 2023
b098d8e
Add Obihai Reboot button (#26385)
Mar 6, 2023
69c01f5
Add clarification for reolink entities (#26469)
starkillerOG Mar 6, 2023
e762d0e
Add Door cover documentation (#26331)
Dexwell Mar 7, 2023
68612ee
Add PSSO and ISS(2) to Livisi supported devices (#26474)
planbnet Mar 7, 2023
ddc3cb6
Add non-color bulb to tested devices (#26494)
parliament119 Mar 8, 2023
10253cf
Add documentation for entity and device filters (#26145)
piitaya Mar 9, 2023
e3de486
Add documentation for core and SU stats sensors (#26518)
ludeeus Mar 9, 2023
3bc5a2b
Update xiaomi_miio.markdown (#26489)
kirill578 Mar 9, 2023
9026d0a
List all areas with templating (#26303)
rokam Mar 9, 2023
93f3e1e
Documentation for Jinja import (#26436)
depoll Mar 13, 2023
8f39f4e
Add docs for ESERA 1-Wire (virtual) integration (#26535)
jrieger Mar 13, 2023
1556f0d
Merge branch 'current' into next
frenck Mar 13, 2023
0d0b794
Update frontier_silicon documentation (#21238)
wlcrs Mar 13, 2023
0a45ef9
Add documentation for Supervisor host sensors (#26521)
ludeeus Mar 13, 2023
6d32c93
Add is_hidden_entity documentation (#26429)
depoll Mar 13, 2023
11a8e77
Change SQL integration to use HA recorder db as default (#25643)
gjohansson-ST Mar 14, 2023
b4a6b2d
Document tplink_omada update entities (#26565)
MarkGodwin Mar 14, 2023
691c673
Update SQL query examples for schema 40 (#26591)
bdraco Mar 14, 2023
ab7d5f3
Clarify that calendar event end times are exclusive (#26558)
allenporter Mar 15, 2023
50b5c88
Add turn_on trigger to Samsung TV (#26611)
epenet Mar 15, 2023
a0d9b4f
Add modbus write_registers keys (#26595)
janiversen Mar 15, 2023
b562a1a
Add keep_days option to recorder.purge_entities (#26610)
bdraco Mar 15, 2023
f8628a7
Update pushsafer.markdown (#26563)
appzer Mar 16, 2023
bf733db
Add Reolink doorbell quick reply entities (#26588)
starkillerOG Mar 17, 2023
5c9012a
Add docs for voice_assistant integration (#26635)
synesthesiam Mar 17, 2023
4f3304a
Document changed light white service call attribute (#26630)
emontnemery Mar 17, 2023
ae00a8d
Add lock to matter ha_platforms (#26674)
ArturoGuerra Mar 21, 2023
f5016ae
Add YoLink FlexFob support (#25442)
matrixd2 Mar 22, 2023
e4b9129
Delete magicseaweed.markdown (#26722)
gjohansson-ST Mar 26, 2023
ed1451a
Add Magicseaweed redirect 301 (#26726)
gjohansson-ST Mar 26, 2023
5b4a78c
Add location field to create_event service (#26728)
luca-angemi Mar 26, 2023
a7515b4
Sun attributes to sensors (#24704)
gjohansson-ST Mar 26, 2023
5237cd6
Merge branch 'current' into next
frenck Mar 26, 2023
7d0e561
Verisure (#26486)
niro1987 Mar 26, 2023
5f367a9
Add location field to create_event service (#26731)
luca-angemi Mar 26, 2023
43b40a4
Add warning about a window size larger than one with many states (#26…
bdraco Mar 26, 2023
3083d7f
Add WLED IP sensor (#26712)
a-baturin Mar 26, 2023
f28a1c1
Implement config flow for nextcloud (#26503)
mib1185 Mar 26, 2023
68b98e7
Add device HmIP-DLD (#25160)
hahn-th Mar 27, 2023
6a6d771
Add calendar entity to Ridwell documentation (#25812)
bachya Mar 27, 2023
b2b37b4
Add reolink tracking entities (#26680)
starkillerOG Mar 27, 2023
20f2b74
Vermont Castings virtual integration documentation (#26505)
jeeftor Mar 27, 2023
cde1446
Add Window Door Sensor documentation for LIVISI integration (#25093)
StefanIacobLivisi Mar 27, 2023
ff471a4
Quadrafire virtual integration documentation (#26507)
jeeftor Mar 27, 2023
c7ddcb8
Add documentation for Livisi PSSO, ISS and ISS2 switch devices (#26470)
StefanIacobLivisi Mar 27, 2023
d7e5357
Merge branch 'current' into next
frenck Mar 27, 2023
6bbabe8
Add profiler.lru_stats service (#26752)
bdraco Mar 28, 2023
1b3cf0e
Add product to Group Sensor (#26649)
gjohansson-ST Mar 28, 2023
9cb1c2d
Add docs for Nuki callbacks (#26289)
pree Mar 28, 2023
4ceea0a
Add character_encoding doc to REST and Scrape (#26730)
olivierouellet Mar 28, 2023
38d614c
Clarify Notify Group payload behaviour (#26715)
arychj Mar 28, 2023
c9e1291
Update litterrobot documentation for panel brightness feature (#25857)
natekspencer Mar 28, 2023
3e5c5da
Add select platform to velbus (#26148)
cereal2nd Mar 28, 2023
a47f689
New function/test/filter has_value for templating (#24360)
ehendrix23 Mar 28, 2023
f034cd8
docs: update blebox shutterBox tilt support (#25660)
riokuu Mar 28, 2023
9ffa429
Add periodically resetting utility meter config option (#26306)
Wesley-Vos Mar 28, 2023
bff3186
Add imap imap_content event (#26748)
jbouwh Mar 28, 2023
4db6c92
Add date header to imap custom event data (#26769)
jbouwh Mar 28, 2023
b52db23
Merge branch 'current' into next
frenck Mar 29, 2023
5057fb1
Remove frontier_silicon from discovery integration (#26753)
wlcrs Mar 29, 2023
d13cfc4
Remove deprecated mysensors notify (#26785)
MartinHjelmare Mar 29, 2023
653aa97
Merge branch 'current' into next
frenck Mar 29, 2023
3b11aed
Add config flow to Snapcast (#24562)
luar123 Mar 30, 2023
12f9c38
Remove siren firmware issue (#26808)
starkillerOG Mar 31, 2023
9da22bd
Add HomeSeer integration (#26757)
b-uwe Mar 31, 2023
f3e4523
Remove xbox_live integration (#26817)
MartinHjelmare Mar 31, 2023
f92d56b
Rename Android TV to Android Debug Bridge (#26832)
tronikos Apr 2, 2023
acf7767
Document new profiler object logging with source (#26842)
bdraco Apr 3, 2023
83d07f9
Add config flow to qbittorrent (#25028)
chrisx8 Apr 3, 2023
a5b9d2d
Add example of sorting states by entity_id (#26822)
bdraco Apr 3, 2023
5c5bc51
Remove Darksky (#26740)
gjohansson-ST Apr 3, 2023
f3b4d1a
Document the constant selector (#26844)
emontnemery Apr 3, 2023
1f7756b
Updating Supla docs with garage door channel type support (#26820)
alh84001 Apr 3, 2023
98afb95
Remove deprecated imap_content_sensor integration documentation (#26792)
jbouwh Apr 3, 2023
092a395
Add attachment documentation for Simplepush (#26813)
tymm Apr 3, 2023
eae4e02
Add sort list service to Shopping List (#26839)
mib1185 Apr 3, 2023
7fc95ed
add matter cover, update some outdated information.
hidaris Apr 4, 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
1 change: 0 additions & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,6 @@ source/_integrations/workday.markdown @fabaff
source/_integrations/worldclock.markdown @fabaff
source/_integrations/ws66i.markdown @ssaenger
source/_integrations/xbox.markdown @hunterjm
source/_integrations/xbox_live.markdown @MartinHjelmare
source/_integrations/xiaomi_aqara.markdown @danielhiversen @syssi
source/_integrations/xiaomi_ble.markdown @Jc2k @Ernst79
source/_integrations/xiaomi_miio.markdown @rytilahti @syssi @starkillerOG
Expand Down
196 changes: 121 additions & 75 deletions source/_docs/blueprint/selectors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The following selectors are currently available:
- [Boolean selector](#boolean-selector)
- [Color temperature selector](#color-temperature-selector)
- [Config entry selector](#config-entry-selector)
- [Constant selector](#constant-selector)
- [Date selector](#date-selector)
- [Date & time selector](#date--time-selector)
- [Device selector](#device-selector)
Expand Down Expand Up @@ -115,8 +116,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 +142,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 +165,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 +213,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 All @@ -238,12 +242,11 @@ For example: `next_dawn`.
## Boolean selector

The boolean selector shows a toggle that allows the user to turn on or off
the selected option. The input's value will contain the boolean value of that
toggle as a boolean value, being `true` or `false`.
the selected option.

![Screenshot of a boolean selector](/images/blueprints/selector-boolean.png)

The boolean selector can be incredibly useful for adding feature switches
The boolean selector is suitable for adding feature switches
to, for example, blueprints.

This selector does not have any other options; therefore, it only has its key.
Expand All @@ -252,7 +255,7 @@ This selector does not have any other options; therefore, it only has its key.
boolean:
```

The output of this selector is `true` when the toggle was on, `false` otherwise.
The output of this selector is `true` when the toggle is on, `false` otherwise.

## Color temperature selector

Expand Down Expand Up @@ -302,6 +305,24 @@ integration:

The output of this selector is the entry ID of the config entry, for example, `6b68b250388cbe0d620c92dd3acc93ec`.

## Constant selector

The constant selector shows a toggle that allows the user to enable the selected option.
This is similar to the [boolean selector](#boolean-selector), the difference
is that the constant selector has no value when it's not enabled.

![Screenshot of a constant selector](/images/blueprints/selector-constant.png)

The selector's value must be configured, and optionally, a label.

```yaml
boolean:
value: true
label: Enabled
```

The output of this selector is the configured value when the toggle is on, it has not output otherwise.

## Date selector

The date selector shows a date input that allows the user to specify a date.
Expand Down Expand Up @@ -354,28 +375,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 +402,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 +465,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 +532,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 +598,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 +938,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 +962,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 +985,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 +1013,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 +1024,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
Loading