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

Public Member Functions

None __init__ (self, str|None unique_id, str name, list[str] entity_ids)
 
None async_lock (self, **Any kwargs)
 
None async_open (self, **Any kwargs)
 
None async_unlock (self, **Any kwargs)
 
None async_update_group_state (self)
 
- Public Member Functions inherited from homeassistant.components.group.entity.GroupEntity
None async_added_to_hass (self)
 
None async_defer_or_update_ha_state (self)
 
CALLBACK_TYPE async_start_preview (self, Callable[[str, Mapping[str, Any]], None] preview_callback)
 
None async_update_supported_features (self, str entity_id, State|None new_state)
 
- 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_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 Attributes

 _attr_available
 
 _attr_extra_state_attributes
 
 _attr_is_jammed
 
 _attr_is_locked
 
 _attr_is_locking
 
 _attr_is_open
 
 _attr_is_opening
 
 _attr_is_unlocking
 
 _attr_name
 
 _attr_supported_features
 
 _attr_unique_id
 
 _entity_ids
 

Static Private Attributes

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

Detailed Description

Representation of a lock group.

Definition at line 103 of file lock.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.group.lock.LockGroup.__init__ (   self,
str | None  unique_id,
str  name,
list[str entity_ids 
)
Initialize a lock group.

Definition at line 109 of file lock.py.

Member Function Documentation

◆ async_lock()

None homeassistant.components.group.lock.LockGroup.async_lock (   self,
**Any  kwargs 
)
Forward the lock command to all locks in the group.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 123 of file lock.py.

◆ async_open()

None homeassistant.components.group.lock.LockGroup.async_open (   self,
**Any  kwargs 
)
Forward the open command to all locks in the group.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 147 of file lock.py.

◆ async_unlock()

None homeassistant.components.group.lock.LockGroup.async_unlock (   self,
**Any  kwargs 
)
Forward the unlock command to all locks in the group.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 136 of file lock.py.

◆ async_update_group_state()

None homeassistant.components.group.lock.LockGroup.async_update_group_state (   self)
Query all members and determine the lock group state.

Reimplemented from homeassistant.components.group.entity.GroupEntity.

Definition at line 159 of file lock.py.

Member Data Documentation

◆ _attr_available [1/2]

bool homeassistant.components.group.lock.LockGroup._attr_available = False
staticprivate

Definition at line 106 of file lock.py.

◆ _attr_available [2/2]

homeassistant.components.group.lock.LockGroup._attr_available
private

Definition at line 188 of file lock.py.

◆ _attr_extra_state_attributes

homeassistant.components.group.lock.LockGroup._attr_extra_state_attributes
private

Definition at line 120 of file lock.py.

◆ _attr_is_jammed

homeassistant.components.group.lock.LockGroup._attr_is_jammed
private

Definition at line 173 of file lock.py.

◆ _attr_is_locked

homeassistant.components.group.lock.LockGroup._attr_is_locked
private

Definition at line 178 of file lock.py.

◆ _attr_is_locking

homeassistant.components.group.lock.LockGroup._attr_is_locking
private

Definition at line 174 of file lock.py.

◆ _attr_is_open

homeassistant.components.group.lock.LockGroup._attr_is_open
private

Definition at line 176 of file lock.py.

◆ _attr_is_opening

homeassistant.components.group.lock.LockGroup._attr_is_opening
private

Definition at line 175 of file lock.py.

◆ _attr_is_unlocking

homeassistant.components.group.lock.LockGroup._attr_is_unlocking
private

Definition at line 177 of file lock.py.

◆ _attr_name

homeassistant.components.group.lock.LockGroup._attr_name
private

Definition at line 119 of file lock.py.

◆ _attr_should_poll

bool homeassistant.components.group.lock.LockGroup._attr_should_poll = False
staticprivate

Definition at line 107 of file lock.py.

◆ _attr_supported_features

homeassistant.components.group.lock.LockGroup._attr_supported_features
private

Definition at line 117 of file lock.py.

◆ _attr_unique_id

homeassistant.components.group.lock.LockGroup._attr_unique_id
private

Definition at line 121 of file lock.py.

◆ _entity_ids

homeassistant.components.group.lock.LockGroup._entity_ids
private

Definition at line 116 of file lock.py.


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