Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.homekit_controller.lock Namespace Reference

Classes

class  HomeKitLock
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

dictionary CURRENT_STATE_MAP
 
dictionary REVERSED_TARGET_STATE_MAP = {v: k for k, v in TARGET_STATE_MAP.items()}
 
dictionary TARGET_STATE_MAP = {LockState.UNLOCKED: 0, LockState.LOCKED: 1}
 

Detailed Description

Support for HomeKit Controller locks.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.homekit_controller.lock.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up Homekit lock.

Definition at line 32 of file lock.py.

Variable Documentation

◆ CURRENT_STATE_MAP

dictionary homeassistant.components.homekit_controller.lock.CURRENT_STATE_MAP
Initial value:
1 = {
2  0: LockState.UNLOCKED,
3  1: LockState.LOCKED,
4  2: LockState.JAMMED,
5  3: STATE_UNKNOWN,
6 }

Definition at line 20 of file lock.py.

◆ REVERSED_TARGET_STATE_MAP

dictionary homeassistant.components.homekit_controller.lock.REVERSED_TARGET_STATE_MAP = {v: k for k, v in TARGET_STATE_MAP.items()}

Definition at line 29 of file lock.py.

◆ TARGET_STATE_MAP

dictionary homeassistant.components.homekit_controller.lock.TARGET_STATE_MAP = {LockState.UNLOCKED: 0, LockState.LOCKED: 1}

Definition at line 27 of file lock.py.