home-assistant.io/source/_integrations/mqtt_eventstream.markdown
2024-11-27 18:57:16 +01:00

1.9 KiB

title description ha_category ha_release ha_iot_class ha_domain ha_integration_type related ha_quality_scale
MQTT Eventstream Instructions on how to setup MQTT eventstream within Home Assistant.
Other
0.11 Local Polling mqtt_eventstream integration
docs title
/docs/configuration/ Configuration file
legacy

The mqtt_eventstream {% term integration %} connects two Home Assistant instances via MQTT.

Configuration

To integrate MQTT Eventstream into Home Assistant, add the following section to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# Example configuration.yaml entry
mqtt_eventstream:
  publish_topic: MyServerName
  subscribe_topic: OtherHaServerName

{% configuration %} publish_topic: description: Topic for publishing local events. required: false type: string subscribe_topic: description: Topic to receive events from the remote server. required: false type: string ignore_event: description: List of events which will not be sent over MQTT. required: false type: list {% endconfiguration %}

Multiple instances

Events from multiple instances can be aggregated to a single parent instance by subscribing to a wildcard topic from the parent instance.

# Example parent instance configuration.yaml entry
mqtt_eventstream:
  publish_topic: parent/topic
  subscribe_topic: child/#
  ignore_event:
    - call_service
    - state_changed

For a multiple instance setup, each child instance would publish to their own topic.

# Example child instance configuration.yaml entry
mqtt_eventstream:
  publish_topic: child/upstairs
  subscribe_topic: parent/topic
# Example child instance configuration.yaml entry
mqtt_eventstream:
  publish_topic: child/downstairs
  subscribe_topic: parent/topic