jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge pull request #1445 from home-assistant/mqtt-birth

Browse source 
Add birth and will message
This commit is contained in:
Fabian Affolter 2016-11-15 08:34:38 +01:00 • committed by GitHub
commit e60a8a7975
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
source/_components/mqtt.markdown
View file

@ -29,6 +29,16 @@ mqtt:
password: PASSWORD password: PASSWORD
certificate: /home/paulus/dev/addtrustexternalcaroot.crt certificate: /home/paulus/dev/addtrustexternalcaroot.crt
protocol: 3.1 protocol: 3.1
birth_message:
topic: 'hass/status'
payload: 'online'
qos: 1
retain: true
will_message:
topic: 'hass/status'
payload: 'offline'
qos: 1
retain: true
``` ```
Configuration variables: Configuration variables:
@ -43,6 +53,16 @@ Configuration variables:
- **client_key** (*Optional*): Client key (example: `/home/user/owntracks/cookie.key`) - **client_key** (*Optional*): Client key (example: `/home/user/owntracks/cookie.key`)
- **client_cert** (*Optional*): Client certificate (example: `/home/user/owntracks/cookie.crt`) - **client_cert** (*Optional*): Client certificate (example: `/home/user/owntracks/cookie.crt`)
- **protocol** (*Optional*): Protocol to use: 3.1 or 3.1.1. By default it connects with 3.1.1 and falls back to 3.1 if server does not support 3.1. - **protocol** (*Optional*): Protocol to use: 3.1 or 3.1.1. By default it connects with 3.1.1 and falls back to 3.1 if server does not support 3.1.
- **birth_message** (*Optional*):
- **topic** (*Required*): The MQTT topic to publish the message.
- **payload** (*Required*): The message content.
- **qos** (*Optional*): The maximum QoS level of the topic. Default is 0.
- **retain** (*Optional*): If the published message should have the retain flag on or not. Defaults to `True`.
- **will_message** (*Optional*):
- **topic** (*Required*): The MQTT topic to publish the message.
- **payload** (*Required*): The message content.
- **qos** (*Optional*): The maximum QoS level of the topic. Default is 0.
- **retain** (*Optional*): If the published message should have the retain flag on or not. Defaults to `True`.
## {% linkable_title Picking a broker %} ## {% linkable_title Picking a broker %}