diff --git a/esphomeyaml/components/binary_sensor/__init__.py b/esphomeyaml/components/binary_sensor/__init__.py index 82da0a9ce9..232f6a8dbc 100644 --- a/esphomeyaml/components/binary_sensor/__init__.py +++ b/esphomeyaml/components/binary_sensor/__init__.py @@ -1,14 +1,15 @@ import voluptuous as vol +from esphomeyaml import automation, core from esphomeyaml.components import mqtt import esphomeyaml.config_validation as cv -from esphomeyaml import automation -from esphomeyaml.const import CONF_DEVICE_CLASS, CONF_ID, CONF_INTERNAL, CONF_INVERTED, \ - CONF_MAX_LENGTH, CONF_MIN_LENGTH, CONF_MQTT_ID, CONF_ON_CLICK, CONF_ON_DOUBLE_CLICK, \ - CONF_ON_PRESS, CONF_ON_RELEASE, CONF_TRIGGER_ID, CONF_FILTERS, CONF_INVERT, CONF_DELAYED_ON, \ - CONF_DELAYED_OFF, CONF_LAMBDA, CONF_HEARTBEAT -from esphomeyaml.helpers import App, NoArg, Pvariable, add, add_job, esphomelib_ns, \ - setup_mqtt_component, bool_, process_lambda, ArrayInitializer +from esphomeyaml.const import CONF_DELAYED_OFF, CONF_DELAYED_ON, CONF_DEVICE_CLASS, CONF_FILTERS, \ + CONF_HEARTBEAT, CONF_ID, CONF_INTERNAL, CONF_INVALID_COOLDOWN, CONF_INVERT, CONF_INVERTED, \ + CONF_LAMBDA, CONF_MAX_LENGTH, CONF_MIN_LENGTH, CONF_MQTT_ID, CONF_ON_CLICK, \ + CONF_ON_DOUBLE_CLICK, CONF_ON_MULTI_CLICK, CONF_ON_PRESS, CONF_ON_RELEASE, CONF_STATE, \ + CONF_TIMING, CONF_TRIGGER_ID +from esphomeyaml.helpers import App, ArrayInitializer, NoArg, Pvariable, StructInitializer, add, \ + add_job, bool_, esphomelib_ns, process_lambda, setup_mqtt_component DEVICE_CLASSES = [ '', 'battery', 'cold', 'connectivity', 'door', 'garage_door', 'gas', @@ -26,6 +27,8 @@ PressTrigger = binary_sensor_ns.PressTrigger ReleaseTrigger = binary_sensor_ns.ReleaseTrigger ClickTrigger = binary_sensor_ns.ClickTrigger DoubleClickTrigger = binary_sensor_ns.DoubleClickTrigger +MultiClickTrigger = binary_sensor_ns.MultiClickTrigger +MultiClickTriggerEvent = binary_sensor_ns.MultiClickTriggerEvent BinarySensor = binary_sensor_ns.BinarySensor InvertFilter = binary_sensor_ns.InvertFilter LambdaFilter = binary_sensor_ns.LambdaFilter @@ -44,6 +47,99 @@ FILTERS_SCHEMA = vol.All(cv.ensure_list, [vol.All({ vol.Optional(CONF_LAMBDA): cv.lambda_, }, cv.has_exactly_one_key(*FILTER_KEYS))]) +MULTI_CLICK_TIMING_SCHEMA = vol.Schema({ + vol.Optional(CONF_STATE): cv.boolean, + vol.Optional(CONF_MIN_LENGTH): cv.positive_time_period_milliseconds, + vol.Optional(CONF_MAX_LENGTH): cv.positive_time_period_milliseconds, +}) + + +def parse_multi_click_timing_str(value): + if not isinstance(value, basestring): + return value + + parts = value.lower().split(' ') + if len(parts) != 5: + raise vol.Invalid("Multi click timing grammar consists of exactly 5 words, not {}" + "".format(len(parts))) + try: + state = cv.boolean(parts[0]) + except vol.Invalid: + raise vol.Invalid(u"First word must either be ON or OFF, not {}".format(parts[0])) + + if parts[1] != 'for': + raise vol.Invalid(u"Second word must be 'for', got {}".format(parts[1])) + + if parts[2] == 'at': + if parts[3] == 'least': + key = CONF_MIN_LENGTH + elif parts[3] == 'most': + key = CONF_MAX_LENGTH + else: + raise vol.Invalid(u"Third word after at must either be 'least' or 'most', got {}" + u"".format(parts[3])) + try: + length = cv.positive_time_period_milliseconds(parts[4]) + except vol.Invalid as err: + raise vol.Invalid(u"Multi Click Grammar Parsing length failed: {}".format(err)) + return { + CONF_STATE: state, + key: str(length) + } + + if parts[3] != 'to': + raise vol.Invalid("Multi click grammar: 4th word must be 'to'") + + try: + min_length = cv.positive_time_period_milliseconds(parts[2]) + except vol.Invalid as err: + raise vol.Invalid(u"Multi Click Grammar Parsing minimum length failed: {}".format(err)) + + try: + max_length = cv.positive_time_period_milliseconds(parts[4]) + except vol.Invalid as err: + raise vol.Invalid(u"Multi Click Grammar Parsing minimum length failed: {}".format(err)) + + return { + CONF_STATE: state, + CONF_MIN_LENGTH: str(min_length), + CONF_MAX_LENGTH: str(max_length) + } + + +def validate_multi_click_timing(value): + if not isinstance(value, list): + raise vol.Invalid("Timing option must be a *list* of times!") + timings = [] + state = None + for i, v_ in enumerate(value): + v_ = MULTI_CLICK_TIMING_SCHEMA(v_) + min_length = v_.get(CONF_MIN_LENGTH) + max_length = v_.get(CONF_MAX_LENGTH) + if min_length is None and max_length is None: + raise vol.Invalid("At least one of min_length and max_length is required!") + if min_length is None and max_length is not None: + min_length = core.TimePeriodMilliseconds(milliseconds=0) + + new_state = v_.get(CONF_STATE, not state) + if new_state == state: + raise vol.Invalid("Timings must have alternating state. Indices {} and {} have " + "the same state {}".format(i, i + 1, state)) + if max_length is not None and max_length < min_length: + raise vol.Invalid("Max length ({}) must be larger than min length ({})." + "".format(max_length, min_length)) + + state = new_state + tim = { + CONF_STATE: new_state, + CONF_MIN_LENGTH: min_length, + } + if max_length is not None: + tim[CONF_MAX_LENGTH] = max_length + timings.append(tim) + return timings + + BINARY_SENSOR_SCHEMA = cv.MQTT_COMPONENT_SCHEMA.extend({ cv.GenerateID(CONF_MQTT_ID): cv.declare_variable_id(MQTTBinarySensorComponent), cv.GenerateID(): cv.declare_variable_id(BinarySensor), @@ -66,6 +162,12 @@ BINARY_SENSOR_SCHEMA = cv.MQTT_COMPONENT_SCHEMA.extend({ vol.Optional(CONF_MIN_LENGTH, default='50ms'): cv.positive_time_period_milliseconds, vol.Optional(CONF_MAX_LENGTH, default='350ms'): cv.positive_time_period_milliseconds, }), + vol.Optional(CONF_ON_MULTI_CLICK): automation.validate_automation({ + cv.GenerateID(CONF_TRIGGER_ID): cv.declare_variable_id(MultiClickTrigger), + vol.Required(CONF_TIMING): vol.All([parse_multi_click_timing_str], + validate_multi_click_timing), + vol.Optional(CONF_INVALID_COOLDOWN): cv.positive_time_period_milliseconds, + }), vol.Optional(CONF_INVERTED): cv.invalid( "The inverted binary_sensor property has been replaced by the " @@ -137,6 +239,22 @@ def setup_binary_sensor_core_(binary_sensor_var, mqtt_var, config): trigger = Pvariable(conf[CONF_TRIGGER_ID], rhs) automation.build_automation(trigger, NoArg, conf) + for conf in config.get(CONF_ON_MULTI_CLICK, []): + timings = [] + for tim in conf[CONF_TIMING]: + timings.append(StructInitializer( + MultiClickTriggerEvent, + ('state', tim[CONF_STATE]), + ('min_length', tim[CONF_MIN_LENGTH]), + ('max_length', tim.get(CONF_MAX_LENGTH, 4294967294)), + )) + timings = ArrayInitializer(*timings, multiline=False) + rhs = App.register_component(binary_sensor_var.make_multi_click_trigger(timings)) + trigger = Pvariable(conf[CONF_TRIGGER_ID], rhs) + if CONF_INVALID_COOLDOWN in conf: + add(trigger.set_invalid_cooldown(conf[CONF_INVALID_COOLDOWN])) + automation.build_automation(trigger, NoArg, conf) + setup_mqtt_component(mqtt_var, config) diff --git a/esphomeyaml/config_validation.py b/esphomeyaml/config_validation.py index 09a30dab6b..c521de4d09 100644 --- a/esphomeyaml/config_validation.py +++ b/esphomeyaml/config_validation.py @@ -296,7 +296,8 @@ def time_period_str_colon(value): def time_period_str_unit(value): """Validate and transform time period with time unit and integer value.""" if isinstance(value, int): - value = str(value) + raise vol.Invalid("Don't know what '{}' means as it has no time *unit*! Did you mean " + "'{}s'?".format(value, value)) elif not isinstance(value, (str, unicode)): raise vol.Invalid("Expected string for time period with unit.") @@ -555,8 +556,14 @@ i2c_address = hex_uint8_t def percentage(value): - if isinstance(value, (str, unicode)) and value.endswith('%'): + has_percent_sign = isinstance(value, (str, unicode)) and value.endswith('%') + if has_percent_sign: value = float(value[:-1].rstrip()) / 100.0 + if value > 1: + msg = "Percentage must not be higher than 100%." + if not has_percent_sign: + msg += " Please don't put to put a percent sign after the number!" + raise vol.Invalid(msg) return zero_to_one_float(value) diff --git a/esphomeyaml/const.py b/esphomeyaml/const.py index 0eacce7392..f487a819d4 100644 --- a/esphomeyaml/const.py +++ b/esphomeyaml/const.py @@ -222,6 +222,7 @@ CONF_ON_PRESS = 'on_press' CONF_ON_RELEASE = 'on_release' CONF_ON_CLICK = 'on_click' CONF_ON_DOUBLE_CLICK = 'on_double_click' +CONF_ON_MULTI_CLICK = 'on_multi_click' CONF_MIN_LENGTH = 'min_length' CONF_MAX_LENGTH = 'max_length' CONF_ON_VALUE = 'on_value' @@ -360,6 +361,9 @@ CONF_DIR_PIN = 'dir_pin' CONF_SLEEP_PIN = 'sleep_pin' CONF_SEND_FIRST_AT = 'send_first_at' CONF_RESTORE_STATE = 'restore_state' +CONF_TIMING = 'timing' +CONF_INVALID_COOLDOWN = 'invalid_cooldown' + ALLOWED_NAME_CHARS = u'abcdefghijklmnopqrstuvwxyz0123456789_' ARDUINO_VERSION_ESP32_DEV = 'https://github.com/platformio/platform-espressif32.git#feature/stage' diff --git a/tests/test1.yaml b/tests/test1.yaml index caefcee0fe..6b75f7db26 100644 --- a/tests/test1.yaml +++ b/tests/test1.yaml @@ -498,6 +498,31 @@ binary_sensor: - then: - lambda: >- ESP_LOGD("main", "Double Clicked"); + on_multi_click: + - timing: + - ON for at most 1s + - OFF for at most 1s + - ON for at most 1s + - OFF for at least 0.2s + then: + - logger.log: + format: "Multi Clicked TWO" + level: warn + - timing: + - OFF for 1s to 2s + - ON for 1s to 2s + - OFF for at least 0.5s + then: + - logger.log: + format: "Multi Clicked LONG SINGLE" + level: warn + - timing: + - ON for at most 1s + - OFF for at least 0.5s + then: + - logger.log: + format: "Multi Clicked SINGLE" + level: warn id: binary_sensor1 - platform: status name: "Living Room Status"