Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt_eventstream Namespace Reference

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
list BLOCKED_EVENTS
 
string CONF_IGNORE_EVENT = "ignore_event"
 
string CONF_PUBLISH_EVENTSTREAM_RECEIVED = "publish_eventstream_received"
 
string CONF_PUBLISH_TOPIC = "publish_topic"
 
string CONF_SUBSCRIBE_TOPIC = "subscribe_topic"
 
 CONFIG_SCHEMA
 
string DOMAIN = "mqtt_eventstream"
 

Detailed Description

Connect two Home Assistant instances via MQTT.

Function Documentation

◆ async_setup()

bool homeassistant.components.mqtt_eventstream.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the MQTT eventstream component.

Definition at line 59 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.mqtt_eventstream._LOGGER = logging.getLogger(__name__)
private

Definition at line 26 of file __init__.py.

◆ BLOCKED_EVENTS

list homeassistant.components.mqtt_eventstream.BLOCKED_EVENTS
Initial value:
1 = [
2  EVENT_HOMEASSISTANT_CLOSE,
3  EVENT_HOMEASSISTANT_START,
4  EVENT_HOMEASSISTANT_STARTED,
5  EVENT_HOMEASSISTANT_STOP,
6  EVENT_HOMEASSISTANT_FINAL_WRITE,
7 ]

Definition at line 50 of file __init__.py.

◆ CONF_IGNORE_EVENT

string homeassistant.components.mqtt_eventstream.CONF_IGNORE_EVENT = "ignore_event"

Definition at line 32 of file __init__.py.

◆ CONF_PUBLISH_EVENTSTREAM_RECEIVED

string homeassistant.components.mqtt_eventstream.CONF_PUBLISH_EVENTSTREAM_RECEIVED = "publish_eventstream_received"

Definition at line 31 of file __init__.py.

◆ CONF_PUBLISH_TOPIC

string homeassistant.components.mqtt_eventstream.CONF_PUBLISH_TOPIC = "publish_topic"

Definition at line 29 of file __init__.py.

◆ CONF_SUBSCRIBE_TOPIC

string homeassistant.components.mqtt_eventstream.CONF_SUBSCRIBE_TOPIC = "subscribe_topic"

Definition at line 30 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.mqtt_eventstream.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Optional(CONF_PUBLISH_TOPIC): valid_publish_topic,
6  vol.Optional(CONF_SUBSCRIBE_TOPIC): valid_subscribe_topic,
7  vol.Optional(
8  CONF_PUBLISH_EVENTSTREAM_RECEIVED, default=False
9  ): cv.boolean,
10  vol.Optional(CONF_IGNORE_EVENT, default=[]): cv.ensure_list,
11  }
12  )
13  },
14  extra=vol.ALLOW_EXTRA,
15 )

Definition at line 34 of file __init__.py.

◆ DOMAIN

string homeassistant.components.mqtt_eventstream.DOMAIN = "mqtt_eventstream"

Definition at line 28 of file __init__.py.