mirror of
https://github.com/home-assistant/core.git
synced 2026-04-02 08:26:41 +01:00
68 lines
2.1 KiB
Python
68 lines
2.1 KiB
Python
"""Provides triggers for events."""
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import CONF_OPTIONS, STATE_UNAVAILABLE, STATE_UNKNOWN
|
|
from homeassistant.core import HomeAssistant, State
|
|
from homeassistant.helpers import config_validation as cv
|
|
from homeassistant.helpers.automation import DomainSpec
|
|
from homeassistant.helpers.trigger import (
|
|
ENTITY_STATE_TRIGGER_SCHEMA,
|
|
EntityTriggerBase,
|
|
Trigger,
|
|
TriggerConfig,
|
|
)
|
|
|
|
from .const import ATTR_EVENT_TYPE, DOMAIN
|
|
|
|
CONF_EVENT_TYPE = "event_type"
|
|
|
|
EVENT_RECEIVED_TRIGGER_SCHEMA = ENTITY_STATE_TRIGGER_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_OPTIONS): {
|
|
vol.Required(CONF_EVENT_TYPE): vol.All(
|
|
cv.ensure_list, vol.Length(min=1), [cv.string]
|
|
),
|
|
},
|
|
}
|
|
)
|
|
|
|
|
|
class EventReceivedTrigger(EntityTriggerBase):
|
|
"""Trigger for event entity when it receives a matching event."""
|
|
|
|
_domain_specs = {DOMAIN: DomainSpec()}
|
|
_schema = EVENT_RECEIVED_TRIGGER_SCHEMA
|
|
|
|
def __init__(self, hass: HomeAssistant, config: TriggerConfig) -> None:
|
|
"""Initialize the event received trigger."""
|
|
super().__init__(hass, config)
|
|
self._event_types = set(self._options[CONF_EVENT_TYPE])
|
|
|
|
def is_valid_transition(self, from_state: State, to_state: State) -> bool:
|
|
"""Check if the origin state is valid and different from the current state."""
|
|
|
|
# UNKNOWN is a valid from_state, otherwise the first time the event is received
|
|
# would not trigger
|
|
if from_state.state == STATE_UNAVAILABLE:
|
|
return False
|
|
|
|
return from_state.state != to_state.state
|
|
|
|
def is_valid_state(self, state: State) -> bool:
|
|
"""Check if the event type is valid and matches one of the configured types."""
|
|
return (
|
|
state.state not in (STATE_UNAVAILABLE, STATE_UNKNOWN)
|
|
and state.attributes.get(ATTR_EVENT_TYPE) in self._event_types
|
|
)
|
|
|
|
|
|
TRIGGERS: dict[str, type[Trigger]] = {
|
|
"received": EventReceivedTrigger,
|
|
}
|
|
|
|
|
|
async def async_get_triggers(hass: HomeAssistant) -> dict[str, type[Trigger]]:
|
|
"""Return the triggers for events."""
|
|
return TRIGGERS
|