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

Public Member Functions

None __init__ (self, SwitchbotDataUpdateCoordinator coordinator, force_nightlatch)
 
None async_lock (self, **Any kwargs)
 
None async_open (self, **Any kwargs)
 
None async_unlock (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.switchbot.entity.SwitchbotEntity
None __init__ (self, SwitchbotDataUpdateCoordinator coordinator)
 
None async_added_to_hass (self)
 
None async_update (self)
 
Mapping[Any, Any] extra_state_attributes (self)
 
dict[str, Any] parsed_data (self)
 
- Public Member Functions inherited from homeassistant.components.switchbot.coordinator.SwitchbotDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, BLEDevice ble_device, switchbot.SwitchbotDevice device, str base_unique_id, str device_name, bool connectable, SwitchbotModel model)
 
bool async_wait_ready (self)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.active_update_coordinator.ActiveBluetoothDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *str address, BluetoothScanningMode mode, Callable[[BluetoothServiceInfoBleak, float|None], bool] needs_poll_method, Callable[[BluetoothServiceInfoBleak], Coroutine[Any, Any, _T],]|None poll_method=None, Debouncer[Coroutine[Any, Any, None]]|None poll_debouncer=None, bool connectable=True)
 
bool needs_poll (self, BluetoothServiceInfoBleak service_info)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.passive_update_coordinator.PassiveBluetoothDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, str address, BluetoothScanningMode mode, bool connectable=False)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
Generator[Any] async_contexts (self)
 
None async_update_listeners (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.bluetooth.update_coordinator.BasePassiveBluetoothCoordinator
CALLBACK_TYPE async_start (self)
 
float last_seen (self)
 
str name (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)
 
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_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 Member Functions

None _async_update_attrs (self)
 

Private Attributes

 _attr_is_jammed
 
 _attr_is_locked
 
 _attr_is_locking
 
 _attr_is_unlocking
 
 _attr_supported_features
 
 _last_run_success
 

Static Private Attributes

 _attr_name = None
 
string _attr_translation_key = "lock"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.switchbot.coordinator.SwitchbotDataUpdateCoordinator
 base_unique_id
 
 ble_device
 
 device
 
 device_name
 
 model
 
- Public Attributes inherited from homeassistant.components.bluetooth.active_update_coordinator.ActiveBluetoothDataUpdateCoordinator
 data
 
 last_poll_successful
 
- Public Attributes inherited from homeassistant.components.bluetooth.update_coordinator.BasePassiveBluetoothCoordinator
 address
 
 connectable
 
 hass
 
 logger
 
 mode
 
- 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 Switchbot lock.

Definition at line 28 of file lock.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.switchbot.lock.SwitchBotLock.__init__ (   self,
SwitchbotDataUpdateCoordinator  coordinator,
  force_nightlatch 
)
Initialize the entity.

Definition at line 35 of file lock.py.

Member Function Documentation

◆ _async_update_attrs()

None homeassistant.components.switchbot.lock.SwitchBotLock._async_update_attrs (   self)
private
Update the entity attributes.

Reimplemented from homeassistant.components.switchbot.entity.SwitchbotEntity.

Definition at line 44 of file lock.py.

◆ async_lock()

None homeassistant.components.switchbot.lock.SwitchBotLock.async_lock (   self,
**Any  kwargs 
)
Lock the lock.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 55 of file lock.py.

◆ async_open()

None homeassistant.components.switchbot.lock.SwitchBotLock.async_open (   self,
**Any  kwargs 
)
Open the lock.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 68 of file lock.py.

◆ async_unlock()

None homeassistant.components.switchbot.lock.SwitchBotLock.async_unlock (   self,
**Any  kwargs 
)
Unlock the lock.

Reimplemented from homeassistant.components.lock.LockEntity.

Definition at line 60 of file lock.py.

Member Data Documentation

◆ _attr_is_jammed

homeassistant.components.switchbot.lock.SwitchBotLock._attr_is_jammed
private

Definition at line 50 of file lock.py.

◆ _attr_is_locked

homeassistant.components.switchbot.lock.SwitchBotLock._attr_is_locked
private

Definition at line 47 of file lock.py.

◆ _attr_is_locking

homeassistant.components.switchbot.lock.SwitchBotLock._attr_is_locking
private

Definition at line 48 of file lock.py.

◆ _attr_is_unlocking

homeassistant.components.switchbot.lock.SwitchBotLock._attr_is_unlocking
private

Definition at line 49 of file lock.py.

◆ _attr_name

homeassistant.components.switchbot.lock.SwitchBotLock._attr_name = None
staticprivate

Definition at line 32 of file lock.py.

◆ _attr_supported_features

homeassistant.components.switchbot.lock.SwitchBotLock._attr_supported_features
private

Definition at line 42 of file lock.py.

◆ _attr_translation_key

string homeassistant.components.switchbot.lock.SwitchBotLock._attr_translation_key = "lock"
staticprivate

Definition at line 31 of file lock.py.

◆ _last_run_success

homeassistant.components.switchbot.lock.SwitchBotLock._last_run_success
private

Definition at line 57 of file lock.py.


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