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

Public Member Functions

None __init__ (self, str name, str state, bool openable=False, bool jam_on_operation=False)
 
None async_lock (self, **Any kwargs)
 
None async_open (self, **Any kwargs)
 
None async_unlock (self, **Any kwargs)
 
bool is_jammed (self)
 
bool is_locked (self)
 
bool is_locking (self)
 
bool is_open (self)
 
bool is_opening (self)
 
bool is_unlocking (self)
 
- 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)
 
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)
 
- 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_added_to_hass (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)
 
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)
 

Private Attributes

 _attr_name
 
 _attr_supported_features
 
 _jam_on_operation
 
 _openable
 
 _state
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- 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.lock.LockEntity
 LockEntityFeature
 
 None
 
 str
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Demo lock.

Definition at line 32 of file lock.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.demo.lock.DemoLock.__init__ (   self,
str  name,
str  state,
bool   openable = False,
bool   jam_on_operation = False 
)
Initialize the lock.

Definition at line 37 of file lock.py.

Member Function Documentation

◆ async_lock()

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

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 82 of file lock.py.

◆ async_open()

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

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 101 of file lock.py.

◆ async_unlock()

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

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 93 of file lock.py.

◆ is_jammed()

bool homeassistant.components.demo.lock.DemoLock.is_jammed (   self)
Return true if lock is jammed.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 63 of file lock.py.

◆ is_locked()

bool homeassistant.components.demo.lock.DemoLock.is_locked (   self)
Return true if lock is locked.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 68 of file lock.py.

◆ is_locking()

bool homeassistant.components.demo.lock.DemoLock.is_locking (   self)
Return true if lock is locking.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 53 of file lock.py.

◆ is_open()

bool homeassistant.components.demo.lock.DemoLock.is_open (   self)
Return true if lock is open.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 73 of file lock.py.

◆ is_opening()

bool homeassistant.components.demo.lock.DemoLock.is_opening (   self)
Return true if lock is opening.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 78 of file lock.py.

◆ is_unlocking()

bool homeassistant.components.demo.lock.DemoLock.is_unlocking (   self)
Return true if lock is unlocking.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 58 of file lock.py.

Member Data Documentation

◆ _attr_name

homeassistant.components.demo.lock.DemoLock._attr_name
private

Definition at line 45 of file lock.py.

◆ _attr_should_poll

bool homeassistant.components.demo.lock.DemoLock._attr_should_poll = False
staticprivate

Definition at line 35 of file lock.py.

◆ _attr_supported_features

homeassistant.components.demo.lock.DemoLock._attr_supported_features
private

Definition at line 47 of file lock.py.

◆ _jam_on_operation

homeassistant.components.demo.lock.DemoLock._jam_on_operation
private

Definition at line 50 of file lock.py.

◆ _openable

homeassistant.components.demo.lock.DemoLock._openable
private

Definition at line 49 of file lock.py.

◆ _state

homeassistant.components.demo.lock.DemoLock._state
private

Definition at line 48 of file lock.py.


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