homeassistant.components.template.lock Namespace Reference

Classes
class	TemplateLock

Functions
list[TemplateLock]	_async_create_entities (HomeAssistant hass, dict[str, Any] config)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
string	CONF_CODE_FORMAT_TEMPLATE = "code_format_template"
string	CONF_LOCK = "lock"
string	CONF_OPEN = "open"
string	CONF_UNLOCK = "unlock"
string	DEFAULT_NAME = "Template Lock"
bool	DEFAULT_OPTIMISTIC = False
	PLATFORM_SCHEMA

Detailed Description

Support for locks which integrates with other components.

Function Documentation

_async_create_entities()

list[TemplateLock] homeassistant.components.template.lock._async_create_entities ( HomeAssistant  hass, dict[str, Any]   config  )

private

Create the Template lock.

Definition at line 59 of file lock.py.

async_setup_platform()

None homeassistant.components.template.lock.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the template lock.

Definition at line 67 of file lock.py.

Variable Documentation

CONF_CODE_FORMAT_TEMPLATE

string homeassistant.components.template.lock.CONF_CODE_FORMAT_TEMPLATE = "code_format_template"

Definition at line 37 of file lock.py.

CONF_LOCK

string homeassistant.components.template.lock.CONF_LOCK = "lock"

Definition at line 38 of file lock.py.

CONF_OPEN

string homeassistant.components.template.lock.CONF_OPEN = "open"

Definition at line 40 of file lock.py.

CONF_UNLOCK

string homeassistant.components.template.lock.CONF_UNLOCK = "unlock"

Definition at line 39 of file lock.py.

DEFAULT_NAME

string homeassistant.components.template.lock.DEFAULT_NAME = "Template Lock"

Definition at line 42 of file lock.py.

DEFAULT_OPTIMISTIC

bool homeassistant.components.template.lock.DEFAULT_OPTIMISTIC = False

Definition at line 43 of file lock.py.

PLATFORM_SCHEMA

homeassistant.components.template.lock.PLATFORM_SCHEMA

Initial value:

=  LOCK_PLATFORM_SCHEMA.extend(
    {
        vol.Optional(CONF_NAME): cv.string,
        vol.Required(CONF_LOCK): cv.SCRIPT_SCHEMA,
        vol.Required(CONF_UNLOCK): cv.SCRIPT_SCHEMA,
        vol.Optional(CONF_OPEN): cv.SCRIPT_SCHEMA,
        vol.Required(CONF_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_CODE_FORMAT_TEMPLATE): cv.template,
        vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
).extend(TEMPLATE_ENTITY_AVAILABILITY_SCHEMA_LEGACY.schema)

Definition at line 45 of file lock.py.