Template Light
The template
platform creates lights that combine components and provides the
ability to run scripts or invoke services for each of the on, off, and
brightness commands of a light.
To enable Template Lights in your installation, add the following to your
configuration.yaml
file:
# Example configuration.yaml entry
light:
- platform: template
lights:
theater_lights:
friendly_name: "Theater Lights"
level_template: "{{ sensor.theater_brightness.attributes.lux|int }}"
value_template: "{{ sensor.theater_brightness.attributes.lux|int > 0 }}"
turn_on:
service: script.theater_lights_on
turn_off:
service: script.theater_lights_off
set_level:
service: script.theater_lights_level
data_template:
brightness: "{{ brightness }}"
Configuration Variables
- switches
-
(map)(Required)List of your lights.
-
- friendly_name
-
(string)(Optional)Name to use in the frontend.
- entity_id
-
(string | list)(Optional)Add a list of entity IDs so the switch only reacts to state changes of these entities. This will reduce the number of times the light will try to update its state.
- value_template
-
(template)(Optional)Defines a template to get the state of the light.
Default value: optimistic
- level_template
-
(template)(Optional)Defines a template to get the brightness of the light.
Default value: optimistic
- turn_on
-
(action)(Required)Defines an action to run when the light is turned on.
- turn_off
-
(action)(Required)Defines an action to run when the light is turned off.
- set_level
-
(action)(Optional)Defines an action to run when the light is given a brightness command.
Considerations
If you are using the state of a platform that takes extra time to load, the
Template Light may get an unknown
state during startup. This results
in error messages in your log file until that platform has completed loading.
If you use is_state()
function in your template, you can avoid this situation.
For example, you would replace
{{ states.switch.source.state == 'on' }}
with this equivalent that returns true
/false
and never gives an unknown
result:
{{ is_state('switch.source', 'on') }}
Examples
In this section you will find some real life examples of how to use this light.
Theater Volume Control
This example shows a light that is actually a home theater’s volume. This
component gives you the flexibility to provide whatever you’d like to send as
the payload to the consumer including any scale conversions you may need to
make; the Media Player component needs a floating
point percentage value from 0.0
to 1.0
.
light:
- platform: template
lights:
theater_volume:
friendly_name: "Receiver Volume"
value_template: >-
{% if is_state('media_player.receiver', 'on') %}
{% if states.media_player.receiver.attributes.is_volume_muted %}
off
{% else %}
on
{% endif %}
{% else %}
off
{% endif %}
turn_on:
service: media_player.volume_mute
data:
entity_id: media_player.receiver
is_volume_muted: false
turn_off:
service: media_player.volume_mute
data:
entity_id: media_player.receiver
is_volume_muted: true
set_level:
service: media_player.volume_set
data_template:
entity_id: media_player.receiver
volume_level: "{{ (brightness / 255 * 100)|int / 100 }}"
level_template: >-
{% if is_state('media_player.receiver', 'on') %}
{{ (states.media_player.receiver.attributes.volume_level|float * 255)|int }}
{% else %}
0
{% endif %}