Add documentation for availability topic and payloads #3378
Conversation
Added documentation for availabiltiy topic and payloads added in a pull request. Also cleaned up documentation for the MQTT cover generally to make clear the differences between state topic and messages and availability topic and messages.
|
@marthoc, thanks for your PR! By analyzing the history of the files in this pull request, we identified @n8henrie, @fabaff and @cribbstechnologies to be potential reviewers. |
| - **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is `true` if no state topic defined, else `false`. | ||
| - **qos** (*Optional*): The maximum QoS level of the state topic. Default is `0`. Will also be used when publishing messages. | ||
| - **retain** (*Optional*): If the published message should have the retain flag on or not. Default is `false`. | ||
| - **qos** (*Optional*): The maximum QoS level to be used when receiving and publishing messages. |
There was a problem hiding this comment.
I think we should keep the info on default qos value.
Added documentation for availability topic and payloads added to the MQTT binary sensor in a pull request. Also cleaned up documentation for the MQTT binary sensor generally.
|
Added another commit to this PR to address additional functionality added in another PR (noted above). |
|
Please keep the PRs as small as possible. That way the review is easier and the PR will get merged quicker. It's better to make two smaller PRs than one larger. |
|
@MartinHjelmare Yes sorry about that - this was accidental and I will make separate PRs for future documentation updates. |
| - **availability_topic** (*Optional*): The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor availability state will always be `available`. If `availability_topic` is defined, the binary sensor availability state will be `unavailable` by default. | ||
| - **payload_available** (*Optional*): The payload that represents the online state. Default is `online`. | ||
| - **payload_not_available** (*Optional*): The payload that represents the offline state. Default is `offline`. | ||
| - **qos** (*Optional*): The maximum QoS level to be used when receiving and publishing messages. Default is `0`. |
There was a problem hiding this comment.
The binary sensor implementation in home assistant doesn't publish messages, right? I guess this is a standard phrase, but it could be confusing like this.
Description:
Added documentation for availability topic and payloads added in pull requests. Also cleaned up documentation for the MQTT cover generally to make clear the differences between state topic and messages and availability topic and messages, and the MQTT binary sensor generally.
Pull request in home-assistant (if applicable): home-assistant/core#9445, home-assistant/core#9507