homeassistant.components.lock.device_action Namespace Reference

Functions
None	async_call_action_from_config (HomeAssistant hass, ConfigType config, TemplateVarsType variables, Context|None context)
list[dict[str, str]]	async_get_actions (HomeAssistant hass, str device_id)
ConfigType	async_validate_action_config (HomeAssistant hass, ConfigType config)

Variables
	_ACTION_SCHEMA
dictionary	ACTION_TYPES = {"lock", "unlock", "open"}

Detailed Description

Provides device automations for Lock.

Function Documentation

async_call_action_from_config()

None homeassistant.components.lock.device_action.async_call_action_from_config	(	HomeAssistant	hass,
		ConfigType	config,
		TemplateVarsType	variables,
		Context | None	context
	)

Execute a device action.

Definition at line 73 of file device_action.py.

async_get_actions()

list[dict[str, str]] homeassistant.components.lock.device_action.async_get_actions	(	HomeAssistant	hass,
		str	device_id
	)

List device actions for Lock devices.

Definition at line 43 of file device_action.py.

async_validate_action_config()

ConfigType homeassistant.components.lock.device_action.async_validate_action_config	(	HomeAssistant	hass,
		ConfigType	config
	)

Validate config.

Definition at line 36 of file device_action.py.

Variable Documentation

_ACTION_SCHEMA

homeassistant.components.lock.device_action._ACTION_SCHEMA

private

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): vol.In(ACTION_TYPES),
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
    }
)

Definition at line 28 of file device_action.py.

ACTION_TYPES

dictionary homeassistant.components.lock.device_action.ACTION_TYPES = {"lock", "unlock", "open"}

Definition at line 26 of file device_action.py.