-
Notifications
You must be signed in to change notification settings - Fork 0
MQTT \ Home Assistant
The following is a list of the current MQTT topics and valid payloads supported by the Tailwind API and Tailwind2MQTT bridge. The values MQTT_TOPIC_SUB and MQTT_TOPIC_PUB will be substituted with the topics you define in the settings file. See the Settings and Credentials page for more information on defining your own MQTT topics.
Command Topics - issued TO the bridge to control Tailwind
| TOPIC | PAYLOAD | NOTES |
|---|---|---|
MQTT_TOPIC_SUB/opendoor |
1, 2 or 3 | Open corresponding Tailwind door |
MQTT_TOPIC_SUB/closedoor |
1, 2 or 3 | Close corresponding Tailwind door |
MQTT_TOPIC_SUB/toogledoor |
1, 2 or 3 | Toggle corresponding Tailwind door (open if closed, close if open) |
State Topics - sent FROM the bridge to MQTT broker
| TOPIC | PAYLOAD | NOTES |
|---|---|---|
MQTT_TOPIC_PUB/mqtt |
connected |
Published upon boot connection to MQTT. Generally used for troubleshooting |
MQTT_TOPIC_PUB/lastresult |
OK, FAILED or INVALID |
Returns the result of the last command. OK if successful, FAILED if Tailwind web server does not return '200' or the API does not return the proper result code. INVALID if an invalid payload was passed. |
MQTT_TOPIC_PUB/statuscode |
0-7 |
Returns the Tailwind API raw status code from a command |
MQTT_TOPIC_PUB/door1/state |
'on' or 'off' |
'on' represents an open door from an Home Assistant binary_sensor perspective and 'off' represents closed. |
MQTT_TOPIC_PUB/door2/state |
'on' or 'off' |
'on' open, 'off' closed. |
MQTT_TOPIC_PUB/door3/state |
'on' or 'off' |
'on' open, 'off' closed. |
Currently, you must manually create MQTT sensors via yaml. It is hoped that later releases will avoid this via either a Home Assistant Community Store (HACS) integration or via MQTT discovery.
You do not need to create sensors for every possible MQTT topic. For example, if you only have a single garage door connected to Tailwind as 'Door 1', there is no need to create binary sensors for doors 2 and 3. Similarly, you do not need to create sensors for other topics like statuscode unless you want to see or use that in some manner.
At a minimum, you'll probably want a binary sensor for the state of each door you have connected to Tailwind and a script for each of the three commands: Open, Close and Toggle. See the \homeassistant folder for yaml examples of sensors, scripts and Lovelace.