---
layout: page
title: "Templating"
description: "Instructions how to use the templating feature of Home Assistant."
date: 2015-12-12 12:00
sidebar: false
comments: false
sharing: true
footer: true
---

This is an advanced feature of Home Assistant. You'll need a basic understanding of the following things:

  - [Home Assistant architecture], especially states.
  - [State object]


[Home Assistant architecture]: /developers/architecture/
[State object]: /topics/state_object/

Templating is a powerful feature in Home Assistant that allows the user control over information that is going into and out of the system. It is used for:

 - Formatting outgoing messages in, for example, the [notify] and [alexa] components.
 - Process incoming data from sources that provide raw data, like [MQTT], [Rest sensor] or the [command line sensor].

[notify]: /components/notify/
[alexa]: /components/alexa/
[MQTT]: /components/mqtt/
[Rest sensor]: /components/sensor.rest/
[command line sensor]: /components/sensor.command_line/

## {% linkable_title Building templates %}

Templating in Home Assistant is powered by the Jinja2 templating engine. This means that we are using their syntax and make some custom Home Assistant variables available to templates during rendering. We will not go over the basics of the syntax, as Jinja2 does a lot better job at this in their [Jinja2 documentation].

[Jinja2 documentation]: http://jinja.pocoo.org/docs/dev/templates/

<p class='note'>
The frontend has a template editor developer tool to help develop and debug templates.
</p>

Templates can get big pretty fast. To keep a clear overview, consider using YAML multiline strings to define your templates:

```yaml
script:
  msg_who_is_home:
    sequence:
      - service: notify.notify
        data:
          message: >
            {% raw %}{% if is_state('device_tracker.paulus', 'home') %}
              Ha, Paulus is home!
            {% else %}
              Paulus is at {{ states('device_tracker.paulus')) }}.
            {% endif %}{% endraw %}
```

## {% linkable_title Home Assistant template extensions %}

Home Assistant adds extensions to allow templates to access all of the current states:

 - Iterating `states` will yield each state sorted alphabetically by entity ID.
 - Iterating `states.domain` will yield each state of that domain sorted alphabetically by entity ID.
 - `states.sensor.temperature` returns the state object for `sensor.temperature`.
 - `states('device_tracker.paulus')` will return the state string (not the object) of the given entity or `unknown` if it doesn't exist.
 - `is_state('device_tracker.paulus', 'home')` will test if the given entity is specified state.
 - `is_state_attr('device_tracker.paulus', 'battery', 40)` will test if the given entity is specified state.
 - Filter `multiply(x)` will convert the input to a number and multiply it with `x`.
 - Filter `round(x)` will convert the input to a number and round it to `x` decimals.
 - `now` will be rendered as current time in your time zone.
 - `utcnow` will be rendered as UTC time.
 - `distance()` will measure the distance in meters between home, entity, coordinates.
 - `closest()` will find the closest entity.


## {% linkable_title Examples %}

### {% linkable_title States %}
Next two statements result in same value if state exists. Second one will result in an error if state does not exist.

```jinja2
{% raw %}
{{ states('device_tracker.paulus') }}
{{ states.device_tracker.paulus.state }}{% endraw %}
```

### {% linkable_title Attributes %}

Print an attribute if state is defined

```jinja2
{% raw %}
{% if states.device_tracker.paulus %}
{{ states.device_tracker.paulus.attributes.battery }}
{% else %}
??
{% endif %}{% endraw %}
```

### {% linkable_title Sensor states %}

Print out a list of all the sensor states.

```jinja2
{% raw %}
{% for state in states.sensor %}
  {{ state.entity_id }}={{ state.state }},
{% endfor %}

{% if is_state('device_tracker.paulus', 'home') %}
  Ha, Paulus is home!
{% else %}
  Paulus is at {{ states('device_tracker.paulus')) }}.
{% endif %}

{{ states.sensor.temperature | multiply(10) | round(2) }}

{% if states('sensor.temperature') | float > 20 %}
  It is warm!
{%endif %}{% endraw %}
```

### {% linkable_title Distance examples %}

If only 1 location is passed in will measure the distance from home.

```jinja2
{% raw %}
Using Lat Lng coordinates: {{ distance(123.45, 123.45) }}

Using State: {{ distance(device_tracker.paulus) }}

These can also be combined in any combination:
{{ distance(123.45, 123.45, device_tracker.paulus) }}
{{ distance(device_tracker.anne_therese, device_tracker.paulus) }}{% endraw %}
```

### {% linkable_title Closest examples %}

Find entities closest to the Home Assistant location:

```jinja2
{% raw %}
Query all entities: {{ closest(states) }}
Query all entities of a specific domain: {{ closest(states.device_tracker) }}
Query all entities in group.children: {{ closest('group.children') }}
Query all entities in group.children: {{ closest(states.group.children) }}{% endraw %}
```

Find entities closest to a coordinate or another entity. All previous arguments still apply for 2nd argument.

```jinja2
{% raw %}
Closest to a coordinate: {{ closest(23.456, 23.456, 'group.children') }}
Closest to an entity: {{ closest('zone.school', 'group.children') }}
Closest to an entity: {{ closest(states.zone.school, 'group.children') }}{% endraw %}
```

### {% linkable_title Combined %}
Since closest returns a state, we can combine it with distance too

```jinja2
{% raw %}
{{ closest(states).name }} is {{ distance(closest(states)) }} meters away.{% endraw %}
```

## {% linkable_title Processing incoming data %}

The other part of templating is processing incoming data. It will allow you to modify incoming data and extract only the data you care about. This will work only for platforms and components that mentioned support for this in their documentation.

It depends per component or platform but it is common to be able to define a template using the `value_template` configuration key. When a new value arrives, your template will be rendered while having access to the following values on top of the usual Home Assistant extensions:

| Variable     | Description |
| ------------ | ----------- |
| `value`      | The incoming value.
| `value_json` | The incoming value parsed as JSON.

```jinja2
# Incoming value:
{"primes": [2, 3, 5, 7, 11, 13]}

# Extract third prime number
{% raw %}{{ value_json.primes[2] }}{% endraw %}
```
