MQTT supports so-called Birth and Last Will and Testament (LWT) messages. The former is used to send a message after the service has started, and the latter is used to notify other clients about an ungracefully disconnected client.
To integrate MQTT Birth and Last Will messages into Home Assistant, add the following section to your configuration.yaml file:
# Example configuration.yaml entry
mqtt:
birth_message:
topic: 'hass/status'
payload: 'online'
will_message:
topic: 'hass/status'
payload: 'offline'
Configuration Variables
-
birth_message
(list)(Optional)Birth Message.
-
topic
(string)(Required)The MQTT topic to publish the message.
-
payload
(string)(Required)The message content.
-
qos
-
(integer)(Optional)The maximum QoS level of the topic.
Default value:
0
-
retain
-
(boolean)(Optional)If the published message should have the retain flag on or not.
Default value:
true
-
will_message
(list)(Optional)Will Message
-
topic
(string)(Required)The MQTT topic to publish the message.
-
payload
(string)(Required)The message content.
-
qos
-
(integer)(Optional)The maximum QoS level of the topic.
Default value:
0
-
retain
-
(boolean)(Optional)If the published message should have the retain flag on or not.
Default value:
true
