homeassistant.components.vacuum.device_trigger Namespace Reference

Functions
CALLBACK_TYPE	async_attach_trigger (HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info)
dict[str, vol.Schema]	async_get_trigger_capabilities (HomeAssistant hass, ConfigType config)
list[dict[str, str]]	async_get_triggers (HomeAssistant hass, str device_id)

Variables
	TRIGGER_SCHEMA
dictionary	TRIGGER_TYPES = {"cleaning", "docked"}

Detailed Description

Provides device automations for Vacuum.

Function Documentation

async_attach_trigger()

CALLBACK_TYPE homeassistant.components.vacuum.device_trigger.async_attach_trigger	(	HomeAssistant	hass,
		ConfigType	config,
		TriggerActionType	action,
		TriggerInfo	trigger_info
	)

Attach a trigger.

Definition at line 72 of file device_trigger.py.

async_get_trigger_capabilities()

dict[str, vol.Schema] homeassistant.components.vacuum.device_trigger.async_get_trigger_capabilities	(	HomeAssistant	hass,
		ConfigType	config
	)

List trigger capabilities.

Definition at line 61 of file device_trigger.py.

async_get_triggers()

list[dict[str, str]] homeassistant.components.vacuum.device_trigger.async_get_triggers	(	HomeAssistant	hass,
		str	device_id
	)

List device triggers for Vacuum devices.

Definition at line 35 of file device_trigger.py.

Variable Documentation

TRIGGER_SCHEMA

homeassistant.components.vacuum.device_trigger.TRIGGER_SCHEMA

Initial value:

=  DEVICE_TRIGGER_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITY_ID): cv.entity_id_or_uuid,
        vol.Required(CONF_TYPE): vol.In(TRIGGER_TYPES),
        vol.Optional(CONF_FOR): cv.positive_time_period_dict,
    }
)

Definition at line 26 of file device_trigger.py.

TRIGGER_TYPES

dictionary homeassistant.components.vacuum.device_trigger.TRIGGER_TYPES = {"cleaning", "docked"}

Definition at line 24 of file device_trigger.py.