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

Public Member Functions

None async_clear_lock_usercode (self, int code_slot)
 
None async_lock (self, **Any kwargs)
 
None async_set_lock_configuration (self, OperationType operation_type, int|None lock_timeout=None, int|None auto_relock_time=None, int|None hold_and_release_time=None, bool|None twist_assist=None, bool|None block_to_block=None)
 
None async_set_lock_usercode (self, int code_slot, str usercode)
 
None async_unlock (self, **Any kwargs)
 
bool|None is_locked (self)
 
- Public Member Functions inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
None __init__ (self, ConfigEntry config_entry, Driver driver, ZwaveDiscoveryInfo info)
 
None async_added_to_hass (self)
 
None async_poll_value (self, bool refresh_all_values)
 
bool available (self)
 
str generate_name (self, bool include_value_name=False, str|None alternate_value_name=None, Sequence[str|None]|None additional_info=None, str|None name_prefix=None)
 
ZwaveValue|None get_zwave_value (self, str|int value_property, int|None command_class=None, int|None endpoint=None, int|str|None value_property_key=None, bool add_to_watched_value_ids=True, bool check_all_endpoints=False)
 
None on_value_update (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_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
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)
 
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)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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)
 

Private Member Functions

None _set_lock_state (self, LockState target_state, **Any kwargs)
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
 config_entry
 
 driver
 
 info
 
 watched_value_ids
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Z-Wave lock.

Definition at line 124 of file lock.py.

Member Function Documentation

◆ _set_lock_state()

None homeassistant.components.zwave_js.lock.ZWaveLock._set_lock_state (   self,
LockState  target_state,
**Any  kwargs 
)
private
Set the lock state.

Definition at line 142 of file lock.py.

◆ async_clear_lock_usercode()

None homeassistant.components.zwave_js.lock.ZWaveLock.async_clear_lock_usercode (   self,
int  code_slot 
)
Clear the usercode at index X on the lock.

Definition at line 174 of file lock.py.

◆ async_lock()

None homeassistant.components.zwave_js.lock.ZWaveLock.async_lock (   self,
**Any  kwargs 
)
Lock the lock.

Definition at line 155 of file lock.py.

◆ async_set_lock_configuration()

None homeassistant.components.zwave_js.lock.ZWaveLock.async_set_lock_configuration (   self,
OperationType  operation_type,
int | None   lock_timeout = None,
int | None   auto_relock_time = None,
int | None   hold_and_release_time = None,
bool | None   twist_assist = None,
bool | None   block_to_block = None 
)
Set the lock configuration.

Definition at line 187 of file lock.py.

◆ async_set_lock_usercode()

None homeassistant.components.zwave_js.lock.ZWaveLock.async_set_lock_usercode (   self,
int  code_slot,
str  usercode 
)
Set the usercode to index X on the lock.

Definition at line 163 of file lock.py.

◆ async_unlock()

None homeassistant.components.zwave_js.lock.ZWaveLock.async_unlock (   self,
**Any  kwargs 
)
Unlock the lock.

Definition at line 159 of file lock.py.

◆ is_locked()

bool | None homeassistant.components.zwave_js.lock.ZWaveLock.is_locked (   self)
Return true if the lock is locked.

Definition at line 128 of file lock.py.


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