Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger Class Reference
Inheritance diagram for homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger:
[legend]
Collaboration diagram for homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigType config, str device_id, DiscoveryInfoType discovery_data, ConfigEntry config_entry)
 
None async_setup (self)
 
None async_tear_down (self)
 
None async_update (self, MQTTDiscoveryPayload discovery_data)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttDiscoveryDeviceUpdateMixin
None __init__ (self, HomeAssistant hass, DiscoveryInfoType discovery_data, str|None device_id, ConfigEntry config_entry, str log_name)
 
None async_discovery_update (self, MQTTDiscoveryPayload discovery_payload)
 

Public Attributes

 device_id
 
 discovery_data
 
 hass
 
 trigger_id
 
- Public Attributes inherited from homeassistant.components.mqtt.entity.MqttDiscoveryDeviceUpdateMixin
 hass
 
 log_name
 

Private Attributes

 _config
 
 _config_entry
 
 _mqtt_data
 

Detailed Description

Setup a MQTT device trigger with auto discovery.

Definition at line 188 of file device_trigger.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger.__init__ (   self,
HomeAssistant  hass,
ConfigType  config,
str  device_id,
DiscoveryInfoType  discovery_data,
ConfigEntry  config_entry 
)
Initialize.

Definition at line 191 of file device_trigger.py.

Member Function Documentation

◆ async_setup()

None homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger.async_setup (   self)
Initialize the device trigger.

Definition at line 217 of file device_trigger.py.

◆ async_tear_down()

None homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger.async_tear_down (   self)
Cleanup device trigger.

Reimplemented from homeassistant.components.mqtt.entity.MqttDiscoveryDeviceUpdateMixin.

Definition at line 278 of file device_trigger.py.

◆ async_update()

None homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger.async_update (   self,
MQTTDiscoveryPayload  discovery_data 
)
Handle MQTT device trigger discovery updates.

Reimplemented from homeassistant.components.mqtt.entity.MqttDiscoveryDeviceUpdateMixin.

Definition at line 249 of file device_trigger.py.

Member Data Documentation

◆ _config

homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger._config
private

Definition at line 200 of file device_trigger.py.

◆ _config_entry

homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger._config_entry
private

Definition at line 201 of file device_trigger.py.

◆ _mqtt_data

homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger._mqtt_data
private

Definition at line 205 of file device_trigger.py.

◆ device_id

homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger.device_id

Definition at line 202 of file device_trigger.py.

◆ discovery_data

homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger.discovery_data

Definition at line 203 of file device_trigger.py.

◆ hass

homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger.hass

Definition at line 204 of file device_trigger.py.

◆ trigger_id

homeassistant.components.mqtt.device_trigger.MqttDeviceTrigger.trigger_id

Definition at line 206 of file device_trigger.py.


The documentation for this class was generated from the following file: