homeassistant.components.lock Namespace Reference

Namespaces
	const
	device_action
	device_condition
	device_trigger
	reproduce_state
	significant_change

Classes
class	LockEntity
class	LockEntityDescription
class	LockEntityFeature

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
	__all__
	__dir__
	__getattr__
	_DEPRECATED_SUPPORT_OPEN
	_LOGGER
	ATTR_CHANGED_BY
	CACHED_PROPERTIES_WITH_ATTR_
	check_if_deprecated_constant
	CONF_DEFAULT_CODE
	dir_with_deprecated_constants
	ENTITY_ID_FORMAT
	LOCK_SERVICE_SCHEMA
	MIN_TIME_BETWEEN_SCANS
	module_globals
	module_globals_keys
	PLATFORM_SCHEMA
	PLATFORM_SCHEMA_BASE
	PROP_TO_ATTR
	SCAN_INTERVAL
	seconds

Detailed Description

Component to interface with locks that can be controlled remotely.

Function Documentation

async_setup()

bool homeassistant.components.lock.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Track states and offer events for locks.

Definition at line 79 of file __init__.py.

async_setup_entry()

bool homeassistant.components.lock.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up a config entry.

Definition at line 103 of file __init__.py.

async_unload_entry()

bool homeassistant.components.lock.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 108 of file __init__.py.

Variable Documentation

__all__

homeassistant.components.lock.__all__

private

Definition at line 337 of file __init__.py.

__dir__

homeassistant.components.lock.__dir__

private

Definition at line 334 of file __init__.py.

__getattr__

homeassistant.components.lock.__getattr__

private

Definition at line 333 of file __init__.py.

_DEPRECATED_SUPPORT_OPEN

homeassistant.components.lock._DEPRECATED_SUPPORT_OPEN

private

Definition at line 72 of file __init__.py.

_LOGGER

homeassistant.components.lock._LOGGER

private

Definition at line 46 of file __init__.py.

ATTR_CHANGED_BY

homeassistant.components.lock.ATTR_CHANGED_BY

Definition at line 54 of file __init__.py.

CACHED_PROPERTIES_WITH_ATTR_

homeassistant.components.lock.CACHED_PROPERTIES_WITH_ATTR_

Definition at line 117 of file __init__.py.

check_if_deprecated_constant

homeassistant.components.lock.check_if_deprecated_constant

Definition at line 333 of file __init__.py.

CONF_DEFAULT_CODE

homeassistant.components.lock.CONF_DEFAULT_CODE

Definition at line 55 of file __init__.py.

dir_with_deprecated_constants

homeassistant.components.lock.dir_with_deprecated_constants

Definition at line 335 of file __init__.py.

ENTITY_ID_FORMAT

homeassistant.components.lock.ENTITY_ID_FORMAT

Definition at line 49 of file __init__.py.

LOCK_SERVICE_SCHEMA

homeassistant.components.lock.LOCK_SERVICE_SCHEMA

Definition at line 59 of file __init__.py.

MIN_TIME_BETWEEN_SCANS

homeassistant.components.lock.MIN_TIME_BETWEEN_SCANS

Definition at line 57 of file __init__.py.

module_globals

homeassistant.components.lock.module_globals

Definition at line 333 of file __init__.py.

module_globals_keys

homeassistant.components.lock.module_globals_keys

Definition at line 335 of file __init__.py.

PLATFORM_SCHEMA

homeassistant.components.lock.PLATFORM_SCHEMA

Definition at line 50 of file __init__.py.

PLATFORM_SCHEMA_BASE

homeassistant.components.lock.PLATFORM_SCHEMA_BASE

Definition at line 51 of file __init__.py.

PROP_TO_ATTR

homeassistant.components.lock.PROP_TO_ATTR

Definition at line 74 of file __init__.py.

SCAN_INTERVAL

homeassistant.components.lock.SCAN_INTERVAL

Definition at line 52 of file __init__.py.

seconds

homeassistant.components.lock.seconds

Definition at line 52 of file __init__.py.