homeassistant.components.homeassistant.triggers.time Namespace Reference

Classes
class	TrackEntity

Functions
CALLBACK_TYPE	async_attach_trigger (HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info)
template.Template	valid_at_template (Any value)

Variables
	_TIME_AT_SCHEMA = vol.Any(cv.time, _TIME_TRIGGER_ENTITY)
	_TIME_TRIGGER_ENTITY = vol.All(str, cv.entity_domain(["input_datetime", "sensor"]))
	_TIME_TRIGGER_ENTITY_WITH_OFFSET
	_TIME_TRIGGER_SCHEMA
	TRIGGER_SCHEMA

Detailed Description

Offer time listening automation rules.

Function Documentation

async_attach_trigger()

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

Listen for state changes based on configuration.

Definition at line 88 of file time.py.

valid_at_template()

template.Template homeassistant.components.homeassistant.triggers.time.valid_at_template

(

Any

value

)

Validate either a jinja2 template, valid time, or valid trigger entity.

Definition at line 51 of file time.py.

Variable Documentation

_TIME_AT_SCHEMA

homeassistant.components.homeassistant.triggers.time._TIME_AT_SCHEMA = vol.Any(cv.time, _TIME_TRIGGER_ENTITY)

private

Definition at line 41 of file time.py.

_TIME_TRIGGER_ENTITY

homeassistant.components.homeassistant.triggers.time._TIME_TRIGGER_ENTITY = vol.All(str, cv.entity_domain(["input_datetime", "sensor"]))

private

Definition at line 40 of file time.py.

_TIME_TRIGGER_ENTITY_WITH_OFFSET

homeassistant.components.homeassistant.triggers.time._TIME_TRIGGER_ENTITY_WITH_OFFSET

private

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_ENTITY_ID): cv.entity_domain(["sensor"]),
        vol.Optional(CONF_OFFSET): cv.time_period,
    }
)

Definition at line 43 of file time.py.

_TIME_TRIGGER_SCHEMA

homeassistant.components.homeassistant.triggers.time._TIME_TRIGGER_SCHEMA

private

Initial value:

=  vol.Any(
    cv.time,
    _TIME_TRIGGER_ENTITY,
    _TIME_TRIGGER_ENTITY_WITH_OFFSET,
    valid_at_template,
    msg=(
        "Expected HH:MM, HH:MM:SS, an Entity ID with domain 'input_datetime' or "
        "'sensor', a combination of a timestamp sensor entity and an offset, or Limited Template"
    ),
)

Definition at line 61 of file time.py.

TRIGGER_SCHEMA

homeassistant.components.homeassistant.triggers.time.TRIGGER_SCHEMA

Initial value:

=  cv.TRIGGER_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_PLATFORM): "time",
        vol.Required(CONF_AT): vol.All(cv.ensure_list, [_TIME_TRIGGER_SCHEMA]),
    }
)

Definition at line 73 of file time.py.