From 8aace6e2e004dae420cd9815fd7d6a4cb6d358d2 Mon Sep 17 00:00:00 2001 From: Raman Gupta <7243222+raman325@users.noreply.github.com> Date: Wed, 25 Aug 2021 15:38:58 -0400 Subject: [PATCH] Document new area_id and area_name template functions (#18835) --- .../_docs/configuration/templating.markdown | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index d19bd022e79..a1a55acb75c 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -232,6 +232,41 @@ The same thing can also be expressed as a filter: {% endraw %} +### Areas + +- `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. + +#### Areas examples + +{% raw %} + +```text +{{ area_id('Living Room') }} # deadbeefdeadbeefdeadbeefdeadbeef +``` + +```text +{{ area_id('my_device_id') }} # deadbeefdeadbeefdeadbeefdeadbeef +``` + +```text +{{ area_id('sensor.sony') }} # deadbeefdeadbeefdeadbeefdeadbeef +``` + +```text +{{ area_name('deadbeefdeadbeefdeadbeefdeadbeef') }} # Living Room +``` + +```text +{{ area_name('my_device_id') }} # Living Room +``` + +```text +{{ area_name('sensor.sony') }} # Living Room +``` + +{% endraw %} + ### Time `now()` and `utcnow()` are not supported in [limited templates](#limited-templates).