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

Functions

CALLBACK_TYPE async_attach_trigger (HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 TRIGGER_SCHEMA
 

Detailed Description

Offer MQTT listening automation rules.

Function Documentation

◆ async_attach_trigger()

CALLBACK_TYPE homeassistant.components.mqtt.trigger.async_attach_trigger ( HomeAssistant  hass,
ConfigType  config,
TriggerActionType  action,
TriggerInfo  trigger_info 
)
Listen for state changes based on configuration.

Definition at line 61 of file trigger.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.mqtt.trigger._LOGGER = logging.getLogger(__name__)
private

Definition at line 58 of file trigger.py.

◆ TRIGGER_SCHEMA

homeassistant.components.mqtt.trigger.TRIGGER_SCHEMA
Initial value:
1 = cv.TRIGGER_BASE_SCHEMA.extend(
2  {
3  vol.Required(CONF_PLATFORM): DOMAIN,
4  vol.Required(CONF_TOPIC): valid_subscribe_topic_template,
5  vol.Optional(CONF_PAYLOAD): cv.template,
6  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
7  vol.Optional(CONF_ENCODING, default=DEFAULT_ENCODING): cv.string,
8  vol.Optional(CONF_QOS, default=DEFAULT_QOS): vol.All(
9  vol.Coerce(int), vol.In([0, 1, 2])
10  ),
11  }
12 )

Definition at line 45 of file trigger.py.