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

Public Member Functions

None async_lock (self, **Any kwargs)
 
None async_unlock (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.unifiprotect.entity.BaseProtectEntity
None __init__ (self, ProtectData data, ProtectDeviceType device, EntityDescription|None description=None)
 
None async_added_to_hass (self)
 
None async_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_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)
 
- 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)
 
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)
 

Private Member Functions

None _async_update_device_from_protect (self, ProtectDeviceType device)
 

Private Attributes

 _attr_available
 
 _attr_is_jammed
 
 _attr_is_locked
 
 _attr_is_locking
 
 _attr_is_unlocking
 

Static Private Attributes

tuple _state_attrs
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.unifiprotect.entity.BaseProtectEntity
 data
 
 device
 
 entity_description
 
- 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.unifiprotect.entity.BaseProtectEntity
 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

A Ubiquiti UniFi Protect Speaker.

Definition at line 48 of file lock.py.

Member Function Documentation

◆ _async_update_device_from_protect()

None homeassistant.components.unifiprotect.lock.ProtectLock._async_update_device_from_protect (   self,
ProtectDeviceType  device 
)
private
Update Entity object from Protect device.

Reimplemented from homeassistant.components.unifiprotect.entity.BaseProtectEntity.

Definition at line 62 of file lock.py.

◆ async_lock()

None homeassistant.components.unifiprotect.lock.ProtectLock.async_lock (   self,
**Any  kwargs 
)
Lock the lock.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 92 of file lock.py.

◆ async_unlock()

None homeassistant.components.unifiprotect.lock.ProtectLock.async_unlock (   self,
**Any  kwargs 
)
Unlock the lock.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 87 of file lock.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.unifiprotect.lock.ProtectLock._attr_available
private

Definition at line 85 of file lock.py.

◆ _attr_is_jammed

homeassistant.components.unifiprotect.lock.ProtectLock._attr_is_jammed
private

Definition at line 69 of file lock.py.

◆ _attr_is_locked

homeassistant.components.unifiprotect.lock.ProtectLock._attr_is_locked
private

Definition at line 66 of file lock.py.

◆ _attr_is_locking

homeassistant.components.unifiprotect.lock.ProtectLock._attr_is_locking
private

Definition at line 67 of file lock.py.

◆ _attr_is_unlocking

homeassistant.components.unifiprotect.lock.ProtectLock._attr_is_unlocking
private

Definition at line 68 of file lock.py.

◆ _state_attrs

tuple homeassistant.components.unifiprotect.lock.ProtectLock._state_attrs
staticprivate
Initial value:
= (
"_attr_available",
"_attr_is_locked",
"_attr_is_locking",
"_attr_is_unlocking",
"_attr_is_jammed",
)

Definition at line 53 of file lock.py.


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