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

Public Member Functions

None __init__ (self, VerisureDataUpdateCoordinator coordinator, str serial_number)
 
None async_lock (self, **Any kwargs)
 
None async_set_lock_state (self, str code, LockState state)
 
None async_unlock (self, **Any kwargs)
 
bool available (self)
 
str|None changed_by (self)
 
str changed_method (self)
 
str code_format (self)
 
DeviceInfo device_info (self)
 
None disable_autolock (self)
 
None enable_autolock (self)
 
dict[str, strextra_state_attributes (self)
 
bool is_locked (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.verisure.coordinator.VerisureDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, ConfigEntry entry)
 
bool async_login (self)
 
None smartcam_capture (self, str device_id)
 
None update_smartcam_imageseries (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- 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_open (self, **Any kwargs)
 
None async_registry_entry_updated (self)
 
re.Pattern[str]|None code_format_cmp (self)
 
bool|None is_jammed (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)
 
- 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)
 
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)
 
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 Attributes

 serial_number
 
- Public Attributes inherited from homeassistant.components.verisure.coordinator.VerisureDataUpdateCoordinator
 entry
 
 imageseries
 
 verisure
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _attr_unique_id
 
 _state
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 

Additional Inherited Members

- 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 Verisure doorlock.

Definition at line 59 of file lock.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.verisure.lock.VerisureDoorlock.__init__ (   self,
VerisureDataUpdateCoordinator  coordinator,
str   serial_number 
)
Initialize the Verisure lock.

Definition at line 65 of file lock.py.

Member Function Documentation

◆ async_lock()

None homeassistant.components.verisure.lock.VerisureDoorlock.async_lock (   self,
**Any  kwargs 
)
Send lock command.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 135 of file lock.py.

◆ async_set_lock_state()

None homeassistant.components.verisure.lock.VerisureDoorlock.async_set_lock_state (   self,
str  code,
LockState  state 
)
Send set lock state command.

Definition at line 141 of file lock.py.

◆ async_unlock()

None homeassistant.components.verisure.lock.VerisureDoorlock.async_unlock (   self,
**Any  kwargs 
)
Send unlock command.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 129 of file lock.py.

◆ available()

bool homeassistant.components.verisure.lock.VerisureDoorlock.available (   self)
Return True if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 89 of file lock.py.

◆ changed_by()

str | None homeassistant.components.verisure.lock.VerisureDoorlock.changed_by (   self)
Last change triggered by.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 96 of file lock.py.

◆ changed_method()

str homeassistant.components.verisure.lock.VerisureDoorlock.changed_method (   self)
Last change method.

Definition at line 105 of file lock.py.

◆ code_format()

str homeassistant.components.verisure.lock.VerisureDoorlock.code_format (   self)
Return the configured code format.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 110 of file lock.py.

◆ device_info()

DeviceInfo homeassistant.components.verisure.lock.VerisureDoorlock.device_info (   self)
Return device information about this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 76 of file lock.py.

◆ disable_autolock()

None homeassistant.components.verisure.lock.VerisureDoorlock.disable_autolock (   self)
Disable autolock on a doorlock.

Definition at line 178 of file lock.py.

◆ enable_autolock()

None homeassistant.components.verisure.lock.VerisureDoorlock.enable_autolock (   self)
Enable autolock on a doorlock.

Definition at line 189 of file lock.py.

◆ extra_state_attributes()

dict[str, str] homeassistant.components.verisure.lock.VerisureDoorlock.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 125 of file lock.py.

◆ is_locked()

bool homeassistant.components.verisure.lock.VerisureDoorlock.is_locked (   self)
Return true if lock is locked.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 118 of file lock.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.verisure.lock.VerisureDoorlock._attr_has_entity_name = True
staticprivate

Definition at line 62 of file lock.py.

◆ _attr_name

homeassistant.components.verisure.lock.VerisureDoorlock._attr_name = None
staticprivate

Definition at line 63 of file lock.py.

◆ _attr_unique_id

homeassistant.components.verisure.lock.VerisureDoorlock._attr_unique_id
private

Definition at line 70 of file lock.py.

◆ _state

homeassistant.components.verisure.lock.VerisureDoorlock._state
private

Definition at line 176 of file lock.py.

◆ serial_number

homeassistant.components.verisure.lock.VerisureDoorlock.serial_number

Definition at line 72 of file lock.py.


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