From 762f1b1fc9c109ae0ab6205c15c7b1ed2e4880eb Mon Sep 17 00:00:00 2001 From: Nikolay Vasilchuk Date: Wed, 3 Jul 2019 17:33:18 +0300 Subject: [PATCH] ZyAura CO2 / Temperature / Humidity Sensor (#656) * ZyAura sensors support * Validation * Small refactoring * Some checks * Small fix * Use floats, not double Co-Authored-By: Otto Winter * uint32_t now Co-Authored-By: Otto Winter * A constant for bits in a byte just over-complicates the source code Co-Authored-By: Otto Winter * Review fixes * Review fixes * Review fixes * Review fixes * Review fixes * Review fixes * Review fixes * Review fixes * Travis fixes * Travis fixes * Travis fixes --- esphome/components/zyaura/__init__.py | 0 esphome/components/zyaura/sensor.py | 43 ++++++++++ esphome/components/zyaura/zyaura.cpp | 117 ++++++++++++++++++++++++++ esphome/components/zyaura/zyaura.h | 86 +++++++++++++++++++ tests/test1.yaml | 9 ++ 5 files changed, 255 insertions(+) create mode 100644 esphome/components/zyaura/__init__.py create mode 100644 esphome/components/zyaura/sensor.py create mode 100644 esphome/components/zyaura/zyaura.cpp create mode 100644 esphome/components/zyaura/zyaura.h diff --git a/esphome/components/zyaura/__init__.py b/esphome/components/zyaura/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/esphome/components/zyaura/sensor.py b/esphome/components/zyaura/sensor.py new file mode 100644 index 0000000000..649b80b444 --- /dev/null +++ b/esphome/components/zyaura/sensor.py @@ -0,0 +1,43 @@ +import esphome.codegen as cg +import esphome.config_validation as cv +from esphome import pins +from esphome.components import sensor +from esphome.const import CONF_ID, CONF_CLOCK_PIN, CONF_DATA_PIN, \ + CONF_CO2, CONF_TEMPERATURE, CONF_HUMIDITY, \ + UNIT_PARTS_PER_MILLION, UNIT_CELSIUS, UNIT_PERCENT, \ + ICON_PERIODIC_TABLE_CO2, ICON_THERMOMETER, ICON_WATER_PERCENT +from esphome.cpp_helpers import gpio_pin_expression + +zyaura_ns = cg.esphome_ns.namespace('zyaura') +ZyAuraSensor = zyaura_ns.class_('ZyAuraSensor', cg.PollingComponent) + +CONFIG_SCHEMA = cv.Schema({ + cv.GenerateID(): cv.declare_id(ZyAuraSensor), + cv.Required(CONF_CLOCK_PIN): cv.All(pins.internal_gpio_input_pin_schema, + pins.validate_has_interrupt), + cv.Required(CONF_DATA_PIN): cv.All(pins.internal_gpio_input_pin_schema, + pins.validate_has_interrupt), + cv.Optional(CONF_CO2): sensor.sensor_schema(UNIT_PARTS_PER_MILLION, ICON_PERIODIC_TABLE_CO2, 0), + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema(UNIT_CELSIUS, ICON_THERMOMETER, 1), + cv.Optional(CONF_HUMIDITY): sensor.sensor_schema(UNIT_PERCENT, ICON_WATER_PERCENT, 1), +}).extend(cv.polling_component_schema('60s')) + + +def to_code(config): + var = cg.new_Pvariable(config[CONF_ID]) + yield cg.register_component(var, config) + + pin_clock = yield gpio_pin_expression(config[CONF_CLOCK_PIN]) + cg.add(var.set_pin_clock(pin_clock)) + pin_data = yield gpio_pin_expression(config[CONF_DATA_PIN]) + cg.add(var.set_pin_data(pin_data)) + + if CONF_CO2 in config: + sens = yield sensor.new_sensor(config[CONF_CO2]) + cg.add(var.set_co2_sensor(sens)) + if CONF_TEMPERATURE in config: + sens = yield sensor.new_sensor(config[CONF_TEMPERATURE]) + cg.add(var.set_temperature_sensor(sens)) + if CONF_HUMIDITY in config: + sens = yield sensor.new_sensor(config[CONF_HUMIDITY]) + cg.add(var.set_humidity_sensor(sens)) diff --git a/esphome/components/zyaura/zyaura.cpp b/esphome/components/zyaura/zyaura.cpp new file mode 100644 index 0000000000..3b1a2a5069 --- /dev/null +++ b/esphome/components/zyaura/zyaura.cpp @@ -0,0 +1,117 @@ +#include "zyaura.h" +#include "esphome/core/log.h" + +namespace esphome { +namespace zyaura { + +static const char *TAG = "zyaura"; + +bool ICACHE_RAM_ATTR ZaDataProcessor::decode(unsigned long ms, bool data) { + // check if a new message has started, based on time since previous bit + if ((ms - this->prev_ms_) > ZA_MAX_MS) { + this->num_bits_ = 0; + } + this->prev_ms_ = ms; + + // number of bits received is basically the "state" + if (this->num_bits_ < ZA_FRAME_SIZE) { + // store it while it fits + int idx = this->num_bits_ / 8; + this->buffer_[idx] = (this->buffer_[idx] << 1) | (data ? 1 : 0); + this->num_bits_++; + + // are we done yet? + if (this->num_bits_ == ZA_FRAME_SIZE) { + // validate checksum + uint8_t checksum = this->buffer_[ZA_BYTE_TYPE] + this->buffer_[ZA_BYTE_HIGH] + this->buffer_[ZA_BYTE_LOW]; + if (checksum != this->buffer_[ZA_BYTE_SUM] || this->buffer_[ZA_BYTE_END] != ZA_MSG_DELIMETER) { + return false; + } + + this->message->type = (ZaDataType) this->buffer_[ZA_BYTE_TYPE]; + this->message->value = this->buffer_[ZA_BYTE_HIGH] << 8 | this->buffer_[ZA_BYTE_LOW]; + return true; + } + } + + return false; +} + +void ZaSensorStore::setup(GPIOPin *pin_clock, GPIOPin *pin_data) { + pin_clock->setup(); + pin_data->setup(); + this->pin_clock_ = pin_clock->to_isr(); + this->pin_data_ = pin_data->to_isr(); + pin_clock->attach_interrupt(ZaSensorStore::interrupt, this, FALLING); +} + +void ICACHE_RAM_ATTR ZaSensorStore::interrupt(ZaSensorStore *arg) { + uint32_t now = millis(); + bool data_bit = arg->pin_data_->digital_read(); + + if (arg->processor_.decode(now, data_bit)) { + arg->set_data_(arg->processor_.message); + } +} + +void ICACHE_RAM_ATTR ZaSensorStore::set_data_(ZaMessage *message) { + switch (message->type) { + case HUMIDITY: + this->humidity = (message->value > 10000) ? NAN : (message->value / 100.0f); + break; + + case TEMPERATURE: + this->temperature = (message->value > 5970) ? NAN : (message->value / 16.0f - 273.15f); + break; + + case CO2: + this->co2 = (message->value > 10000) ? NAN : message->value; + break; + + default: + break; + } +} + +bool ZyAuraSensor::publish_state_(sensor::Sensor *sensor, float *value) { + // Sensor doesn't added to configuration + if (sensor == nullptr) { + return true; + } + + sensor->publish_state(*value); + + // Sensor reported wrong value + if (isnan(*value)) { + ESP_LOGW(TAG, "Sensor reported invalid data. Is the update interval too small?"); + this->status_set_warning(); + return false; + } + + *value = NAN; + return true; +} + +void ZyAuraSensor::dump_config() { + ESP_LOGCONFIG(TAG, "ZyAuraSensor:"); + LOG_PIN(" Pin Clock: ", this->pin_clock_); + LOG_PIN(" Pin Data: ", this->pin_data_); + LOG_UPDATE_INTERVAL(this); + + LOG_SENSOR(" ", "CO2", this->co2_sensor_); + LOG_SENSOR(" ", "Temperature", this->temperature_sensor_); + LOG_SENSOR(" ", "Humidity", this->humidity_sensor_); +} + +void ZyAuraSensor::update() { + bool co2_result = this->publish_state_(this->co2_sensor_, &this->store_.co2); + bool temperature_result = this->publish_state_(this->temperature_sensor_, &this->store_.temperature); + bool humidity_result = this->publish_state_(this->humidity_sensor_, &this->store_.humidity); + + if (co2_result && temperature_result && humidity_result) { + this->status_clear_warning(); + } +} + +} // namespace zyaura +} // namespace esphome diff --git a/esphome/components/zyaura/zyaura.h b/esphome/components/zyaura/zyaura.h new file mode 100644 index 0000000000..fd26947e28 --- /dev/null +++ b/esphome/components/zyaura/zyaura.h @@ -0,0 +1,86 @@ +#pragma once + +#include "esphome/core/component.h" +#include "esphome/core/esphal.h" +#include "esphome/components/sensor/sensor.h" + +namespace esphome { +namespace zyaura { + +static const uint8_t ZA_MAX_MS = 2; +static const uint8_t ZA_MSG_LEN = 5; +static const uint8_t ZA_FRAME_SIZE = 40; +static const uint8_t ZA_MSG_DELIMETER = 0x0D; + +static const uint8_t ZA_BYTE_TYPE = 0; +static const uint8_t ZA_BYTE_HIGH = 1; +static const uint8_t ZA_BYTE_LOW = 2; +static const uint8_t ZA_BYTE_SUM = 3; +static const uint8_t ZA_BYTE_END = 4; + +enum ZaDataType { + HUMIDITY = 0x41, + TEMPERATURE = 0x42, + CO2 = 0x50, +}; + +struct ZaMessage { + ZaDataType type; + uint16_t value; +}; + +class ZaDataProcessor { + public: + bool decode(unsigned long ms, bool data); + ZaMessage *message = new ZaMessage; + + protected: + uint8_t buffer_[ZA_MSG_LEN]; + int num_bits_ = 0; + unsigned long prev_ms_; +}; + +class ZaSensorStore { + public: + float co2 = NAN; + float temperature = NAN; + float humidity = NAN; + + void setup(GPIOPin *pin_clock, GPIOPin *pin_data); + static void interrupt(ZaSensorStore *arg); + + protected: + ISRInternalGPIOPin *pin_clock_; + ISRInternalGPIOPin *pin_data_; + ZaDataProcessor processor_; + + void set_data_(ZaMessage *message); +}; + +/// Component for reading temperature/co2/humidity measurements from ZyAura sensors. +class ZyAuraSensor : public PollingComponent { + public: + void set_pin_clock(GPIOPin *pin) { pin_clock_ = pin; } + void set_pin_data(GPIOPin *pin) { pin_data_ = pin; } + void set_co2_sensor(sensor::Sensor *co2_sensor) { co2_sensor_ = co2_sensor; } + void set_temperature_sensor(sensor::Sensor *temperature_sensor) { temperature_sensor_ = temperature_sensor; } + void set_humidity_sensor(sensor::Sensor *humidity_sensor) { humidity_sensor_ = humidity_sensor; } + + void setup() override { this->store_.setup(this->pin_clock_, this->pin_data_); } + void dump_config() override; + void update() override; + float get_setup_priority() const override { return setup_priority::DATA; } + + protected: + ZaSensorStore store_; + GPIOPin *pin_clock_; + GPIOPin *pin_data_; + sensor::Sensor *co2_sensor_{nullptr}; + sensor::Sensor *temperature_sensor_{nullptr}; + sensor::Sensor *humidity_sensor_{nullptr}; + + bool publish_state_(sensor::Sensor *sensor, float *value); +}; + +} // namespace zyaura +} // namespace esphome diff --git a/tests/test1.yaml b/tests/test1.yaml index bfdc34fac1..4fa2f85cf6 100644 --- a/tests/test1.yaml +++ b/tests/test1.yaml @@ -564,6 +564,15 @@ sensor: name: CCS811 TVOC update_interval: 30s baseline: 0x4242 + - platform: zyaura + clock_pin: GPIO5 + data_pin: GPIO4 + co2: + name: "ZyAura CO2" + temperature: + name: "ZyAura Temperature" + humidity: + name: "ZyAura Humidity" esp32_touch: