home-assistant.github.io/source/_components/mqtt_eventstream.markdown
Mike Megally 8729f5a024 Update mqtt_eventstream with ignore_call_service (#4705)
* Update mqtt_eventstream with ignore_call_service

Documentation for ignore_call_service

* update docs to reflect new functionality

updated docs based on PR feedback

* update example
2018-02-23 15:09:44 -08:00

70 lines
1.7 KiB
Markdown

---
layout: page
title: "MQTT Eventstream"
description: "Instructions how to setup MQTT eventstream within Home Assistant."
date: 2016-01-13 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: mqtt.png
ha_category: Other
ha_release: 0.11
ha_iot_class: depends
---
The `mqtt_eventstream` component connects two Home Assistant instances via MQTT.
To integrate MQTT Eventstream into Home Assistant, add the following section to your `configuration.yaml` file:
```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: Ignore sending these [events](/docs/configuration/events/) over mqtt.
required: false
type: list
{% endconfiguration %}
## {% linkable_title Multiple Instances %}
Events from multiple instances can be aggregated to a single master instance by subscribing to a wildcard topic from the master instance.
```yaml
# Example master instance configuration.yaml entry
mqtt_eventstream:
publish_topic: master/topic
subscribe_topic: slaves/#
ignore_event:
- call_service
- state_changed
```
For a multiple instance setup, each slave would publish to their own topic.
```yaml
# Example slave instance configuration.yaml entry
mqtt_eventstream:
publish_topic: slaves/upstairs
subscribe_topic: master/topic
```
```yaml
# Example slave instance configuration.yaml entry
mqtt_eventstream:
publish_topic: slaves/downstairs
subscribe_topic: master/topic
```