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

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_BASE_TOPIC = "base_topic"
 
string CONF_PUBLISH_ATTRIBUTES = "publish_attributes"
 
string CONF_PUBLISH_TIMESTAMPS = "publish_timestamps"
 
 CONFIG_SCHEMA
 
string DOMAIN = "mqtt_statestream"
 

Detailed Description

Publish simple item state changes via MQTT.

Function Documentation

◆ async_setup()

bool homeassistant.components.mqtt_statestream.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the MQTT state feed.

Definition at line 43 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 40 of file __init__.py.

◆ CONF_BASE_TOPIC

string homeassistant.components.mqtt_statestream.CONF_BASE_TOPIC = "base_topic"

Definition at line 21 of file __init__.py.

◆ CONF_PUBLISH_ATTRIBUTES

string homeassistant.components.mqtt_statestream.CONF_PUBLISH_ATTRIBUTES = "publish_attributes"

Definition at line 22 of file __init__.py.

◆ CONF_PUBLISH_TIMESTAMPS

string homeassistant.components.mqtt_statestream.CONF_PUBLISH_TIMESTAMPS = "publish_timestamps"

Definition at line 23 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.mqtt_statestream.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: INCLUDE_EXCLUDE_BASE_FILTER_SCHEMA.extend(
4  {
5  vol.Required(CONF_BASE_TOPIC): valid_publish_topic,
6  vol.Optional(CONF_PUBLISH_ATTRIBUTES, default=False): cv.boolean,
7  vol.Optional(CONF_PUBLISH_TIMESTAMPS, default=False): cv.boolean,
8  }
9  ),
10  },
11  extra=vol.ALLOW_EXTRA,
12 )

Definition at line 27 of file __init__.py.

◆ DOMAIN

string homeassistant.components.mqtt_statestream.DOMAIN = "mqtt_statestream"

Definition at line 25 of file __init__.py.