92 lines
2.5 KiB
Python
92 lines
2.5 KiB
Python
"""
|
|
homeassistant.components.automation.numeric_state
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Offers numeric state listening automation rules.
|
|
"""
|
|
import logging
|
|
|
|
from homeassistant.helpers.event import track_state_change
|
|
|
|
|
|
CONF_ENTITY_ID = "entity_id"
|
|
CONF_BELOW = "below"
|
|
CONF_ABOVE = "above"
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def trigger(hass, config, action):
|
|
""" Listen for state changes based on `config`. """
|
|
entity_id = config.get(CONF_ENTITY_ID)
|
|
|
|
if entity_id is None:
|
|
_LOGGER.error("Missing configuration key %s", CONF_ENTITY_ID)
|
|
return False
|
|
|
|
below = config.get(CONF_BELOW)
|
|
above = config.get(CONF_ABOVE)
|
|
|
|
if below is None and above is None:
|
|
_LOGGER.error("Missing configuration key."
|
|
" One of %s or %s is required",
|
|
CONF_BELOW, CONF_ABOVE)
|
|
return False
|
|
|
|
# pylint: disable=unused-argument
|
|
def state_automation_listener(entity, from_s, to_s):
|
|
""" Listens for state changes and calls action. """
|
|
|
|
# Fire action if we go from outside range into range
|
|
if _in_range(to_s.state, above, below) and \
|
|
(from_s is None or not _in_range(from_s.state, above, below)):
|
|
action()
|
|
|
|
track_state_change(
|
|
hass, entity_id, state_automation_listener)
|
|
|
|
return True
|
|
|
|
|
|
def if_action(hass, config):
|
|
""" Wraps action method with state based condition. """
|
|
|
|
entity_id = config.get(CONF_ENTITY_ID)
|
|
|
|
if entity_id is None:
|
|
_LOGGER.error("Missing configuration key %s", CONF_ENTITY_ID)
|
|
return None
|
|
|
|
below = config.get(CONF_BELOW)
|
|
above = config.get(CONF_ABOVE)
|
|
|
|
if below is None and above is None:
|
|
_LOGGER.error("Missing configuration key."
|
|
" One of %s or %s is required",
|
|
CONF_BELOW, CONF_ABOVE)
|
|
return None
|
|
|
|
def if_numeric_state():
|
|
""" Test numeric state condition. """
|
|
state = hass.states.get(entity_id)
|
|
return state is not None and _in_range(state.state, above, below)
|
|
|
|
return if_numeric_state
|
|
|
|
|
|
def _in_range(value, range_start, range_end):
|
|
""" Checks if value is inside the range """
|
|
|
|
try:
|
|
value = float(value)
|
|
except ValueError:
|
|
_LOGGER.warn("Missing value in numeric check")
|
|
return False
|
|
|
|
if range_start is not None and range_end is not None:
|
|
return float(range_start) <= value < float(range_end)
|
|
elif range_end is not None:
|
|
return value < float(range_end)
|
|
else:
|
|
return float(range_start) <= value
|