homeassistant.helpers.trigger Namespace Reference

Classes
class	PluggableAction
class	PluggableActionsEntry
class	TriggerActionType
class	TriggerData
class	TriggerInfo
class	TriggerProtocol

Functions
TriggerProtocol	_async_get_trigger_platform (HomeAssistant hass, ConfigType config)
Callable	_trigger_action_wrapper (HomeAssistant hass, Callable action, ConfigType conf)
CALLBACK_TYPE|None	async_initialize_triggers (HomeAssistant hass, list[ConfigType] trigger_config, Callable action, str domain, str name, Callable log_cb, bool home_assistant_start=False, TemplateVarsType variables=None)
list[ConfigType]	async_validate_trigger_config (HomeAssistant hass, list[ConfigType] trigger_config)

Variables
dictionary	_PLATFORM_ALIASES

Detailed Description

Triggers.

Function Documentation

_async_get_trigger_platform()

TriggerProtocol homeassistant.helpers.trigger._async_get_trigger_platform ( HomeAssistant  hass, ConfigType   config  )

private

Definition at line 219 of file trigger.py.

_trigger_action_wrapper()

Callable homeassistant.helpers.trigger._trigger_action_wrapper ( HomeAssistant  hass, Callable  action, ConfigType   conf  )

private

Wrap trigger action with extra vars if configured.

If action is a coroutine function, a coroutine function will be returned.
If action is a callback, a callback will be returned.

Definition at line 252 of file trigger.py.

async_initialize_triggers()

CALLBACK_TYPE | None homeassistant.helpers.trigger.async_initialize_triggers	(	HomeAssistant	hass,
		list[ConfigType]	trigger_config,
		Callable	action,
		str	domain,
		str	name,
		Callable	log_cb,
		bool	home_assistant_start = False,
		TemplateVarsType	variables = None
	)

Initialize triggers.

Definition at line 302 of file trigger.py.

async_validate_trigger_config()

list[ConfigType] homeassistant.helpers.trigger.async_validate_trigger_config	(	HomeAssistant	hass,
		list[ConfigType]	trigger_config
	)

Validate triggers.

Definition at line 237 of file trigger.py.

Variable Documentation

_PLATFORM_ALIASES

dictionary homeassistant.helpers.trigger._PLATFORM_ALIASES

private

Initial value:

=  {
    "device": "device_automation",
    "event": "homeassistant",
    "numeric_state": "homeassistant",
    "state": "homeassistant",
    "time_pattern": "homeassistant",
    "time": "homeassistant",
}

Definition at line 38 of file trigger.py.