homeassistant.components.mqtt.device_trigger Namespace Reference

Classes
class	MqttDeviceTrigger
class	Trigger
class	TriggerInstance

Functions
CALLBACK_TYPE	async_attach_trigger (HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info)
list[dict[str, str]]	async_get_triggers (HomeAssistant hass, str device_id)
None	async_removed_from_device (HomeAssistant hass, str device_id)
None	async_setup_trigger (HomeAssistant hass, ConfigType config, ConfigEntry config_entry, DiscoveryInfoType discovery_data)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_AUTOMATION_TYPE = "automation_type"
string	CONF_DISCOVERY_ID = "discovery_id"
string	CONF_SUBTYPE = "subtype"
string	DEFAULT_ENCODING = "utf-8"
string	DEVICE = "device"
string	LOG_NAME = "Device trigger"
dictionary	MQTT_TRIGGER_BASE
	TRIGGER_DISCOVERY_SCHEMA
	TRIGGER_SCHEMA

Detailed Description

Provides device automations for MQTT.

Function Documentation

async_attach_trigger()

CALLBACK_TYPE homeassistant.components.mqtt.device_trigger.async_attach_trigger	(	HomeAssistant	hass,
		ConfigType	config,
		TriggerActionType	action,
		TriggerInfo	trigger_info
	)

Attach a trigger.

Definition at line 368 of file device_trigger.py.

async_get_triggers()

list[dict[str, str]] homeassistant.components.mqtt.device_trigger.async_get_triggers	(	HomeAssistant	hass,
		str	device_id
	)

List device triggers for MQTT devices.

Definition at line 347 of file device_trigger.py.

async_removed_from_device()

None homeassistant.components.mqtt.device_trigger.async_removed_from_device	(	HomeAssistant	hass,
		str	device_id
	)

Handle Mqtt removed from a device.

Definition at line 331 of file device_trigger.py.

async_setup_trigger()

None homeassistant.components.mqtt.device_trigger.async_setup_trigger	(	HomeAssistant	hass,
		ConfigType	config,
		ConfigEntry	config_entry,
		DiscoveryInfoType	discovery_data
	)

Set up the MQTT device trigger.

Definition at line 289 of file device_trigger.py.

Variable Documentation

_LOGGER

homeassistant.components.mqtt.device_trigger._LOGGER = logging.getLogger(__name__)

private

Definition at line 43 of file device_trigger.py.

CONF_AUTOMATION_TYPE

string homeassistant.components.mqtt.device_trigger.CONF_AUTOMATION_TYPE = "automation_type"

Definition at line 45 of file device_trigger.py.

CONF_DISCOVERY_ID

string homeassistant.components.mqtt.device_trigger.CONF_DISCOVERY_ID = "discovery_id"

Definition at line 46 of file device_trigger.py.

CONF_SUBTYPE

string homeassistant.components.mqtt.device_trigger.CONF_SUBTYPE = "subtype"

Definition at line 47 of file device_trigger.py.

DEFAULT_ENCODING

string homeassistant.components.mqtt.device_trigger.DEFAULT_ENCODING = "utf-8"

Definition at line 48 of file device_trigger.py.

DEVICE

string homeassistant.components.mqtt.device_trigger.DEVICE = "device"

Definition at line 49 of file device_trigger.py.

LOG_NAME

string homeassistant.components.mqtt.device_trigger.LOG_NAME = "Device trigger"

Definition at line 84 of file device_trigger.py.

MQTT_TRIGGER_BASE

dictionary homeassistant.components.mqtt.device_trigger.MQTT_TRIGGER_BASE

Initial value:

=  {
    # Trigger when MQTT message is received
    CONF_PLATFORM: DEVICE,
    CONF_DOMAIN: DOMAIN,
}

Definition at line 51 of file device_trigger.py.

TRIGGER_DISCOVERY_SCHEMA

homeassistant.components.mqtt.device_trigger.TRIGGER_DISCOVERY_SCHEMA

Initial value:

=  MQTT_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_AUTOMATION_TYPE): str,
        vol.Required(CONF_DEVICE): MQTT_ENTITY_DEVICE_INFO_SCHEMA,
        vol.Optional(CONF_PAYLOAD, default=None): vol.Any(None, cv.string),
        vol.Required(CONF_SUBTYPE): cv.string,
        vol.Required(CONF_TOPIC): cv.string,
        vol.Required(CONF_TYPE): cv.string,
        vol.Optional(CONF_VALUE_TEMPLATE, default=None): vol.Any(None, cv.string),
    },
    extra=vol.REMOVE_EXTRA,
)

Definition at line 71 of file device_trigger.py.

TRIGGER_SCHEMA

homeassistant.components.mqtt.device_trigger.TRIGGER_SCHEMA

Initial value:

=  DEVICE_TRIGGER_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_PLATFORM): DEVICE,
        vol.Required(CONF_DOMAIN): DOMAIN,
        vol.Required(CONF_DEVICE_ID): str,
        # The use of CONF_DISCOVERY_ID was deprecated in HA Core 2024.2.
        # By default, a MQTT device trigger now will be referenced by
        # device_id, type and subtype instead.
        vol.Optional(CONF_DISCOVERY_ID): str,
        vol.Required(CONF_TYPE): cv.string,
        vol.Required(CONF_SUBTYPE): cv.string,
    },
)

Definition at line 57 of file device_trigger.py.