jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add date example

Browse Source
This commit is contained in:
Fabian Affolter 2018-07-08 13:08:32 +02:00
parent 5558f14cb9
commit f4e31fd156
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 27 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
source/_components/sensor.template.markdown
View File

@ -13,11 +13,11 @@ ha_iot_class: "Local Push"
logo: home-assistant.png logo: home-assistant.png
--- ---
The `template` platform supports sensors which break out `state_attributes` The `template` platform supports sensors which break out `state_attributes` from other entities.
from other entities.
To enable Template Sensors in your installation, add the following to your ## {% linkable_title Configuration %}
`configuration.yaml` file:
To enable Template Sensors in your installation, add the following to your `configuration.yaml` file:
{% raw %} {% raw %}
```yaml ```yaml
@ -78,13 +78,7 @@ sensor:
## {% linkable_title Considerations %} ## {% linkable_title Considerations %}
If you are using the state of a platform that takes extra time to load, the If you are using the state of a platform that takes extra time to load, the Template Sensor may get an `unknown` state during startup. To avoid this (and the resulting error messages in your log file), you can use `is_state()` function in your template. 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:
Template Sensor may get an `unknown` state during startup. To avoid this (and the resulting
error messages in your log file), you can use `is_state()` function in your template.
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 %} {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
## {% linkable_title Examples %} ## {% linkable_title Examples %}
@ -109,8 +103,7 @@ sensor:
### {% linkable_title Renaming Sensor Output %} ### {% linkable_title Renaming Sensor Output %}
If you don't like the wording of a sensor output then the Template Sensor can If you don't like the wording of a sensor output then the Template Sensor can help too. Let's rename the output of the [Sun component](/components/sun/) as
help too. Let's rename the output of the [Sun component](/components/sun/) as
a simple example: a simple example:
{% raw %} {% raw %}
@ -129,9 +122,7 @@ sensor:
``` ```
{% endraw %} {% endraw %}
Processes monitored by the [System Monitor sensor](/components/sensor.systemmonitor/) Processes monitored by the [System Monitor sensor](/components/sensor.systemmonitor/) show `on` or `off` if they are running or not. This example shows how the output of a monitored `glances` process can be renamed.
show `on` or `off` if they are running or not. This example shows how the
output of a monitored `glances` process can be renamed.
{% raw %} {% raw %}
```yaml ```yaml
@ -149,13 +140,11 @@ sensor:
``` ```
{% endraw %} {% endraw %}
The [Template Binary Sensor](/components/binary_sensor.template/) is the one in The [Template Binary Sensor](/components/binary_sensor.template/) is the one in similar cases if you prefer to see an icon instead of text.
similar cases if you prefer to see an icon instead of text.
### {% linkable_title Multiline Example With an `if` Test %} ### {% linkable_title Multiline Example With an `if` Test %}
This example shows a multiple line template with an `if` test. It looks at a This example shows a multiple line template with an `if` test. It looks at a sensing switch and shows `on`/`off` in the frontend.
sensing switch and shows `on`/`off` in the frontend.
{% raw %} {% raw %}
```yaml ```yaml
@ -182,8 +171,7 @@ sensor:
### {% linkable_title Change The Unit of Measurement %} ### {% linkable_title Change The Unit of Measurement %}
With a Template Sensor it's easy to convert given values into others if the With a Template Sensor it's easy to convert given values into others if the unit of measurement doesn't fit your needs.
unit of measurement doesn't fit your needs.
{% raw %} {% raw %}
```yaml ```yaml
@ -257,7 +245,7 @@ sensor:
### {% linkable_title Change the Friendly Name Used in the Frontend %} ### {% linkable_title Change the Friendly Name Used in the Frontend %}
This example shows how to change the `friendly_name` based on a date. This example shows how to change the `friendly_name` based on a date.
Explanation: we add a multiple of 86400 seconds (= 1 day) to the current unix timestamp to get a future date. Explanation: We add a multiple of 86400 seconds (= 1 day) to the current unix timestamp to get a future date.
{% raw %} {% raw %}
```yaml ```yaml
@ -295,3 +283,19 @@ sensor:
unit_of_measurement: 'kW' unit_of_measurement: 'kW'
``` ```
{% endraw %} {% endraw %}
### {% linkable_title Working with dates %}
The `template` sensors are not limited to use attributes from other entities but can also work with [Home Assistant's template extensions](/docs/configuration/templating/#home-assistant-template-extensions).
{% raw %}
```yaml
sensor:
- platform: template
sensors:
nonsmoker:
value_template: '{{ (( as_timestamp(now()) - as_timestamp(strptime("06.07.2018", "%d.%m.%Y")) ) / 86400 ) | round(2) }}'
friendly_name: 'Not smoking'
unit_of_measurement: "Days"
```
{% endraw %}