esphome/esphomeyaml/components/sensor/__init__.py

230 lines
9.7 KiB
Python
Raw Normal View History

2018-04-07 01:23:03 +02:00
import voluptuous as vol
from esphomeyaml.components import mqtt
2018-04-07 01:23:03 +02:00
import esphomeyaml.config_validation as cv
2018-05-20 12:41:52 +02:00
from esphomeyaml import automation
2018-05-27 14:15:24 +02:00
from esphomeyaml.const import CONF_ABOVE, CONF_ACCURACY_DECIMALS, CONF_ALPHA, CONF_BELOW, \
CONF_DEBOUNCE, CONF_DELTA, CONF_EXPIRE_AFTER, CONF_EXPONENTIAL_MOVING_AVERAGE, CONF_FILTERS, \
2018-06-13 23:01:50 +02:00
CONF_FILTER_NAN, CONF_FILTER_OUT, CONF_HEARTBEAT, CONF_ICON, CONF_ID, CONF_INTERNAL, \
CONF_LAMBDA, CONF_MQTT_ID, CONF_MULTIPLY, CONF_OFFSET, CONF_ON_RAW_VALUE, CONF_ON_VALUE, \
2018-05-20 12:41:52 +02:00
CONF_ON_VALUE_RANGE, CONF_OR, CONF_SEND_EVERY, CONF_SLIDING_WINDOW_MOVING_AVERAGE, \
CONF_THROTTLE, CONF_TRIGGER_ID, CONF_UNIQUE, CONF_UNIT_OF_MEASUREMENT, CONF_WINDOW_SIZE, \
CONF_SEND_FIRST_AT
2018-06-13 23:01:50 +02:00
from esphomeyaml.helpers import App, ArrayInitializer, Pvariable, add, add_job, esphomelib_ns, \
float_, process_lambda, setup_mqtt_component, templatable
2018-04-07 01:23:03 +02:00
PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA.extend({
})
2018-05-17 21:31:39 +02:00
def validate_recursive_filter(value):
return FILTERS_SCHEMA(value)
def validate_send_first_at(value):
send_first_at = value.get(CONF_SEND_FIRST_AT)
send_every = value[CONF_SEND_EVERY]
if send_first_at is not None and send_first_at > send_every:
raise vol.Invalid("send_first_at must be smaller than or equal to send_every! {} <= {}"
"".format(send_first_at, send_every))
return value
2018-05-20 12:41:52 +02:00
FILTER_KEYS = [CONF_OFFSET, CONF_MULTIPLY, CONF_FILTER_OUT, CONF_FILTER_NAN,
CONF_SLIDING_WINDOW_MOVING_AVERAGE, CONF_EXPONENTIAL_MOVING_AVERAGE, CONF_LAMBDA,
CONF_THROTTLE, CONF_DELTA, CONF_UNIQUE, CONF_HEARTBEAT, CONF_DEBOUNCE, CONF_OR]
FILTERS_SCHEMA = vol.All(cv.ensure_list, [vol.All({
vol.Optional(CONF_OFFSET): vol.Coerce(float),
vol.Optional(CONF_MULTIPLY): vol.Coerce(float),
vol.Optional(CONF_FILTER_OUT): vol.Coerce(float),
vol.Optional(CONF_FILTER_NAN): None,
vol.Optional(CONF_SLIDING_WINDOW_MOVING_AVERAGE): vol.All(vol.Schema({
2018-05-20 12:41:52 +02:00
vol.Required(CONF_WINDOW_SIZE): cv.positive_not_null_int,
vol.Required(CONF_SEND_EVERY): cv.positive_not_null_int,
vol.Optional(CONF_SEND_FIRST_AT): cv.positive_not_null_int,
}), validate_send_first_at),
2018-05-20 12:41:52 +02:00
vol.Optional(CONF_EXPONENTIAL_MOVING_AVERAGE): vol.Schema({
vol.Required(CONF_ALPHA): cv.positive_float,
vol.Required(CONF_SEND_EVERY): cv.positive_not_null_int,
2018-04-07 01:23:03 +02:00
}),
2018-05-20 12:41:52 +02:00
vol.Optional(CONF_LAMBDA): cv.lambda_,
vol.Optional(CONF_THROTTLE): cv.positive_time_period_milliseconds,
vol.Optional(CONF_DELTA): vol.Coerce(float),
vol.Optional(CONF_UNIQUE): None,
vol.Optional(CONF_HEARTBEAT): cv.positive_time_period_milliseconds,
vol.Optional(CONF_DEBOUNCE): cv.positive_time_period_milliseconds,
vol.Optional(CONF_OR): validate_recursive_filter,
}, cv.has_exactly_one_key(*FILTER_KEYS))])
2018-05-20 12:41:52 +02:00
# pylint: disable=invalid-name
2018-05-20 12:41:52 +02:00
sensor_ns = esphomelib_ns.namespace('sensor')
Sensor = sensor_ns.Sensor
MQTTSensorComponent = sensor_ns.MQTTSensorComponent
OffsetFilter = sensor_ns.OffsetFilter
MultiplyFilter = sensor_ns.MultiplyFilter
FilterOutValueFilter = sensor_ns.FilterOutValueFilter
FilterOutNANFilter = sensor_ns.FilterOutNANFilter
SlidingWindowMovingAverageFilter = sensor_ns.SlidingWindowMovingAverageFilter
ExponentialMovingAverageFilter = sensor_ns.ExponentialMovingAverageFilter
LambdaFilter = sensor_ns.LambdaFilter
ThrottleFilter = sensor_ns.ThrottleFilter
DeltaFilter = sensor_ns.DeltaFilter
OrFilter = sensor_ns.OrFilter
HeartbeatFilter = sensor_ns.HeartbeatFilter
DebounceFilter = sensor_ns.DebounceFilter
UniqueFilter = sensor_ns.UniqueFilter
SensorStateTrigger = sensor_ns.SensorStateTrigger
SensorRawStateTrigger = sensor_ns.SensorRawStateTrigger
2018-05-20 12:41:52 +02:00
ValueRangeTrigger = sensor_ns.ValueRangeTrigger
2018-04-07 01:23:03 +02:00
2018-06-02 22:22:20 +02:00
SENSOR_SCHEMA = cv.MQTT_COMPONENT_SCHEMA.extend({
cv.GenerateID(CONF_MQTT_ID): cv.declare_variable_id(MQTTSensorComponent),
cv.GenerateID(): cv.declare_variable_id(Sensor),
vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string_strict,
vol.Optional(CONF_ICON): cv.icon,
vol.Optional(CONF_ACCURACY_DECIMALS): vol.Coerce(int),
vol.Optional(CONF_EXPIRE_AFTER): vol.Any(None, cv.positive_time_period_milliseconds),
vol.Optional(CONF_FILTERS): FILTERS_SCHEMA,
vol.Optional(CONF_ON_VALUE): automation.validate_automation({
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_variable_id(SensorStateTrigger),
}),
vol.Optional(CONF_ON_RAW_VALUE): automation.validate_automation({
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_variable_id(SensorRawStateTrigger),
}),
vol.Optional(CONF_ON_VALUE_RANGE): automation.validate_automation({
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_variable_id(ValueRangeTrigger),
vol.Optional(CONF_ABOVE): vol.Coerce(float),
vol.Optional(CONF_BELOW): vol.Coerce(float),
}, cv.has_at_least_one_key(CONF_ABOVE, CONF_BELOW)),
2018-06-02 22:22:20 +02:00
})
SENSOR_PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(SENSOR_SCHEMA.schema)
2018-04-07 01:23:03 +02:00
def setup_filter(config):
if CONF_OFFSET in config:
2018-06-02 22:22:20 +02:00
yield OffsetFilter.new(config[CONF_OFFSET])
elif CONF_MULTIPLY in config:
yield MultiplyFilter.new(config[CONF_MULTIPLY])
elif CONF_FILTER_OUT in config:
yield FilterOutValueFilter.new(config[CONF_FILTER_OUT])
elif CONF_FILTER_NAN in config:
2018-06-04 20:47:15 +02:00
yield FilterOutNANFilter.new()
2018-06-02 22:22:20 +02:00
elif CONF_SLIDING_WINDOW_MOVING_AVERAGE in config:
2018-04-07 01:23:03 +02:00
conf = config[CONF_SLIDING_WINDOW_MOVING_AVERAGE]
yield SlidingWindowMovingAverageFilter.new(conf[CONF_WINDOW_SIZE], conf[CONF_SEND_EVERY],
conf.get(CONF_SEND_FIRST_AT))
2018-06-02 22:22:20 +02:00
elif CONF_EXPONENTIAL_MOVING_AVERAGE in config:
2018-04-07 01:23:03 +02:00
conf = config[CONF_EXPONENTIAL_MOVING_AVERAGE]
2018-06-02 22:22:20 +02:00
yield ExponentialMovingAverageFilter.new(conf[CONF_ALPHA], conf[CONF_SEND_EVERY])
elif CONF_LAMBDA in config:
lambda_ = None
for lambda_ in process_lambda(config[CONF_LAMBDA], [(float_, 'x')]):
yield None
yield LambdaFilter.new(lambda_)
elif CONF_THROTTLE in config:
yield ThrottleFilter.new(config[CONF_THROTTLE])
elif CONF_DELTA in config:
yield DeltaFilter.new(config[CONF_DELTA])
elif CONF_OR in config:
2018-06-06 08:12:39 +02:00
filters = None
for filters in setup_filters(config[CONF_OR]):
yield None
yield OrFilter.new(filters)
2018-06-02 22:22:20 +02:00
elif CONF_HEARTBEAT in config:
yield App.register_component(HeartbeatFilter.new(config[CONF_HEARTBEAT]))
elif CONF_DEBOUNCE in config:
yield App.register_component(DebounceFilter.new(config[CONF_DEBOUNCE]))
elif CONF_UNIQUE in config:
yield UniqueFilter.new()
2018-04-07 01:23:03 +02:00
2018-05-17 21:31:39 +02:00
def setup_filters(config):
2018-06-02 22:22:20 +02:00
filters = []
for conf in config:
filter = None
for filter in setup_filter(conf):
2018-06-06 08:12:39 +02:00
yield None
2018-06-02 22:22:20 +02:00
filters.append(filter)
yield ArrayInitializer(*filters)
2018-05-17 21:31:39 +02:00
2018-05-20 12:41:52 +02:00
def setup_sensor_core_(sensor_var, mqtt_var, config):
if CONF_INTERNAL in config:
add(sensor_var.set_internal(config[CONF_INTERNAL]))
2018-05-20 12:41:52 +02:00
if CONF_UNIT_OF_MEASUREMENT in config:
add(sensor_var.set_unit_of_measurement(config[CONF_UNIT_OF_MEASUREMENT]))
if CONF_ICON in config:
add(sensor_var.set_icon(config[CONF_ICON]))
if CONF_ACCURACY_DECIMALS in config:
add(sensor_var.set_accuracy_decimals(config[CONF_ACCURACY_DECIMALS]))
if CONF_FILTERS in config:
2018-06-02 22:22:20 +02:00
filters = None
for filters in setup_filters(config[CONF_FILTERS]):
yield
add(sensor_var.set_filters(filters))
2018-05-20 12:41:52 +02:00
for conf in config.get(CONF_ON_VALUE, []):
rhs = sensor_var.make_state_trigger()
2018-06-02 22:22:20 +02:00
trigger = Pvariable(conf[CONF_TRIGGER_ID], rhs)
2018-06-03 07:11:11 +02:00
automation.build_automation(trigger, float_, conf)
2018-05-20 12:41:52 +02:00
for conf in config.get(CONF_ON_RAW_VALUE, []):
rhs = sensor_var.make_raw_state_trigger()
2018-06-02 22:22:20 +02:00
trigger = Pvariable(conf[CONF_TRIGGER_ID], rhs)
2018-06-03 07:11:11 +02:00
automation.build_automation(trigger, float_, conf)
2018-05-20 12:41:52 +02:00
for conf in config.get(CONF_ON_VALUE_RANGE, []):
rhs = sensor_var.make_value_range_trigger()
2018-06-02 22:22:20 +02:00
trigger = Pvariable(conf[CONF_TRIGGER_ID], rhs)
2018-05-27 14:15:24 +02:00
if CONF_ABOVE in conf:
2018-06-02 22:22:20 +02:00
template_ = None
for template_ in templatable(conf[CONF_ABOVE], float_, float_):
yield
add(trigger.set_min(template_))
2018-05-27 14:15:24 +02:00
if CONF_BELOW in conf:
2018-06-02 22:22:20 +02:00
template_ = None
for template_ in templatable(conf[CONF_BELOW], float_, float_):
yield
add(trigger.set_max(template_))
2018-06-03 07:11:11 +02:00
automation.build_automation(trigger, float_, conf)
2018-05-20 12:41:52 +02:00
if CONF_EXPIRE_AFTER in config:
if config[CONF_EXPIRE_AFTER] is None:
2018-05-20 12:41:52 +02:00
add(mqtt_var.disable_expire_after())
else:
2018-05-20 12:41:52 +02:00
add(mqtt_var.set_expire_after(config[CONF_EXPIRE_AFTER]))
setup_mqtt_component(mqtt_var, config)
2018-05-20 12:41:52 +02:00
def setup_sensor(sensor_obj, mqtt_obj, config):
2018-06-02 22:22:20 +02:00
sensor_var = Pvariable(config[CONF_ID], sensor_obj, has_side_effects=False)
mqtt_var = Pvariable(config[CONF_MQTT_ID], mqtt_obj, has_side_effects=False)
2018-06-03 07:11:11 +02:00
add_job(setup_sensor_core_, sensor_var, mqtt_var, config)
2018-04-07 01:23:03 +02:00
def register_sensor(var, config):
2018-06-02 22:22:20 +02:00
sensor_var = Pvariable(config[CONF_ID], var, has_side_effects=True)
2018-05-20 12:41:52 +02:00
rhs = App.register_sensor(sensor_var)
2018-06-02 22:22:20 +02:00
mqtt_var = Pvariable(config[CONF_MQTT_ID], rhs, has_side_effects=True)
2018-06-03 07:11:11 +02:00
add_job(setup_sensor_core_, sensor_var, mqtt_var, config)
2018-05-06 15:56:12 +02:00
BUILD_FLAGS = '-DUSE_SENSOR'
def core_to_hass_config(data, config):
ret = mqtt.build_hass_config(data, 'sensor', config, include_state=True, include_command=False)
if ret is None:
return None
if CONF_UNIT_OF_MEASUREMENT in config:
ret['unit_of_measurement'] = config[CONF_UNIT_OF_MEASUREMENT]
if CONF_EXPIRE_AFTER in config:
expire = config[CONF_EXPIRE_AFTER]
if expire is not None:
ret['expire_after'] = expire.total_seconds
if CONF_ICON in config:
ret['icon'] = config[CONF_ICON]
return ret