Home Assistant MQTT Components Binding

NOTE: This binding is provided by the MQTT binding (opens new window), and therefore no explicit installation is necessary beyond installing the MQTT binding.

Devices that use Home Assistant MQTT Discovery (opens new window) are automatically configured with this binding. Components that share a common device.identifiers will automatically be grouped together as a single Thing. Each component will be represented as a Channel Group, with the attributes of that component being individual channels.

Requirements

The Home Assistant MQTT binding requires two transformations to be installed:

• JINJA-Transformations
• JSONPath-Transformations

These can be installed under Settings → Addon → Transformations

Discovery

Any device that publishes the component configuration under the homeassistant prefix in MQTT will have their components automatically discovered and added to the Inbox. You can also manually create a Thing, and provide the individual component topics, as well as a different discovery prefix.

Supported Components

• Alarm Control Panel (opens new window)
• Binary Sensor (opens new window)
• Button (opens new window)
• Camera (opens new window)
  JSON attributes and Base64 encoding are not supported.
• Climate (opens new window)
• Cover (opens new window)
• Device Trigger (opens new window)
• Fan (opens new window)
  Only ON/OFF is supported. JSON attributes are not supported.
• Light (opens new window)
  Template schema is not supported. Command templates only have access to the value variable.
• Lock (opens new window)
• Number (opens new window)
• Scene (opens new window)
• Select (opens new window)
• Sensor (opens new window)
• Switch (opens new window)
• Update (opens new window)
  This is a special component, that will show up as additional properties on the Thing, and add a button on the Thing to initiate an OTA update.
• Vacuum (opens new window)

Supported Devices

See the Home Assistant documentation (opens new window) for a broad list of devices that should be supported by this binding. It's not feasible to test every component from every device, so there may be issues with specific devices. Please report an issue on GitHub (opens new window) if you find a device that is not working as expected, and not otherwise noted as a limitation above.

ESPHome

Configure your device to connect to MQTT as described in the documentation (opens new window), and make sure discovery is not set to false. Assuming you're not running Home Assistant in parallel, you should also remove any api: block in your configuration.

Tasmota

To activate Home Assistant discovery support on your Tasmota device you need to do the following:

• Configuration → MQTT: You must have unique Client name and Topic (should be the default).
• Configuration → 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.

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub (opens new window)