From 7da774c0e957e7a4a60ec10fd8d93d355091becd Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 6 Nov 2018 08:16:13 +0100 Subject: [PATCH] Update Birth_will MQTT component configuration (#7380) --- source/_docs/mqtt/birth_will.markdown | 60 +++++++++++++++++++++------ 1 file changed, 48 insertions(+), 12 deletions(-) diff --git a/source/_docs/mqtt/birth_will.markdown b/source/_docs/mqtt/birth_will.markdown index 8ba1aa593ad..d0c46687279 100644 --- a/source/_docs/mqtt/birth_will.markdown +++ b/source/_docs/mqtt/birth_will.markdown @@ -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 %}