homeassistant.components.homeassistant.triggers.event Namespace Reference

Functions
Any	_schema_value (Any value)
Any	_validate_event_types (Any value)
CALLBACK_TYPE	async_attach_trigger (HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info, *str platform_type="event")

Variables
string	CONF_EVENT_CONTEXT = "context"
string	CONF_EVENT_TYPE = "event_type"
	TRIGGER_SCHEMA

Detailed Description

Offer event listening automation rules.

Function Documentation

_schema_value()

Any homeassistant.components.homeassistant.triggers.event._schema_value ( Any  value )

private

Definition at line 44 of file event.py.

_validate_event_types()

Any homeassistant.components.homeassistant.triggers.event._validate_event_types ( Any  value )

private

Validate the event types.

If the event types are templated, we check when attaching the trigger.

Definition at line 21 of file event.py.

async_attach_trigger()

CALLBACK_TYPE homeassistant.components.homeassistant.triggers.event.async_attach_trigger	(	HomeAssistant	hass,
		ConfigType	config,
		TriggerActionType	action,
		TriggerInfo	trigger_info,
		*str	platform_type = "event"
	)

Listen for events based on configuration.

Definition at line 51 of file event.py.

Variable Documentation

CONF_EVENT_CONTEXT

string homeassistant.components.homeassistant.triggers.event.CONF_EVENT_CONTEXT = "context"

Definition at line 18 of file event.py.

CONF_EVENT_TYPE

string homeassistant.components.homeassistant.triggers.event.CONF_EVENT_TYPE = "event_type"

Definition at line 17 of file event.py.

TRIGGER_SCHEMA

homeassistant.components.homeassistant.triggers.event.TRIGGER_SCHEMA

Initial value:

=  cv.TRIGGER_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_PLATFORM): "event",
        vol.Required(CONF_EVENT_TYPE): vol.All(
            cv.ensure_list, [cv.template], _validate_event_types
        ),
        vol.Optional(CONF_EVENT_DATA): vol.All(dict, cv.template_complex),
        vol.Optional(CONF_EVENT_CONTEXT): vol.All(dict, cv.template_complex),
    }
)

Definition at line 32 of file event.py.