mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Update Birth_will MQTT component configuration (#7380)
This commit is contained in:
parent
9899c4c817
commit
7da774c0e9
@ -25,15 +25,51 @@ mqtt:
|
||||
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`.
|
||||
{% configuration %}
|
||||
birth_message:
|
||||
description: Birth Message.
|
||||
required: false
|
||||
type: list
|
||||
keys:
|
||||
topic:
|
||||
description: The MQTT topic to publish the message.
|
||||
required: true
|
||||
type: string
|
||||
payload:
|
||||
description: The message content.
|
||||
required: true
|
||||
type: string
|
||||
qos:
|
||||
description: The maximum QoS level of the topic.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
retain:
|
||||
description: If the published message should have the retain flag on or not.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
will_message:
|
||||
description: Will Message
|
||||
required: false
|
||||
type: list
|
||||
keys:
|
||||
topic:
|
||||
description: The MQTT topic to publish the message.
|
||||
required: true
|
||||
type: string
|
||||
payload:
|
||||
description: The message content.
|
||||
required: true
|
||||
type: string
|
||||
qos:
|
||||
description: The maximum QoS level of the topic.
|
||||
required: false
|
||||
default: 0
|
||||
type: integer
|
||||
retain:
|
||||
description: If the published message should have the retain flag on or not.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user