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

Public Member Functions

None async_lock (self, **Any kwargs)
 
None async_open (self, **Any kwargs)
 
None async_unlock (self, **Any kwargs)
 
str|None code_format (self)
 
None send_device_command (self, clusters.ClusterCommand command, int timed_request_timeout_ms=1000)
 
- Public Member Functions inherited from homeassistant.components.matter.entity.MatterEntity
None __init__ (self, MatterClient matter_client, MatterEndpoint endpoint, MatterEntityInfo entity_info)
 
None async_added_to_hass (self)
 
str get_matter_attribute_path (self, type[ClusterAttributeDescriptor] attribute)
 
Any get_matter_attribute_value (self, type[ClusterAttributeDescriptor] attribute, bool null_as_none=True)
 
str|UndefinedType|None name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (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_removed_from_registry (self)
 
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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (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)
 
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.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)
 
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 Attributes

 None
 
- Static Public Attributes inherited from homeassistant.components.matter.entity.MatterEntity
 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
 

Private Member Functions

None _calculate_features (self)
 
None _reset_optimistic_state (self, bool write_state=True)
 
None _update_from_device (self)
 

Private Attributes

 _attr_is_locked
 
 _attr_is_locking
 
 _attr_is_open
 
 _attr_is_opening
 
 _attr_is_unlocking
 
 _attr_supported_features
 
 _feature_map
 
 _optimistic_timer
 

Static Private Attributes

string _platform_translation_key = "lock"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.matter.entity.MatterEntity
 entity_description
 
 matter_client
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Representation of a Matter lock.

Definition at line 38 of file lock.py.

Member Function Documentation

◆ _calculate_features()

None homeassistant.components.matter.lock.MatterLock._calculate_features (   self)
private
Calculate features for HA Lock platform from Matter FeatureMap.

Definition at line 181 of file lock.py.

◆ _reset_optimistic_state()

None homeassistant.components.matter.lock.MatterLock._reset_optimistic_state (   self,
bool   write_state = True 
)
private

Definition at line 170 of file lock.py.

◆ _update_from_device()

None homeassistant.components.matter.lock.MatterLock._update_from_device (   self)
private
Update the entity from the device.

Reimplemented from homeassistant.components.matter.entity.MatterEntity.

Definition at line 137 of file lock.py.

◆ async_lock()

None homeassistant.components.matter.lock.MatterLock.async_lock (   self,
**Any  kwargs 
)
Lock the lock with pin if needed.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 78 of file lock.py.

◆ async_open()

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

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 120 of file lock.py.

◆ async_unlock()

None homeassistant.components.matter.lock.MatterLock.async_unlock (   self,
**Any  kwargs 
)
Unlock the lock with pin if needed.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 95 of file lock.py.

◆ code_format()

str | None homeassistant.components.matter.lock.MatterLock.code_format (   self)
Regex for code format or None if no code is required.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 46 of file lock.py.

◆ send_device_command()

None homeassistant.components.matter.lock.MatterLock.send_device_command (   self,
clusters.ClusterCommand  command,
int   timed_request_timeout_ms = 1000 
)
Send a command to the device.

Definition at line 65 of file lock.py.

Member Data Documentation

◆ _attr_is_locked

homeassistant.components.matter.lock.MatterLock._attr_is_locked
private

Definition at line 152 of file lock.py.

◆ _attr_is_locking

homeassistant.components.matter.lock.MatterLock._attr_is_locking
private

Definition at line 82 of file lock.py.

◆ _attr_is_open

homeassistant.components.matter.lock.MatterLock._attr_is_open
private

Definition at line 153 of file lock.py.

◆ _attr_is_opening

homeassistant.components.matter.lock.MatterLock._attr_is_opening
private

Definition at line 123 of file lock.py.

◆ _attr_is_unlocking

homeassistant.components.matter.lock.MatterLock._attr_is_unlocking
private

Definition at line 99 of file lock.py.

◆ _attr_supported_features

homeassistant.components.matter.lock.MatterLock._attr_supported_features
private

Definition at line 197 of file lock.py.

◆ _feature_map

homeassistant.components.matter.lock.MatterLock._feature_map
private

Definition at line 190 of file lock.py.

◆ _optimistic_timer

homeassistant.components.matter.lock.MatterLock._optimistic_timer
private

Definition at line 86 of file lock.py.

◆ _platform_translation_key

string homeassistant.components.matter.lock.MatterLock._platform_translation_key = "lock"
staticprivate

Definition at line 43 of file lock.py.

◆ None

homeassistant.components.matter.lock.MatterLock.None
static

Definition at line 41 of file lock.py.


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