WARNING:
plugin functionality is beta code.

MQTTHomeAssistantConfig uses the device discovery functionality of the MQTT integration. This is a single json message with all of the components for a given device. Multiple Home Assistant devices can be configured. Each device has its own MQTT discovery message. A device can subscribe to multiple MQTT state topics.

A design goal is to need very little configuration to use the functionality, but to make additional customization easily configured. The following is the smallest required configuration information

[MQTTPublish]

...

    [[topics]]
        [[[REPLACE_ME_TOPIC]]]

        ...

    [[plugins]]
        [[[MQTTHomeAssistantConfig]]]
            [[[[devices]]]]
                [[[[[REPLACE_ME_DEVICE]]]]]
                    [[[[[[topics]]]]]]
                        # Note this topic, REPLACE_ME_TOPIC, must under the [MQTTPublish][[topics]] section
                        [[[[[[[REPLACE_ME_TOPIC]]]]]]]

This will create the device REPLACE_ME_DEVICE in Home Assistant. All of the fields published to the REPLACE_ME_TOPIC will be components associated with the device. By default the data published to REPLACE_ME_TOPIC is expected to be json. But, this can be configured for each WeeWX field to be published individually to topics named, REPLACE_ME_TOPIC/fieldname.

THe following Home Assistant data is automatically derived from the data in WeeWX.

  • The component’s unique_id is set to the device_id concatentated with the name of the WeeWX observation.
  • The component’s name is sourced from WeeWX’s labels.
  • The component’s device_class is set based on the WeeWX fieldname.
  • The component’s units is set based on the units of the WeeWX data.

All of these ‘default’ settings are easily overridden. In addition, it is easy to configure additional WeeWX fieldname to Home Assistant component mapping.

MQTTHomeAssistantConfig subscribes to HA’s “birth message”. If a “birth message” is received, the discovery message is resent. This eliminates the need to publish the discovery message with retain = True. But, the retain = True setting can easily be overridden.

The [[[MQTTHomeAssistantConfig]]] section

module

The module must be set to: user.mqtthaconfig.

enable

Whether the plugin is enabled or not. Valid values: true or false Default is true.

qos

MQTT qos when subscribing to the birth and lwt topics. Valid values: 0, 1, 2 Default is 0

birth_topic

The Home Assistant birth topic. Default is homeassistant/status

birth_payload

The Home Assistant birth payload. Default is online.

lwt_topic

The Home Assistant lwt topic. Default is homeassistant/status.

lwt_payload

The Home Assistant lwt payload. Default is offline.

discovery_topic_prefix

THe Home Assistant discovery topic prefix. Default is homeassistant.

Sections