Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-26 17:27:47 +01:00
Code Issues Projects Releases Wiki Activity

Add MQTT discovery note

Browse Source
This commit is contained in:
Otto Winter 2018-06-07 23:01:07 +02:00
parent 1e6255870a
commit a358c6e3e8
No known key found for this signature in database
GPG Key ID: DB66C0BE6013F97E
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
esphomeyaml/components/mqtt.rst
View File

@ -150,7 +150,7 @@ Last Will And Birth Messages
esphomelib (and esphomeyaml) uses the `last will esphomelib (and esphomeyaml) uses the `last will
testament <https://www.hivemq.com/blog/mqtt-essentials-part-9-last-will-and-testament>`__ testament <https://www.hivemq.com/blog/mqtt-essentials-part-9-last-will-and-testament>`__
and birth message feature of MQTT to achieve availabilty reporting for and birth message feature of MQTT to achieve availability reporting for
Home Assistant. If the node is not connected to MQTT, Home Assistant Home Assistant. If the node is not connected to MQTT, Home Assistant
will show all its entities as unavailable (a feature 😉). will show all its entities as unavailable (a feature 😉).
@ -181,7 +181,7 @@ You can change these messages by overriding the ``birth_message`` and
- **will_message** (*Optional*, :ref:`mqtt-message`) - **will_message** (*Optional*, :ref:`mqtt-message`)
If the birth message and last will message have empty topics or topics If the birth message and last will message have empty topics or topics
that are different from each other, availabilty reporting will be that are different from each other, availability reporting will be
disabled. disabled.
.. _mqtt-ssl_fingerprints: .. _mqtt-ssl_fingerprints:
@ -226,7 +226,7 @@ MQTT can have some overrides for specific options.
# Optional variables: # Optional variables:
retain: True retain: True
discovery: True discovery: True
availabilty: availability:
topic: livingroom/status topic: livingroom/status
payload_available: online payload_available: online
payload_not_available: offline payload_not_available: offline
@ -241,8 +241,8 @@ Configuration variables:
be retained. Defaults to ``True``. be retained. Defaults to ``True``.
- **discovery** (*Optional*, boolean): Manually enable/disable - **discovery** (*Optional*, boolean): Manually enable/disable
discovery for a component. Defaults to the global default. discovery for a component. Defaults to the global default.
- **availabilty** (*Optional*): Manually set what should be sent to - **availability** (*Optional*): Manually set what should be sent to
Home Assistant for showing entity availabilty. Default derived from Home Assistant for showing entity availability. Default derived from
:ref:`global birth/last will message <mqtt-last_will_birth>`. :ref:`global birth/last will message <mqtt-last_will_birth>`.
- **state_topic** (*Optional*, string): The topic to publish state - **state_topic** (*Optional*, string): The topic to publish state
updates to. Defaults to updates to. Defaults to
@ -251,6 +251,11 @@ Configuration variables:
commands from the remote. Defaults to commands from the remote. Defaults to
``<TOPIC_PREFIX>/<COMPONENT_TYPE>/<COMPONENT_NAME>/command``. ``<TOPIC_PREFIX>/<COMPONENT_TYPE>/<COMPONENT_NAME>/command``.
.. warning::
When changing these options and you're using MQTT discovery, you will need to restart Home Assistant.
This is because Home Assistant only discovers a device once in every Home Assistant start.
.. _mqtt-on_message: .. _mqtt-on_message:
on_message on_message