homeassistant.components.mqtt.schemas Namespace Reference

Functions
dict[str, Any]	check_unique_id (dict[str, Any] config)
ConfigType	validate_device_has_at_least_one_identifier (ConfigType value)

Variables
	_COMPONENT_CONFIG_SCHEMA
	_MQTT_AVAILABILITY_LIST_SCHEMA
	_MQTT_AVAILABILITY_SCHEMA
	_MQTT_AVAILABILITY_SINGLE_SCHEMA
	_UNIQUE_ID_SCHEMA
	DEVICE_DISCOVERY_SCHEMA
	MQTT_ENTITY_COMMON_SCHEMA
	MQTT_ENTITY_DEVICE_INFO_SCHEMA
	MQTT_ORIGIN_INFO_SCHEMA
list	SHARED_OPTIONS

Detailed Description

Shared schemas for MQTT discovery and YAML config items.

Function Documentation

check_unique_id()

dict[str, Any] homeassistant.components.mqtt.schemas.check_unique_id

(

dict[str, Any]

config

)

Check if a unique ID is set in case an entity platform is configured.

Definition at line 193 of file schemas.py.

validate_device_has_at_least_one_identifier()

ConfigType homeassistant.components.mqtt.schemas.validate_device_has_at_least_one_identifier

(

ConfigType

value

)

Validate that a device info entry has at least one identifying value.

Definition at line 127 of file schemas.py.

Variable Documentation

_COMPONENT_CONFIG_SCHEMA

homeassistant.components.mqtt.schemas._COMPONENT_CONFIG_SCHEMA

private

Initial value:

=  vol.All(
    vol.Schema(
        {vol.Required(CONF_PLATFORM): vol.In(SUPPORTED_COMPONENTS)},
    ).extend({}, extra=True),
    check_unique_id,
)

Definition at line 201 of file schemas.py.

_MQTT_AVAILABILITY_LIST_SCHEMA

homeassistant.components.mqtt.schemas._MQTT_AVAILABILITY_LIST_SCHEMA

private

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_AVAILABILITY_MODE, default=AVAILABILITY_LATEST): vol.All(
            cv.string, vol.In(AVAILABILITY_MODES)
        ),
        vol.Exclusive(CONF_AVAILABILITY, "availability"): vol.All(
            cv.ensure_list,
            [
                {
                    vol.Required(CONF_TOPIC): valid_subscribe_topic,
                    vol.Optional(
                        CONF_PAYLOAD_AVAILABLE, default=DEFAULT_PAYLOAD_AVAILABLE
                    ): cv.string,
                    vol.Optional(
                        CONF_PAYLOAD_NOT_AVAILABLE,
                        default=DEFAULT_PAYLOAD_NOT_AVAILABLE,
                    ): cv.string,
                    vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
                }
            ],
        ),
    }
)

Definition at line 98 of file schemas.py.

_MQTT_AVAILABILITY_SCHEMA

homeassistant.components.mqtt.schemas._MQTT_AVAILABILITY_SCHEMA

private

Initial value:

=  _MQTT_AVAILABILITY_SINGLE_SCHEMA.extend(
    _MQTT_AVAILABILITY_LIST_SCHEMA.schema
)

Definition at line 122 of file schemas.py.

_MQTT_AVAILABILITY_SINGLE_SCHEMA

homeassistant.components.mqtt.schemas._MQTT_AVAILABILITY_SINGLE_SCHEMA

private

Initial value:

=  vol.Schema(
    {
        vol.Exclusive(CONF_AVAILABILITY_TOPIC, "availability"): valid_subscribe_topic,
        vol.Optional(CONF_AVAILABILITY_TEMPLATE): cv.template,
        vol.Optional(
            CONF_PAYLOAD_AVAILABLE, default=DEFAULT_PAYLOAD_AVAILABLE
        ): cv.string,
        vol.Optional(
            CONF_PAYLOAD_NOT_AVAILABLE, default=DEFAULT_PAYLOAD_NOT_AVAILABLE
        ): cv.string,
    }
)

Definition at line 85 of file schemas.py.

_UNIQUE_ID_SCHEMA

homeassistant.components.mqtt.schemas._UNIQUE_ID_SCHEMA

private

Initial value:

=  vol.Schema(
    {vol.Required(CONF_UNIQUE_ID): cv.string},
).extend({}, extra=True)

Definition at line 188 of file schemas.py.

DEVICE_DISCOVERY_SCHEMA

homeassistant.components.mqtt.schemas.DEVICE_DISCOVERY_SCHEMA

Initial value:

=  _MQTT_AVAILABILITY_SCHEMA.extend(
    {
        vol.Required(CONF_DEVICE): MQTT_ENTITY_DEVICE_INFO_SCHEMA,
        vol.Required(CONF_COMPONENTS): vol.Schema({str: _COMPONENT_CONFIG_SCHEMA}),
        vol.Required(CONF_ORIGIN): MQTT_ORIGIN_INFO_SCHEMA,
        vol.Optional(CONF_STATE_TOPIC): valid_subscribe_topic,
        vol.Optional(CONF_COMMAND_TOPIC): valid_publish_topic,
        vol.Optional(CONF_QOS): valid_qos_schema,
        vol.Optional(CONF_ENCODING): cv.string,
    }
)

Definition at line 208 of file schemas.py.

MQTT_ENTITY_COMMON_SCHEMA

homeassistant.components.mqtt.schemas.MQTT_ENTITY_COMMON_SCHEMA

Initial value:

=  _MQTT_AVAILABILITY_SCHEMA.extend(
    {
        vol.Optional(CONF_DEVICE): MQTT_ENTITY_DEVICE_INFO_SCHEMA,
        vol.Optional(CONF_ENTITY_PICTURE): cv.url,
        vol.Optional(CONF_ORIGIN): MQTT_ORIGIN_INFO_SCHEMA,
        vol.Optional(CONF_ENABLED_BY_DEFAULT, default=True): cv.boolean,
        vol.Optional(CONF_ENTITY_CATEGORY): ENTITY_CATEGORIES_SCHEMA,
        vol.Optional(CONF_ICON): cv.icon,
        vol.Optional(CONF_JSON_ATTRS_TOPIC): valid_subscribe_topic,
        vol.Optional(CONF_JSON_ATTRS_TEMPLATE): cv.template,
        vol.Optional(CONF_OBJECT_ID): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
)

Definition at line 173 of file schemas.py.

MQTT_ENTITY_DEVICE_INFO_SCHEMA

homeassistant.components.mqtt.schemas.MQTT_ENTITY_DEVICE_INFO_SCHEMA

Initial value:

=  vol.All(
    cv.deprecated(CONF_DEPRECATED_VIA_HUB, CONF_VIA_DEVICE),
    vol.Schema(
        {
            vol.Optional(CONF_IDENTIFIERS, default=list): vol.All(
                cv.ensure_list, [cv.string]
            ),
            vol.Optional(CONF_CONNECTIONS, default=list): vol.All(
                cv.ensure_list, [vol.All(vol.Length(2), [cv.string])]
            ),
            vol.Optional(CONF_MANUFACTURER): cv.string,
            vol.Optional(CONF_MODEL): cv.string,
            vol.Optional(CONF_MODEL_ID): cv.string,
            vol.Optional(CONF_NAME): cv.string,
            vol.Optional(CONF_HW_VERSION): cv.string,
            vol.Optional(CONF_SERIAL_NUMBER): cv.string,
            vol.Optional(CONF_SW_VERSION): cv.string,
            vol.Optional(CONF_VIA_DEVICE): cv.string,
            vol.Optional(CONF_SUGGESTED_AREA): cv.string,
            vol.Optional(CONF_CONFIGURATION_URL): cv.configuration_url,
        }
    ),
    validate_device_has_at_least_one_identifier,
)

Definition at line 137 of file schemas.py.

MQTT_ORIGIN_INFO_SCHEMA

homeassistant.components.mqtt.schemas.MQTT_ORIGIN_INFO_SCHEMA

Initial value:

=  vol.All(
    vol.Schema(
        {
            vol.Required(CONF_NAME): cv.string,
            vol.Optional(CONF_SW_VERSION): cv.string,
            vol.Optional(CONF_SUPPORT_URL): cv.configuration_url,
        }
    ),
)

Definition at line 75 of file schemas.py.

SHARED_OPTIONS

list homeassistant.components.mqtt.schemas.SHARED_OPTIONS

Initial value:

=  [
    CONF_AVAILABILITY,
    CONF_AVAILABILITY_MODE,
    CONF_AVAILABILITY_TEMPLATE,
    CONF_AVAILABILITY_TOPIC,
    CONF_COMMAND_TOPIC,
    CONF_PAYLOAD_AVAILABLE,
    CONF_PAYLOAD_NOT_AVAILABLE,
    CONF_STATE_TOPIC,
]

Definition at line 64 of file schemas.py.