119 lines
3.9 KiB
Python
119 lines
3.9 KiB
Python
"""
|
|
Offer state listening automation rules.
|
|
|
|
For more details about this automation rule, please refer to the documentation
|
|
at https://home-assistant.io/docs/automation/trigger/#state-trigger
|
|
"""
|
|
import asyncio
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.core import callback
|
|
import homeassistant.util.dt as dt_util
|
|
from homeassistant.const import MATCH_ALL, CONF_PLATFORM
|
|
from homeassistant.helpers.event import (
|
|
async_track_state_change, async_track_point_in_utc_time)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
CONF_ENTITY_ID = 'entity_id'
|
|
CONF_FROM = 'from'
|
|
CONF_TO = 'to'
|
|
CONF_FOR = 'for'
|
|
|
|
TRIGGER_SCHEMA = vol.All(
|
|
vol.Schema({
|
|
vol.Required(CONF_PLATFORM): 'state',
|
|
vol.Required(CONF_ENTITY_ID): cv.entity_ids,
|
|
# These are str on purpose. Want to catch YAML conversions
|
|
CONF_FROM: str,
|
|
CONF_TO: str,
|
|
CONF_FOR: vol.All(cv.time_period, cv.positive_timedelta),
|
|
}),
|
|
cv.key_dependency(CONF_FOR, CONF_TO),
|
|
)
|
|
|
|
|
|
@asyncio.coroutine
|
|
def async_trigger(hass, config, action):
|
|
"""Listen for state changes based on configuration."""
|
|
entity_id = config.get(CONF_ENTITY_ID)
|
|
from_state = config.get(CONF_FROM, MATCH_ALL)
|
|
to_state = config.get(CONF_TO, MATCH_ALL)
|
|
time_delta = config.get(CONF_FOR)
|
|
async_remove_state_for_cancel = None
|
|
async_remove_state_for_listener = None
|
|
match_all = (from_state == MATCH_ALL and to_state == MATCH_ALL)
|
|
|
|
@callback
|
|
def clear_listener():
|
|
"""Clear all unsub listener."""
|
|
nonlocal async_remove_state_for_cancel, async_remove_state_for_listener
|
|
|
|
# pylint: disable=not-callable
|
|
if async_remove_state_for_listener is not None:
|
|
async_remove_state_for_listener()
|
|
async_remove_state_for_listener = None
|
|
if async_remove_state_for_cancel is not None:
|
|
async_remove_state_for_cancel()
|
|
async_remove_state_for_cancel = None
|
|
|
|
@callback
|
|
def state_automation_listener(entity, from_s, to_s):
|
|
"""Listen for state changes and calls action."""
|
|
nonlocal async_remove_state_for_cancel, async_remove_state_for_listener
|
|
|
|
def call_action():
|
|
"""Call action with right context."""
|
|
hass.async_run_job(action, {
|
|
'trigger': {
|
|
'platform': 'state',
|
|
'entity_id': entity,
|
|
'from_state': from_s,
|
|
'to_state': to_s,
|
|
'for': time_delta,
|
|
}
|
|
})
|
|
|
|
# Ignore changes to state attributes if from/to is in use
|
|
if (not match_all and from_s is not None and to_s is not None and
|
|
from_s.last_changed == to_s.last_changed):
|
|
return
|
|
|
|
if time_delta is None:
|
|
call_action()
|
|
return
|
|
|
|
@callback
|
|
def state_for_listener(now):
|
|
"""Fire on state changes after a delay and calls action."""
|
|
nonlocal async_remove_state_for_listener
|
|
async_remove_state_for_listener = None
|
|
clear_listener()
|
|
call_action()
|
|
|
|
@callback
|
|
def state_for_cancel_listener(entity, inner_from_s, inner_to_s):
|
|
"""Fire on changes and cancel for listener if changed."""
|
|
if inner_to_s.state == to_s.state:
|
|
return
|
|
clear_listener()
|
|
|
|
# cleanup previous listener
|
|
clear_listener()
|
|
|
|
async_remove_state_for_listener = async_track_point_in_utc_time(
|
|
hass, state_for_listener, dt_util.utcnow() + time_delta)
|
|
|
|
async_remove_state_for_cancel = async_track_state_change(
|
|
hass, entity, state_for_cancel_listener)
|
|
|
|
unsub = async_track_state_change(
|
|
hass, entity_id, state_automation_listener, from_state, to_state)
|
|
|
|
@callback
|
|
def async_remove():
|
|
"""Remove state listeners async."""
|
|
unsub()
|
|
clear_listener()
|
|
|
|
return async_remove
|