core/homeassistant/components/geo_location/trigger.py

116 lines
3.6 KiB
Python

"""Offer geolocation automation rules."""
from __future__ import annotations
import logging
from typing import Final
import voluptuous as vol
from homeassistant.const import CONF_EVENT, CONF_PLATFORM, CONF_SOURCE, CONF_ZONE
from homeassistant.core import (
CALLBACK_TYPE,
HassJob,
HomeAssistant,
State,
callback,
)
from homeassistant.helpers import condition, config_validation as cv
from homeassistant.helpers.config_validation import entity_domain
from homeassistant.helpers.event import (
EventStateChangedData,
TrackStates,
async_track_state_change_filtered,
)
from homeassistant.helpers.trigger import TriggerActionType, TriggerInfo
from homeassistant.helpers.typing import ConfigType, EventType
from . import DOMAIN
_LOGGER = logging.getLogger(__name__)
EVENT_ENTER: Final = "enter"
EVENT_LEAVE: Final = "leave"
DEFAULT_EVENT: Final = EVENT_ENTER
TRIGGER_SCHEMA = cv.TRIGGER_BASE_SCHEMA.extend(
{
vol.Required(CONF_PLATFORM): "geo_location",
vol.Required(CONF_SOURCE): cv.string,
vol.Required(CONF_ZONE): entity_domain("zone"),
vol.Required(CONF_EVENT, default=DEFAULT_EVENT): vol.Any(
EVENT_ENTER, EVENT_LEAVE
),
}
)
def source_match(state: State | None, source: str) -> bool:
"""Check if the state matches the provided source."""
return state is not None and state.attributes.get("source") == source
async def async_attach_trigger(
hass: HomeAssistant,
config: ConfigType,
action: TriggerActionType,
trigger_info: TriggerInfo,
) -> CALLBACK_TYPE:
"""Listen for state changes based on configuration."""
trigger_data = trigger_info["trigger_data"]
source: str = config[CONF_SOURCE].lower()
zone_entity_id: str = config[CONF_ZONE]
trigger_event: str = config[CONF_EVENT]
job = HassJob(action)
@callback
def state_change_listener(event: EventType[EventStateChangedData]) -> None:
"""Handle specific state changes."""
# Skip if the event's source does not match the trigger's source.
from_state = event.data["old_state"]
to_state = event.data["new_state"]
if not source_match(from_state, source) and not source_match(to_state, source):
return
if (zone_state := hass.states.get(zone_entity_id)) is None:
_LOGGER.warning(
"Unable to execute automation %s: Zone %s not found",
trigger_info["name"],
zone_entity_id,
)
return
from_match = (
condition.zone(hass, zone_state, from_state) if from_state else False
)
to_match = condition.zone(hass, zone_state, to_state) if to_state else False
if (
trigger_event == EVENT_ENTER
and not from_match
and to_match
or trigger_event == EVENT_LEAVE
and from_match
and not to_match
):
hass.async_run_hass_job(
job,
{
"trigger": {
**trigger_data,
"platform": "geo_location",
"source": source,
"entity_id": event.data["entity_id"],
"from_state": from_state,
"to_state": to_state,
"zone": zone_state,
"event": trigger_event,
"description": f"geo_location - {source}",
}
},
event.context,
)
return async_track_state_change_filtered(
hass, TrackStates(False, set(), {DOMAIN}), state_change_listener
).async_remove