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

Public Member Functions

None __init__ (self, KebaHandler keba, str name, str entity_type)
 
None async_added_to_hass (self)
 
None async_lock (self, **Any kwargs)
 
None async_unlock (self, **Any kwargs)
 
None async_update (self)
 
None update_callback (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_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)
 
- 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)
 

Private Attributes

 _attr_is_locked
 
 _attr_name
 
 _attr_unique_id
 
 _keba
 

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

The entity class for KEBA charging stations switch.

Definition at line 31 of file lock.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.keba.lock.KebaLock.__init__ (   self,
KebaHandler  keba,
str  name,
str  entity_type 
)
Initialize the KEBA switch.

Definition at line 36 of file lock.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.keba.lock.KebaLock.async_added_to_hass (   self)
Add update callback after being added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 59 of file lock.py.

◆ async_lock()

None homeassistant.components.keba.lock.KebaLock.async_lock (   self,
**Any  kwargs 
)
Lock wallbox.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 43 of file lock.py.

◆ async_unlock()

None homeassistant.components.keba.lock.KebaLock.async_unlock (   self,
**Any  kwargs 
)
Unlock wallbox.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 47 of file lock.py.

◆ async_update()

None homeassistant.components.keba.lock.KebaLock.async_update (   self)
Attempt to retrieve on off state from the switch.

Definition at line 51 of file lock.py.

◆ update_callback()

None homeassistant.components.keba.lock.KebaLock.update_callback (   self)
Schedule a state update.

Definition at line 55 of file lock.py.

Member Data Documentation

◆ _attr_is_locked

homeassistant.components.keba.lock.KebaLock._attr_is_locked
private

Definition at line 39 of file lock.py.

◆ _attr_name

homeassistant.components.keba.lock.KebaLock._attr_name
private

Definition at line 40 of file lock.py.

◆ _attr_should_poll

bool homeassistant.components.keba.lock.KebaLock._attr_should_poll = False
staticprivate

Definition at line 34 of file lock.py.

◆ _attr_unique_id

homeassistant.components.keba.lock.KebaLock._attr_unique_id
private

Definition at line 41 of file lock.py.

◆ _keba

homeassistant.components.keba.lock.KebaLock._keba
private

Definition at line 38 of file lock.py.


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