Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.config Namespace Reference

Variables

 MQTT_BASE_SCHEMA = vol.Schema(SCHEMA_BASE)
 
 MQTT_RO_SCHEMA
 
 MQTT_RW_SCHEMA
 
dictionary SCHEMA_BASE
 

Detailed Description

Support for MQTT message handling.

Variable Documentation

◆ MQTT_BASE_SCHEMA

homeassistant.components.mqtt.config.MQTT_BASE_SCHEMA = vol.Schema(SCHEMA_BASE)

Definition at line 28 of file config.py.

◆ MQTT_RO_SCHEMA

homeassistant.components.mqtt.config.MQTT_RO_SCHEMA
Initial value:
1 = MQTT_BASE_SCHEMA.extend(
2  {
3  vol.Required(CONF_STATE_TOPIC): valid_subscribe_topic,
4  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
5  }
6 )

Definition at line 31 of file config.py.

◆ MQTT_RW_SCHEMA

homeassistant.components.mqtt.config.MQTT_RW_SCHEMA
Initial value:
1 = MQTT_BASE_SCHEMA.extend(
2  {
3  vol.Required(CONF_COMMAND_TOPIC): valid_publish_topic,
4  vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
5  vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
6  vol.Optional(CONF_STATE_TOPIC): valid_subscribe_topic,
7  }
8 )

Definition at line 39 of file config.py.

◆ SCHEMA_BASE

dictionary homeassistant.components.mqtt.config.SCHEMA_BASE
Initial value:
1 = {
2  vol.Optional(CONF_QOS, default=DEFAULT_QOS): valid_qos_schema,
3  vol.Optional(CONF_ENCODING, default=DEFAULT_ENCODING): cv.string,
4 }

Definition at line 23 of file config.py.