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-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update MQTT binary sensor example (#14182)

Browse Source
This commit is contained in:
Erik Montnemery 2020-08-07 18:06:48 +02:00 committed by GitHub
parent 879554d461
commit 9f3e7150fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -160,14 +160,17 @@ value_template:
In this section, you will find some real-life examples of how to use this sensor. In this section, you will find some real-life examples of how to use this sensor.
### Full configuration ### Full configuration with JSON data
This is an example of a configuration where the state is extracted from a JSON formatted MQTT message.
To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages.
To set the state of the binary sensor manually: To set the state of the binary sensor manually:
```bash ```bash
mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m "OFF" mosquitto_pub -h 127.0.0.1 -t home-assistant/window/availability -m "online"
mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m '{"state":"ON"}'
mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m '{"state":"OFF"}'
``` ```
The example below shows a full configuration for a binary sensor: The example below shows a full configuration for a binary sensor:
@ -181,14 +184,13 @@ binary_sensor:
name: "Window Contact Sensor" name: "Window Contact Sensor"
state_topic: "home-assistant/window/contact" state_topic: "home-assistant/window/contact"
payload_on: "ON" payload_on: "ON"
payload_off: "OFF"
availability: availability:
- topic: "home-assistant/window/availability" - topic: "home-assistant/window/availability"
payload_available: "online" payload_available: "online"
payload_not_available: "offline" payload_not_available: "offline"
qos: 0 qos: 0
device_class: opening device_class: opening
value_template: '{{ value.x }}' value_template: '{{ value_json.state }}'
``` ```
{% endraw %} {% endraw %}