Re-organisation Documentation and Getting started (#2055)
* Split MQTT documentation * Add more details * Move content to /docs * Enable sidebar * Move content to /docs * Enable sidebar * Move content * Update links * Remove wizard stuff * Enable sidebar * Minor changes * Move MQTT parts to /docs * update links * Update links and sync content * Fix link * Enable sidebar * Remove navigation * Remove navigation and other minor updates * Update links * Add overview page * Make title linkable * Update * Plit content * Update links * Rearrange content * New getting-started section * Add icons for docs * Update for new structure * Update for new structure * Add docs navigation * Add docs overview page * Remove ecosystem navigation * Add docs and remove other collections * Move ecosystem to docs * Remove duplicate files * Re-add ecosystem overview * Move to ecosystem * Fix permission * Update navigation * Remove collection * Move overview to right folder * Move mqtt to upper level * Move notebook to ecosystem * Remove un-used files * Add one more rectangle for iOS * Move two parts back from docs and rename Run step * Remove colon * update getting-started section * Add redirect * Update * Update navigation
This commit is contained in:
parent
0677895b5b
commit
481320128f
138 changed files with 1309 additions and 909 deletions
40
source/_docs/mqtt/birth_will.markdown
Normal file
40
source/_docs/mqtt/birth_will.markdown
Normal file
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
layout: page
|
||||
title: "MQTT Birth and Last will"
|
||||
description: "Instructions how to setup MQTT birth and last will messages within Home Assistant."
|
||||
date: 2015-08-07 18:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: mqtt.png
|
||||
---
|
||||
|
||||
MQTT support so-called Birth and Last Will and Testament (LWT) messages. The former is used to sned a message after the service has started. the latter is here to notify other clients about an ungracefully disconnected client or alike.
|
||||
|
||||
To integrate MQTT Birth and Last Will messages into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mqtt:
|
||||
birth_message:
|
||||
topic: 'hass/status'
|
||||
payload: 'online'
|
||||
will_message:
|
||||
topic: 'hass/status'
|
||||
payload: 'offline'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **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`.
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue