Add docs for warning config. Fix bug. (#492)

This commit is contained in:
Greg Dowling 2016-06-02 07:12:21 +01:00 committed by Fabian Affolter
parent 41f6365e21
commit 1d7e6419ca
2 changed files with 6 additions and 3 deletions

View File

@ -30,6 +30,7 @@ Configuration variables:
- **friendly_name** (*Optional*): Name to use in the Frontend. - **friendly_name** (*Optional*): Name to use in the Frontend.
- **sensor_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend. - **sensor_class** (*Optional*): The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload. - **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
- **warnings** (*Optional*): Turn off warnings (useful if the sensor is loaded before devices it depends on).
## {% linkable_title Examples %} ## {% linkable_title Examples %}
@ -44,7 +45,7 @@ sensor:
platform: template platform: template
sensors: sensors:
furnace_on: furnace_on:
value_template: {{ states.sensor.furnace.state > 2.5 }} value_template: {% raw %}`{{ states.sensor.furnace.state > 2.5 }}`{% endraw %}
friendly_name: 'Furnace Running friendly_name: 'Furnace Running
sensor_class: heat sensor_class: heat
``` ```

View File

@ -34,6 +34,7 @@ Configuration variables:
- **friendly_name** (*Optional*): Name to use in the Frontend. - **friendly_name** (*Optional*): Name to use in the Frontend.
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any. - **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload. - **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
- **warnings** (*Optional*): Turn off warnings (useful if the sensor is loaded before devices it depends on).
## {% linkable_title Examples %} ## {% linkable_title Examples %}
@ -54,9 +55,9 @@ sensor:
unit_of_measurement: '°' unit_of_measurement: '°'
``` ```
### {% linkable_title Multi line example with an if test %} ### {% linkable_title Multi line example with an if test (and warnings disabled)%}
This example shows a multiple line template with and is test. It looks at a sensing switch and shows on/off in the frontend. This example shows a multiple line template with and if test. It looks at a sensing switch and shows on/off in the frontend. It disables warnings to avoid log messages where the switch it depends on isn't loaded yet.
```yaml ```yaml
sensor: sensor:
@ -75,6 +76,7 @@ sensor:
failed failed
{%- endif %}{% endraw %} {%- endif %}{% endraw %}
warnings: Off
``` ```
(please note the blank line to close the multi-line template) (please note the blank line to close the multi-line template)