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-14 04:46:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

add notes about payload_xxx, state_xxx and value_template (#12237)

Browse Source 
* add notes about payload_xxx, state_xxx and value_template

There is a complex relationship between payload_xxx, state_xxx and value_template but it’s not reflected at all or well enough to understand how to use them.
That leads to a lot of confusion on how to configure it properly (like this- https://community.home-assistant.io/t/mqtt-switch-value-template/175463)
I think my notes will help.

* ✏️ Tweak

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
This commit is contained in:
akasma74 2020-03-02 15:12:22 +00:00 committed by GitHub
parent e83d466a63
commit 025f5e6ffe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/_integrations/switch.mqtt.markdown
View File

@ -98,12 +98,12 @@ payload_not_available:
type: string type: string
default: offline default: offline
payload_off: payload_off:
description: The payload that represents disabled state. description: The payload that represents `off` state. If specified, will be used for both comparing to the value in the `state_topic` (see `value_template` and `state_off` for details) and sending as `off` command to the `command_topic`.
required: false required: false
type: string type: string
default: "OFF" default: "OFF"
payload_on: payload_on:
description: The payload that represents enabled state. description: The payload that represents `on` state. If specified, will be used for both comparing to the value in the `state_topic` (see `value_template` and `state_on` for details) and sending as `on` command to the `command_topic`.
required: false required: false
type: string type: string
default: "ON" default: "ON"
@ -118,12 +118,12 @@ retain:
type: boolean type: boolean
default: false default: false
state_off: state_off:
description: The payload that represents the off state. description: The payload that represents the `off` state. Used when value that represents `off` state in the `state_topic` is different from value that should be sent to the `command_topic` to turn the device `off`.
required: false required: false
type: string type: string
default: "`payload_off` if defined, else OFF" default: "`payload_off` if defined, else OFF"
state_on: state_on:
description: The payload that represents the on state. description: The payload that represents the `on` state. Used when value that represents `on` state in the `state_topic` is different from value that should be sent to the `command_topic` to turn the device `on`.
required: false required: false
type: string type: string
default: "`payload_on` if defined, else ON" default: "`payload_on` if defined, else ON"
@ -132,7 +132,7 @@ state_topic:
required: false required: false
type: string type: string
value_template: value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's state from the `state_topic`. To determine the switches's state result of this template will be compared to `state_on` and `state_off`."
required: false required: false
type: string type: string
{% endconfiguration %} {% endconfiguration %}