homeassistant.components.smartthings.lock Namespace Reference

Classes
class	SmartThingsLock

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
Sequence[str]|None	get_capabilities (Sequence[str] capabilities)

Variables
dictionary	ST_LOCK_ATTR_MAP
string	ST_STATE_LOCKED = "locked"

Detailed Description

Support for locks through the SmartThings cloud API.

Function Documentation

async_setup_entry()

None homeassistant.components.smartthings.lock.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Add locks for a config entry.

Definition at line 29 of file lock.py.

get_capabilities()

Sequence[str] | None homeassistant.components.smartthings.lock.get_capabilities

(

Sequence[str]

capabilities

)

Return all capabilities supported if minimum required are present.

Definition at line 43 of file lock.py.

Variable Documentation

ST_LOCK_ATTR_MAP

dictionary homeassistant.components.smartthings.lock.ST_LOCK_ATTR_MAP

Initial value:

=  {
    "codeId": "code_id",
    "codeName": "code_name",
    "lockName": "lock_name",
    "method": "method",
    "timeout": "timeout",
    "usedCode": "used_code",
}

Definition at line 19 of file lock.py.

ST_STATE_LOCKED

string homeassistant.components.smartthings.lock.ST_STATE_LOCKED = "locked"

Definition at line 18 of file lock.py.