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-16 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document area_entities/area_devices template functions/filters (#19080)

Browse Source
This commit is contained in:
Raman Gupta 2021-10-22 13:59:12 -04:00 committed by GitHub
parent ecf9abc851
commit c2e5189927
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
source/_docs/configuration/templating.markdown
View File

@ -237,33 +237,43 @@ The same thing can also be expressed as a filter:
- `area_id(lookup_value)` returns the area ID for a given device ID, entity ID, or area name. Can also be used as a filter.
- `area_name(lookup_value)` returns the area name for a given device ID, entity ID, or area ID. Can also be used as a filter.
- `area_entities(area_name_or_id)` returns the list of entity IDs tied to a given area ID or name. Can also be used as a filter.
- `area_devices(area_name_or_id)` returns the list of device IDs tied to a given area ID or name. Can also be used as a filter.
#### Areas examples
{% raw %}
```text
{{ area_id('Living Room') }} # deadbeefdeadbeefdeadbeefdeadbeef
{{ area_id('Living Room') }} # 'deadbeefdeadbeefdeadbeefdeadbeef'
```
```text
{{ area_id('my_device_id') }} # deadbeefdeadbeefdeadbeefdeadbeef
{{ area_id('my_device_id') }} # 'deadbeefdeadbeefdeadbeefdeadbeef'
```
```text
{{ area_id('sensor.sony') }} # deadbeefdeadbeefdeadbeefdeadbeef
{{ area_id('sensor.sony') }} # 'deadbeefdeadbeefdeadbeefdeadbeef'
```
```text
{{ area_name('deadbeefdeadbeefdeadbeefdeadbeef') }} # Living Room
{{ area_name('deadbeefdeadbeefdeadbeefdeadbeef') }} # 'Living Room'
```
```text
{{ area_name('my_device_id') }} # Living Room
{{ area_name('my_device_id') }} # 'Living Room'
```
```text
{{ area_name('sensor.sony') }} # Living Room
{{ area_name('sensor.sony') }} # 'Living Room'
```
```text
{{ area_entities('deadbeefdeadbeefdeadbeefdeadbeef') }} # ['sensor.sony']
```
```text
{{ area_devices('Living Room') }} # ['my_device_id']
```
{% endraw %}