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

Public Member Functions

None async_lock (self, **Any kwargs)
 
None async_open (self, **Any kwargs)
 
None async_unlock (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntity
None __init__ (self, HomeAssistant hass, ConfigType config, ConfigEntry config_entry, DiscoveryInfoType|None discovery_data)
 
bool add_subscription (self, str state_topic_config_key, Callable[[ReceiveMessage], None] msg_callback, set[str]|None tracked_attributes, bool disable_encoding=False)
 
None async_added_to_hass (self)
 
None async_publish (self, str topic, PublishPayloadType payload, int qos=0, bool retain=False, str|None encoding=DEFAULT_ENCODING)
 
None async_publish_with_config (self, str topic, PublishPayloadType payload)
 
None async_will_remove_from_hass (self)
 
None discovery_update (self, MQTTDiscoveryPayload discovery_payload)
 
None mqtt_async_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttAttributesMixin
None __init__ (self, ConfigType config)
 
None attributes_discovery_update (self, DiscoveryInfoType config)
 
None attributes_prepare_discovery_update (self, DiscoveryInfoType config)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_remove (self, *bool force_remove=False)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttAvailabilityMixin
None __init__ (self, ConfigType config)
 
None async_mqtt_connection_state_changed (self, bool state)
 
None availability_discovery_update (self, DiscoveryInfoType config)
 
None availability_prepare_discovery_update (self, DiscoveryInfoType config)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin
None __init__ (self, HomeAssistant hass, DiscoveryInfoType|None discovery_data, Callable[[MQTTDiscoveryPayload], Coroutine[Any, Any, None]]|None discovery_update=None)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None async_removed_from_registry (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntityDeviceInfo
None __init__ (self, dict[str, Any]|None specifications, ConfigEntry config_entry)
 
DeviceInfo|None device_info (self)
 
None device_info_discovery_update (self, DiscoveryInfoType config)
 
- Public Member Functions inherited from homeassistant.components.lock.LockEntity
dict[Any, Any] add_default_code (self, dict[Any, Any] data)
 
None async_handle_lock_service (self, **Any kwargs)
 
None async_handle_open_service (self, **Any kwargs)
 
None async_handle_unlock_service (self, **Any kwargs)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
str|None changed_by (self)
 
str|None code_format (self)
 
re.Pattern[str]|None code_format_cmp (self)
 
bool|None is_jammed (self)
 
bool|None is_locked (self)
 
bool|None is_locking (self)
 
bool|None is_open (self)
 
bool|None is_opening (self)
 
bool|None is_unlocking (self)
 
None lock (self, **Any kwargs)
 
None open (self, **Any kwargs)
 
str|None state (self)
 
dict[str, StateTypestate_attributes (self)
 
LockEntityFeature supported_features (self)
 
None unlock (self, **Any kwargs)
 

Static Public Member Functions

vol.Schema config_schema ()
 

Private Member Functions

None _message_received (self, ReceiveMessage msg)
 
None _prepare_subscribe_topics (self)
 
None _setup_from_config (self, ConfigType config)
 
None _subscribe_topics (self)
 

Private Attributes

 _attr_assumed_state
 
 _attr_code_format
 
 _attr_is_jammed
 
 _attr_is_locked
 
 _attr_is_locking
 
 _attr_is_open
 
 _attr_is_opening
 
 _attr_is_unlocking
 
 _attr_supported_features
 
 _command_template
 
 _compiled_pattern
 
 _optimistic
 
 _valid_states
 
 _value_template
 

Static Private Attributes

 _attributes_extra_blocked = MQTT_LOCK_ATTRIBUTES_BLOCKED
 
 _default_name = DEFAULT_NAME
 
 _entity_id_format = lock.ENTITY_ID_FORMAT
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.mqtt.entity.MqttEntity
 hass
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.mqtt.entity.MqttAttributesMixin
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.lock.LockEntity
 LockEntityFeature
 
 None
 
 str
 

Detailed Description

Representation of a lock that can be toggled using MQTT.

Definition at line 133 of file lock.py.

Member Function Documentation

◆ _message_received()

None homeassistant.components.mqtt.lock.MqttLock._message_received (   self,
ReceiveMessage  msg 
)
private
Handle new lock state messages.

Definition at line 184 of file lock.py.

◆ _prepare_subscribe_topics()

None homeassistant.components.mqtt.lock.MqttLock._prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 206 of file lock.py.

◆ _setup_from_config()

None homeassistant.components.mqtt.lock.MqttLock._setup_from_config (   self,
ConfigType  config 
)
private
(Re)Setup the entity.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 153 of file lock.py.

◆ _subscribe_topics()

None homeassistant.components.mqtt.lock.MqttLock._subscribe_topics (   self)
private
(Re)Subscribe to topics.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 221 of file lock.py.

◆ async_lock()

None homeassistant.components.mqtt.lock.MqttLock.async_lock (   self,
**Any  kwargs 
)
Lock the device.

This method is a coroutine.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 225 of file lock.py.

◆ async_open()

None homeassistant.components.mqtt.lock.MqttLock.async_open (   self,
**Any  kwargs 
)
Open the door latch.

This method is a coroutine.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 255 of file lock.py.

◆ async_unlock()

None homeassistant.components.mqtt.lock.MqttLock.async_unlock (   self,
**Any  kwargs 
)
Unlock the device.

This method is a coroutine.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 240 of file lock.py.

◆ config_schema()

vol.Schema homeassistant.components.mqtt.lock.MqttLock.config_schema ( )
static
Return the config schema.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 149 of file lock.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.mqtt.lock.MqttLock._attr_assumed_state
private

Definition at line 161 of file lock.py.

◆ _attr_code_format

homeassistant.components.mqtt.lock.MqttLock._attr_code_format
private

Definition at line 164 of file lock.py.

◆ _attr_is_jammed

homeassistant.components.mqtt.lock.MqttLock._attr_is_jammed
private

Definition at line 203 of file lock.py.

◆ _attr_is_locked

homeassistant.components.mqtt.lock.MqttLock._attr_is_locked
private

Definition at line 159 of file lock.py.

◆ _attr_is_locking

homeassistant.components.mqtt.lock.MqttLock._attr_is_locking
private

Definition at line 199 of file lock.py.

◆ _attr_is_open

homeassistant.components.mqtt.lock.MqttLock._attr_is_open
private

Definition at line 200 of file lock.py.

◆ _attr_is_opening

homeassistant.components.mqtt.lock.MqttLock._attr_is_opening
private

Definition at line 201 of file lock.py.

◆ _attr_is_unlocking

homeassistant.components.mqtt.lock.MqttLock._attr_is_unlocking
private

Definition at line 202 of file lock.py.

◆ _attr_supported_features

homeassistant.components.mqtt.lock.MqttLock._attr_supported_features
private

Definition at line 177 of file lock.py.

◆ _attributes_extra_blocked

homeassistant.components.mqtt.lock.MqttLock._attributes_extra_blocked = MQTT_LOCK_ATTRIBUTES_BLOCKED
staticprivate

Definition at line 138 of file lock.py.

◆ _command_template

homeassistant.components.mqtt.lock.MqttLock._command_template
private

Definition at line 168 of file lock.py.

◆ _compiled_pattern

homeassistant.components.mqtt.lock.MqttLock._compiled_pattern
private

Definition at line 163 of file lock.py.

◆ _default_name

homeassistant.components.mqtt.lock.MqttLock._default_name = DEFAULT_NAME
staticprivate

Definition at line 136 of file lock.py.

◆ _entity_id_format

homeassistant.components.mqtt.lock.MqttLock._entity_id_format = lock.ENTITY_ID_FORMAT
staticprivate

Definition at line 137 of file lock.py.

◆ _optimistic

homeassistant.components.mqtt.lock.MqttLock._optimistic
private

Definition at line 160 of file lock.py.

◆ _valid_states

homeassistant.components.mqtt.lock.MqttLock._valid_states
private

Definition at line 181 of file lock.py.

◆ _value_template

homeassistant.components.mqtt.lock.MqttLock._value_template
private

Definition at line 172 of file lock.py.


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