homeassistant.components.cover.device_action Namespace Reference

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

Variables
	_ACTION_SCHEMA = vol.Any(CMD_ACTION_SCHEMA, POSITION_ACTION_SCHEMA)
	CMD_ACTION_SCHEMA
dictionary	CMD_ACTION_TYPES = {"open", "close", "stop", "open_tilt", "close_tilt"}
	POSITION_ACTION_SCHEMA
dictionary	POSITION_ACTION_TYPES = {"set_position", "set_tilt_position"}

Detailed Description

Provides device automations for Cover.

Function Documentation

async_call_action_from_config()

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

Execute a device action.

Definition at line 118 of file device_action.py.

async_get_action_capabilities()

dict[str, vol.Schema] homeassistant.components.cover.device_action.async_get_action_capabilities	(	HomeAssistant	hass,
		ConfigType	config
	)

List action capabilities.

Definition at line 100 of file device_action.py.

async_get_actions()

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

List device actions for Cover devices.

Definition at line 60 of file device_action.py.

async_validate_action_config()

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

Validate config.

Definition at line 53 of file device_action.py.

Variable Documentation

_ACTION_SCHEMA

homeassistant.components.cover.device_action._ACTION_SCHEMA = vol.Any(CMD_ACTION_SCHEMA, POSITION_ACTION_SCHEMA)

private

Definition at line 50 of file device_action.py.

CMD_ACTION_SCHEMA

homeassistant.components.cover.device_action.CMD_ACTION_SCHEMA

Initial value:

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

Definition at line 33 of file device_action.py.

CMD_ACTION_TYPES

dictionary homeassistant.components.cover.device_action.CMD_ACTION_TYPES = {"open", "close", "stop", "open_tilt", "close_tilt"}

Definition at line 30 of file device_action.py.

POSITION_ACTION_SCHEMA

homeassistant.components.cover.device_action.POSITION_ACTION_SCHEMA

Initial value:

=  cv.DEVICE_ACTION_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_TYPE): vol.In(POSITION_ACTION_TYPES),
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Optional("position", default=0): vol.All(
            vol.Coerce(int), vol.Range(min=0, max=100)
        ),
    }
)

Definition at line 40 of file device_action.py.

POSITION_ACTION_TYPES

dictionary homeassistant.components.cover.device_action.POSITION_ACTION_TYPES = {"set_position", "set_tilt_position"}

Definition at line 31 of file device_action.py.