From 49cb8fd9d384ad18a0183dc048d23abb6b776bde Mon Sep 17 00:00:00 2001 From: Alexander Pohl Date: Tue, 3 Nov 2020 18:36:11 +0100 Subject: [PATCH] Add support for ATC_MiThermometer (#1291) * Add support for additional Xiaomi BLE sensors (#1027) * Revert "Add support for additional Xiaomi BLE sensors (#1027)" This reverts commit b2723830f4ed1e29611e3688a2c9323c1071bc23. * initial ATC Mithermometer component * removed references to xiaomi_ble * temp, humi and batt in % working, todo: battery in mV * report battery level in volt * report battery level again in percent * Add files via upload * add ATC Mithermometer component * remove some comments * fix travis ci build issues * mark codeowner, make functions protected * add newlines, remove spaces * two lines after function or class definition * update codeowners * Bump flake8 from 3.8.3 to 3.8.4 Bumps [flake8](https://gitlab.com/pycqa/flake8) from 3.8.3 to 3.8.4. - [Release notes](https://gitlab.com/pycqa/flake8/tags) - [Commits](https://gitlab.com/pycqa/flake8/compare/3.8.3...3.8.4) Signed-off-by: dependabot[bot] * Add files via upload * Bump pytest from 6.0.2 to 6.1.1 Bumps [pytest](https://github.com/pytest-dev/pytest) from 6.0.2 to 6.1.1. - [Release notes](https://github.com/pytest-dev/pytest/releases) - [Changelog](https://github.com/pytest-dev/pytest/blob/master/CHANGELOG.rst) - [Commits](https://github.com/pytest-dev/pytest/compare/6.0.2...6.1.1) Signed-off-by: dependabot[bot] * add ATC battery voltage to test2.yaml * fix lint-python * Bump colorlog from 4.2.1 to 4.4.0 Bumps [colorlog](https://github.com/borntyping/python-colorlog) from 4.2.1 to 4.4.0. - [Release notes](https://github.com/borntyping/python-colorlog/releases) - [Commits](https://github.com/borntyping/python-colorlog/compare/v4.2.1...v4.4.0) Signed-off-by: dependabot[bot] * Bump voluptuous from 0.11.7 to 0.12.0 Bumps [voluptuous](https://github.com/alecthomas/voluptuous) from 0.11.7 to 0.12.0. - [Release notes](https://github.com/alecthomas/voluptuous/releases) - [Changelog](https://github.com/alecthomas/voluptuous/blob/master/CHANGELOG.md) - [Commits](https://github.com/alecthomas/voluptuous/commits/v0.12.0) Signed-off-by: dependabot[bot] * restore requirements * move codeowner above dependencies * Revert "restore requirements" This reverts commit 3c9fd8b42183ff251c68404ae5e75d72ded00006. * Revert "Bump voluptuous from 0.11.7 to 0.12.0" This reverts commit 8eb0dba1c3f2fdcad28f6970381021a04a4051e7. * Revert "Bump flake8 from 3.8.3 to 3.8.4" This reverts commit 20952632dba032f70b97c86cac5daa84521c1840. * Revert "Bump colorlog from 4.2.1 to 4.4.0" This reverts commit 87bbf95d860a3213e5c9a909cbf6325f00e9094e. * Revert "Bump pytest from 6.0.2 to 6.1.1" This reverts commit 1b6ed8043137d8e8f38de32824cfa113dbc5a0ec. Co-authored-by: vevsvevs Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- CODEOWNERS | 2 + .../components/atc_mithermometer/__init__.py | 0 .../atc_mithermometer/atc_mithermometer.cpp | 137 ++++++++++++++++++ .../atc_mithermometer/atc_mithermometer.h | 48 ++++++ .../components/atc_mithermometer/sensor.py | 45 ++++++ .../components/xiaomi_lywsd03mmc/sensor.py | 2 + tests/test2.yaml | 11 +- 7 files changed, 244 insertions(+), 1 deletion(-) create mode 100644 esphome/components/atc_mithermometer/__init__.py create mode 100644 esphome/components/atc_mithermometer/atc_mithermometer.cpp create mode 100644 esphome/components/atc_mithermometer/atc_mithermometer.h create mode 100644 esphome/components/atc_mithermometer/sensor.py diff --git a/CODEOWNERS b/CODEOWNERS index 488753e1d0..e6832d1580 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -15,6 +15,7 @@ esphome/components/ac_dimmer/* @glmnet esphome/components/adc/* @esphome/core esphome/components/api/* @OttoWinter esphome/components/async_tcp/* @OttoWinter +esphome/components/atc_mithermometer/* @ahpohl esphome/components/bang_bang/* @OttoWinter esphome/components/binary_sensor/* @esphome/core esphome/components/captive_portal/* @OttoWinter @@ -72,3 +73,4 @@ esphome/components/ultrasonic/* @OttoWinter esphome/components/version/* @esphome/core esphome/components/web_server_base/* @OttoWinter esphome/components/whirlpool/* @glmnet +esphome/components/xiaomi_lywsd03mmc/* @ahpohl diff --git a/esphome/components/atc_mithermometer/__init__.py b/esphome/components/atc_mithermometer/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/esphome/components/atc_mithermometer/atc_mithermometer.cpp b/esphome/components/atc_mithermometer/atc_mithermometer.cpp new file mode 100644 index 0000000000..1a555cfa83 --- /dev/null +++ b/esphome/components/atc_mithermometer/atc_mithermometer.cpp @@ -0,0 +1,137 @@ +#include "atc_mithermometer.h" +#include "esphome/core/log.h" + +#ifdef ARDUINO_ARCH_ESP32 + +namespace esphome { +namespace atc_mithermometer { + +static const char *TAG = "atc_mithermometer"; + +void ATCMiThermometer::dump_config() { + ESP_LOGCONFIG(TAG, "ATC MiThermometer"); + LOG_SENSOR(" ", "Temperature", this->temperature_); + LOG_SENSOR(" ", "Humidity", this->humidity_); + LOG_SENSOR(" ", "Battery Level", this->battery_level_); + LOG_SENSOR(" ", "Battery Voltage", this->battery_voltage_); +} + +bool ATCMiThermometer::parse_device(const esp32_ble_tracker::ESPBTDevice &device) { + if (device.address_uint64() != this->address_) { + ESP_LOGVV(TAG, "parse_device(): unknown MAC address."); + return false; + } + ESP_LOGVV(TAG, "parse_device(): MAC address %s found.", device.address_str().c_str()); + + bool success = false; + for (auto &service_data : device.get_service_datas()) { + auto res = parse_header(service_data); + if (res->is_duplicate) { + continue; + } + if (!(parse_message(service_data.data, *res))) { + continue; + } + if (!(report_results(res, device.address_str()))) { + continue; + } + if (res->temperature.has_value() && this->temperature_ != nullptr) + this->temperature_->publish_state(*res->temperature); + if (res->humidity.has_value() && this->humidity_ != nullptr) + this->humidity_->publish_state(*res->humidity); + if (res->battery_level.has_value() && this->battery_level_ != nullptr) + this->battery_level_->publish_state(*res->battery_level); + if (res->battery_voltage.has_value() && this->battery_voltage_ != nullptr) + this->battery_voltage_->publish_state(*res->battery_voltage); + success = true; + } + + if (!success) { + return false; + } + + return true; +} + +optional ATCMiThermometer::parse_header(const esp32_ble_tracker::ServiceData &service_data) { + ParseResult result; + if (!service_data.uuid.contains(0x1A, 0x18)) { + ESP_LOGVV(TAG, "parse_header(): no service data UUID magic bytes."); + return {}; + } + + auto raw = service_data.data; + + static uint8_t last_frame_count = 0; + if (last_frame_count == raw[12]) { + ESP_LOGVV(TAG, "parse_header(): duplicate data packet received (%d).", static_cast(last_frame_count)); + result.is_duplicate = true; + return {}; + } + last_frame_count = raw[12]; + result.is_duplicate = false; + + return result; +} + +bool ATCMiThermometer::parse_message(const std::vector &message, ParseResult &result) { + // Byte 0-5 mac in correct order + // Byte 6-7 Temperature in uint16 + // Byte 8 Humidity in percent + // Byte 9 Battery in percent + // Byte 10-11 Battery in mV uint16_t + // Byte 12 frame packet counter + + const uint8_t *data = message.data(); + const int data_length = 13; + + if (message.size() != data_length) { + ESP_LOGVV(TAG, "parse_message(): payload has wrong size (%d)!", message.size()); + return false; + } + + // temperature, 2 bytes, 16-bit signed integer (LE), 0.1 °C + const int16_t temperature = uint16_t(data[7]) | (uint16_t(data[6]) << 8); + result.temperature = temperature / 10.0f; + + // humidity, 1 byte, 8-bit unsigned integer, 1.0 % + result.humidity = data[8]; + + // battery, 1 byte, 8-bit unsigned integer, 1.0 % + result.battery_level = data[9]; + + // battery, 2 bytes, 16-bit unsigned integer, 0.001 V + const int16_t battery_voltage = uint16_t(data[11]) | (uint16_t(data[10]) << 8); + result.battery_voltage = battery_voltage / 1.0e3f; + + return true; +} + +bool ATCMiThermometer::report_results(const optional &result, const std::string &address) { + if (!result.has_value()) { + ESP_LOGVV(TAG, "report_results(): no results available."); + return false; + } + + ESP_LOGD(TAG, "Got ATC MiThermometer (%s):", address.c_str()); + + if (result->temperature.has_value()) { + ESP_LOGD(TAG, " Temperature: %.1f °C", *result->temperature); + } + if (result->humidity.has_value()) { + ESP_LOGD(TAG, " Humidity: %.0f %%", *result->humidity); + } + if (result->battery_level.has_value()) { + ESP_LOGD(TAG, " Battery Level: %.0f %%", *result->battery_level); + } + if (result->battery_voltage.has_value()) { + ESP_LOGD(TAG, " Battery Voltage: %.3f V", *result->battery_voltage); + } + + return true; +} + +} // namespace atc_mithermometer +} // namespace esphome + +#endif diff --git a/esphome/components/atc_mithermometer/atc_mithermometer.h b/esphome/components/atc_mithermometer/atc_mithermometer.h new file mode 100644 index 0000000000..203dca3200 --- /dev/null +++ b/esphome/components/atc_mithermometer/atc_mithermometer.h @@ -0,0 +1,48 @@ +#pragma once + +#include "esphome/core/component.h" +#include "esphome/components/sensor/sensor.h" +#include "esphome/components/esp32_ble_tracker/esp32_ble_tracker.h" + +#ifdef ARDUINO_ARCH_ESP32 + +namespace esphome { +namespace atc_mithermometer { + +struct ParseResult { + optional temperature; + optional humidity; + optional battery_level; + optional battery_voltage; + bool is_duplicate; + int raw_offset; +}; + +class ATCMiThermometer : public Component, public esp32_ble_tracker::ESPBTDeviceListener { + public: + void set_address(uint64_t address) { address_ = address; }; + + bool parse_device(const esp32_ble_tracker::ESPBTDevice &device) override; + void dump_config() override; + float get_setup_priority() const override { return setup_priority::DATA; } + void set_temperature(sensor::Sensor *temperature) { temperature_ = temperature; } + void set_humidity(sensor::Sensor *humidity) { humidity_ = humidity; } + void set_battery_level(sensor::Sensor *battery_level) { battery_level_ = battery_level; } + void set_battery_voltage(sensor::Sensor *battery_voltage) { battery_voltage_ = battery_voltage; } + + protected: + uint64_t address_; + sensor::Sensor *temperature_{nullptr}; + sensor::Sensor *humidity_{nullptr}; + sensor::Sensor *battery_level_{nullptr}; + sensor::Sensor *battery_voltage_{nullptr}; + + optional parse_header(const esp32_ble_tracker::ServiceData &service_data); + bool parse_message(const std::vector &message, ParseResult &result); + bool report_results(const optional &result, const std::string &address); +}; + +} // namespace atc_mithermometer +} // namespace esphome + +#endif diff --git a/esphome/components/atc_mithermometer/sensor.py b/esphome/components/atc_mithermometer/sensor.py new file mode 100644 index 0000000000..550cd8d0f8 --- /dev/null +++ b/esphome/components/atc_mithermometer/sensor.py @@ -0,0 +1,45 @@ +import esphome.codegen as cg +import esphome.config_validation as cv +from esphome.components import sensor, esp32_ble_tracker +from esphome.const import CONF_BATTERY_LEVEL, CONF_BATTERY_VOLTAGE, CONF_MAC_ADDRESS, \ + CONF_HUMIDITY, CONF_TEMPERATURE, CONF_ID, UNIT_CELSIUS, UNIT_PERCENT, UNIT_VOLT, \ + ICON_BATTERY, ICON_THERMOMETER, ICON_WATER_PERCENT + +CODEOWNERS = ['@ahpohl'] + +DEPENDENCIES = ['esp32_ble_tracker'] + +atc_mithermometer_ns = cg.esphome_ns.namespace('atc_mithermometer') +ATCMiThermometer = atc_mithermometer_ns.class_('ATCMiThermometer', + esp32_ble_tracker.ESPBTDeviceListener, + cg.Component) + +CONFIG_SCHEMA = cv.Schema({ + cv.GenerateID(): cv.declare_id(ATCMiThermometer), + cv.Required(CONF_MAC_ADDRESS): cv.mac_address, + cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema(UNIT_CELSIUS, ICON_THERMOMETER, 1), + cv.Optional(CONF_HUMIDITY): sensor.sensor_schema(UNIT_PERCENT, ICON_WATER_PERCENT, 0), + cv.Optional(CONF_BATTERY_LEVEL): sensor.sensor_schema(UNIT_PERCENT, ICON_BATTERY, 0), + cv.Optional(CONF_BATTERY_VOLTAGE): sensor.sensor_schema(UNIT_VOLT, ICON_BATTERY, 3), +}).extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA).extend(cv.COMPONENT_SCHEMA) + + +def to_code(config): + var = cg.new_Pvariable(config[CONF_ID]) + yield cg.register_component(var, config) + yield esp32_ble_tracker.register_ble_device(var, config) + + cg.add(var.set_address(config[CONF_MAC_ADDRESS].as_hex)) + + if CONF_TEMPERATURE in config: + sens = yield sensor.new_sensor(config[CONF_TEMPERATURE]) + cg.add(var.set_temperature(sens)) + if CONF_HUMIDITY in config: + sens = yield sensor.new_sensor(config[CONF_HUMIDITY]) + cg.add(var.set_humidity(sens)) + if CONF_BATTERY_LEVEL in config: + sens = yield sensor.new_sensor(config[CONF_BATTERY_LEVEL]) + cg.add(var.set_battery_level(sens)) + if CONF_BATTERY_VOLTAGE in config: + sens = yield sensor.new_sensor(config[CONF_BATTERY_VOLTAGE]) + cg.add(var.set_battery_voltage(sens)) diff --git a/esphome/components/xiaomi_lywsd03mmc/sensor.py b/esphome/components/xiaomi_lywsd03mmc/sensor.py index 9ecf3f64a9..a1983825fe 100644 --- a/esphome/components/xiaomi_lywsd03mmc/sensor.py +++ b/esphome/components/xiaomi_lywsd03mmc/sensor.py @@ -5,6 +5,8 @@ from esphome.const import CONF_BATTERY_LEVEL, CONF_HUMIDITY, CONF_MAC_ADDRESS, C UNIT_CELSIUS, ICON_THERMOMETER, UNIT_PERCENT, ICON_WATER_PERCENT, ICON_BATTERY, CONF_ID, \ CONF_BINDKEY +CODEOWNERS = ['@ahpohl'] + DEPENDENCIES = ['esp32_ble_tracker'] AUTO_LOAD = ['xiaomi_ble'] diff --git a/tests/test2.yaml b/tests/test2.yaml index 54034f0f04..19bd6e8c28 100644 --- a/tests/test2.yaml +++ b/tests/test2.yaml @@ -171,7 +171,16 @@ sensor: name: "JQJCY01YM Formaldehyde" battery_level: name: "JQJCY01YM Battery Level" - + - platform: atc_mithermometer + mac_address: "A4:C1:38:4E:16:78" + temperature: + name: "ATC Temperature" + humidity: + name: "ATC Humidity" + battery_level: + name: "ATC Battery-Level" + battery_voltage: + name: "ATC Battery-Voltage" time: - platform: homeassistant