homeassistant.components.calendar.trigger Namespace Reference

Classes
class	CalendarEventListener
class	QueuedCalendarEvent
class	Timespan

Functions
CALLBACK_TYPE	async_attach_trigger (HomeAssistant hass, ConfigType config, TriggerActionType action, TriggerInfo trigger_info)
EventFetcher	event_fetcher (HomeAssistant hass, str entity_id)
CalendarEntity	get_entity (HomeAssistant hass, str entity_id)
QueuedEventFetcher	queued_event_fetcher (EventFetcher fetcher, str event_type, datetime.timedelta offset)

Variables
	_LOGGER = logging.getLogger(__name__)
string	EVENT_END = "end"
string	EVENT_START = "start"
	EventFetcher
	QueuedEventFetcher
	TRIGGER_SCHEMA
	UPDATE_INTERVAL = datetime.timedelta(minutes=15)

Detailed Description

Offer calendar automation rules.

Function Documentation

async_attach_trigger()

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

Attach trigger for the specified calendar.

Definition at line 262 of file trigger.py.

event_fetcher()

EventFetcher homeassistant.components.calendar.trigger.event_fetcher	(	HomeAssistant	hass,
		str	entity_id
	)

Build an async_get_events wrapper to fetch events during a time span.

Definition at line 108 of file trigger.py.

get_entity()

CalendarEntity homeassistant.components.calendar.trigger.get_entity	(	HomeAssistant	hass,
		str	entity_id
	)

Get the calendar entity for the provided entity_id.

Definition at line 96 of file trigger.py.

queued_event_fetcher()

QueuedEventFetcher homeassistant.components.calendar.trigger.queued_event_fetcher	(	EventFetcher	fetcher,
		str	event_type,
		datetime.timedelta	offset
	)

Build a fetcher that produces a schedule of upcoming trigger events.

Definition at line 121 of file trigger.py.

Variable Documentation

_LOGGER

homeassistant.components.calendar.trigger._LOGGER = logging.getLogger(__name__)

private

Definition at line 29 of file trigger.py.

EVENT_END

string homeassistant.components.calendar.trigger.EVENT_END = "end"

Definition at line 32 of file trigger.py.

EVENT_START

string homeassistant.components.calendar.trigger.EVENT_START = "start"

Definition at line 31 of file trigger.py.

EventFetcher

homeassistant.components.calendar.trigger.EventFetcher

Definition at line 92 of file trigger.py.

QueuedEventFetcher

homeassistant.components.calendar.trigger.QueuedEventFetcher

Definition at line 93 of file trigger.py.

TRIGGER_SCHEMA

homeassistant.components.calendar.trigger.TRIGGER_SCHEMA

Initial value:

=  cv.TRIGGER_BASE_SCHEMA.extend(
    {
        vol.Required(CONF_PLATFORM): DOMAIN,
        vol.Required(CONF_ENTITY_ID): cv.entity_id,
        vol.Optional(CONF_EVENT, default=EVENT_START): vol.In({EVENT_START, EVENT_END}),
        vol.Optional(CONF_OFFSET, default=datetime.timedelta(0)): cv.time_period,
    }
)

Definition at line 35 of file trigger.py.

UPDATE_INTERVAL

homeassistant.components.calendar.trigger.UPDATE_INTERVAL = datetime.timedelta(minutes=15)

Definition at line 33 of file trigger.py.