I had looked at the config-template card but, since I wanted to be able to reuse the Jinja2 templates I use in the rest of Home Assistant, I decided to see if I could create a card like that which could apply Jinja2 templates Lovelace cards.
Introducing the card-templater card
https://github.com/gadgetchnnel/lovelace-card-templater
Installation
This requires card-tools to be installed, check the link for details on installing this if you don’t have it installed.
This card can either be installed using custom_updater or manually.
With custom_updater
resources:
- url: /customcards/github/gadgetchnnel/lovelace-card-templater.js?track=true
type: js
Manually
Download the lovelace-text-input-row.js and put it somewhere under config folder/www
resources:
- url: local/path/to/file/lovelace-card-templater.js?v=0.0.2
type: js
Options
| Name | Type | Optional/Required | Description |
|---|---|---|---|
| type | string | Required | custom:card-templater |
| card | object | Required | The card to display (see below about templating) |
| entities | list | Required | Entities to watch for changes (can also be used to template entity states, see below) |
Card templating
The card option will accept any card configration. Any option in the original card which takes a string value can be templated by changing the option name to be option_name_template. For example, name will become name_template. Here is an example:
type: 'custom:card-templater'
card:
type: entities
show_header_toggle: false
columns: 2
title: Places
entities:
- entity: zone.home
name_template: >-
{{ state_attr("zone.home","friendly_name") }} - {{
(distance(states.device_tracker.my_phone, states.zone.home) *
0.621371) | round(1) }} miles.
- entity: zone.work
name_template: >-
{{ state_attr("zone.work","friendly_name") }} - {{
(distance(states.device_tracker.my_phone, states.zone.work) *
0.621371) | round(1) }} miles.
entities:
- device_tracker.my_phone
This will display an entities card showing two zones, with the display names including the distance between a device_tracker entity and the zone lke this:
Templating lists
Some card options can be a list of strings (e.g. the state_filter option in the entity-filter card). These can still be templated, but need to be done in a different way, by replacing each string with string_template: {{ template }} as below:
state_filter:
- 'state_one'
- 'state_two'
could become
state_filter:
- string_template: {{ "state_" + "one" }}
- string_template: {{ "state_" + "two" }}
Notes:
It is technically possible to template the card type of the templated_card, e.g. something like this:
type_template: '{{ "entities" if is_state("input_boolean.show_full", "on").state else "glance" }}
However, this has only been tested with the entities and glance cards and may not work reliably with other card types.
entities
This option is required in order that the template will only be processed when one of the referenced entities changes and is similar to the entity option for template sensors. I am investigating if this can be determined from the template but this is difficult to do client-side and so, for now, this option is required.
For complex templates you can create a time sensor like this:
sensor:
- platform: time_date
display_options:
- 'time'
and then use sensor.time under entities
You can also use this to template the state for an entity, so the entity displays other than its actual state. For example:
type: 'custom:card-templater'
card:
type: entities
show_header_toggle: false
columns: 2
title: Places
entities:
- entity: zone.home
name_template: >-
{{ (distance(states.device_tracker.my_phone, states.zone.home) * 0.621371) | round(1) }} miles away.
- entity: zone.work
name_template: >-
{{(distance(states.device_tracker.my_phone, states.zone.work) * 0.621371) | round(1) }} miles away.
entities:
- device_tracker.my_phone
- entity: zone.home
state_template: '{{ state_attr("zone.home","friendly_name") }}'
- entity: zone.work
state_template: '{{ state_attr("zone.work","friendly_name") }}'
entity: zone.work
will display the states of the zones as their friendly names instead of the actual state of (“zoning”) as below:
Basically, virtually any option in a card can be templated (although, as above, there may be issues templating the card type). Here is a more complex template I am currently using which loops though all device_tracker entities and displays their current states as a table in a markdown card:
type: ‘custom:card-templater’
card:
content_template: >-
{{ “| Device | Location |\n” }} {{ “|:-:|:-:|\n” }} {%- for device in
states.device_tracker -%} | {{ device.attributes.friendly_name + " | " +
device.state + " |\n"}} {%- endfor -%}
title: Devices
type: markdown
entities:
- sensor.time
The result is something like this:
Edit: Just a little correction. I noticed I put YAML2, when I obviously mean Jinja2 templates.
