mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 07:16:47 +00:00
73 lines
1.8 KiB
Markdown
73 lines
1.8 KiB
Markdown
---
|
|
title: MQTT Eventstream
|
|
description: Instructions on how to setup MQTT eventstream within Home Assistant.
|
|
ha_category:
|
|
- Other
|
|
ha_release: 0.11
|
|
ha_iot_class: Local Polling
|
|
ha_domain: mqtt_eventstream
|
|
ha_integration_type: integration
|
|
related:
|
|
- docs: /docs/configuration/
|
|
title: Configuration file
|
|
---
|
|
|
|
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 %}
|
|
|
|
```yaml
|
|
# 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](/docs/configuration/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.
|
|
|
|
```yaml
|
|
# 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.
|
|
|
|
```yaml
|
|
# Example child instance configuration.yaml entry
|
|
mqtt_eventstream:
|
|
publish_topic: child/upstairs
|
|
subscribe_topic: parent/topic
|
|
```
|
|
|
|
```yaml
|
|
# Example child instance configuration.yaml entry
|
|
mqtt_eventstream:
|
|
publish_topic: child/downstairs
|
|
subscribe_topic: parent/topic
|
|
```
|