]> git.basschouten.com Git - openhab-addons.git/commitdiff
[mqtt] Add documentation about using auto discovery with Tasmota (#12003)
authorMoritz 'Morty' Strübe <morty@gmx.net>
Tue, 11 Jan 2022 12:25:27 +0000 (13:25 +0100)
committerGitHub <noreply@github.com>
Tue, 11 Jan 2022 12:25:27 +0000 (13:25 +0100)
* [mqtt] HomeAssistant: Doc: Add auto discovery with Tasmota
* [mqtt] HomeAssistant: Doc: Minor formatting adjustments

Signed-off-by: Moritz 'Morty' Strübe <morty@gmx.net>
bundles/org.openhab.binding.mqtt.homeassistant/README.md

index 6c84cbbc2ebf33ea0de90fc8397b88737f72e537..409a788753570b1fc063625229571d8c0c11d4e2 100644 (file)
@@ -1,23 +1,22 @@
 # HomeAssistant MQTT Components Binding
 
-HomeAssistant MQTT Components are recognized as well. The base topic needs to be **homeassistant**. 
+HomeAssistant MQTT Components are recognized as well. The base topic needs to be **homeassistant**.
 The mapping is structured like this:
 
-
-| HA MQTT               | Framework     | Example MQTT topic                 |
-|-----------------------|---------------|------------------------------------|
-| Object                | Thing         | homeassistant/../../object         |
-| Component+Node        | Channel Group | homeassistant/component/node/object|
-| -> Component Features | Channel       | state/topic/defined/in/comp/config |
+| HA MQTT                   | Framework     | Example MQTT topic                    |
+| ------------------------- | ------------- | ------------------------------------- |
+| Object                    | Thing         | `homeassistant/../../object`          |
+| Component+Node            | Channel Group | `homeassistant/component/node/object` |
+| &rarr; Component Features | Channel       | `state/topic/defined/in/comp/config`  |
 
 ## Requirements
 
 The HomeAssistant MQTT requires two transformations to be installed:
 
-* JINJA-Transformations 
+* JINJA-Transformations
 * JSONPath-Transformations
 
-These can be installed under Settings->Addons->Transformations
+These can be installed under `Settings` &rarr; `Addon` &rarr; `Transformations`
 
 ## Limitations
 
@@ -25,3 +24,14 @@ These can be installed under Settings->Addons->Transformations
 * The HomeAssistant Cover Components only support OPEN/CLOSE/STOP.
 * The HomeAssistant Light Component only supports RGB color changes.
 * The HomeAssistant Climate Components is not yet supported.
+
+## Tasmota auto discovery
+
+To activate HomeAssistant discovery support on your Tasmota device you need to do the following:
+
+* `Configuration` &rarr; `MQTT`: You must have unique `Client` name and `Topic` (should be the default).
+* `Configuration` &rarr; `Other`: The `Device Name` will be used to identify the newly found device.
+  And you need to enable MQTT, of course.
+* `Console`: Enter `SetOption19 1`.
+
+Your Tasmota device should now show up in your inbox.