7.1 KiB
| layout | title | description | date | sidebar | comments | sharing | footer | ha_category | ha_release | ha_iot_class | logo | ha_qa_scale |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| page | Template Light | Instructions on how to integrate Template Lights into Home Assistant. | 2016-05-18 20:32 | true | false | true | true | Light | 0.46 | Local Push | home-assistant.png | internal |
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:
{% raw %}
# 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 }}"
{% endraw %}
{% configuration %} lights: description: List of your lights. required: true type: map keys: friendly_name: description: Name to use in the frontend. required: false type: string entity_id: description: A list of entity IDs so the light only reacts to state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities. required: false type: [string, list] value_template: description: Defines a template to get the state of the light. required: false type: template default: optimistic level_template: description: Defines a template to get the brightness of the light. required: false type: template default: optimistic turn_on: description: Defines an action to run when the light is turned on. required: true type: action turn_off: description: Defines an action to run when the light is turned off. required: true type: action set_level: description: Defines an action to run when the light is given a brightness command. required: false type: action {% endconfiguration %}
{% linkable_title 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
{% raw %}{{ states.switch.source.state == 'on' }}{% endraw %}
with this equivalent that returns true/false and never gives an unknown
result:
{% raw %}{{ is_state('switch.source', 'on') }}{% endraw %}
{% linkable_title Examples %}
In this section you will find some real-life examples of how to use this light.
{% linkable_title 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.
{% raw %}
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 %}
{% endraw %}
{% linkable_title Change The Icon %}
This example shows how to change the icon based on the light state.
{% raw %}
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 %}
icon_template: >-
{% if is_state('media_player.receiver', 'on') %}
{% if states.media_player.receiver.attributes.is_volume_muted %}
mdi:lightbulb-off
{% else %}
mdi:lightbulb-on
{% endif %}
{% else %}
mdi:lightbulb-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
{% endraw %}
{% linkable_title Change The Entity Picture %}
This example shows how to change the entity picture based on the light state.
{% raw %}
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 %}
icon_template: >-
{% if is_state('media_player.receiver', 'on') %}
{% if states.media_player.receiver.attributes.is_volume_muted %}
/local/lightbulb-off.png
{% else %}
/local/lightbulb-on.png
{% endif %}
{% else %}
/local/lightbulb-off.png
{% 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
{% endraw %}