Add AGS10 Sensor (#6070)

CODEOWNERS

@@ -22,6 +22,7 @@ esphome/components/ade7880/* @kpfleming
 esphome/components/ade7953/* @angelnu
 esphome/components/ade7953_i2c/* @angelnu
 esphome/components/ade7953_spi/* @angelnu
+esphome/components/ags10/* @mak-42
 esphome/components/airthings_ble/* @jeromelaban
 esphome/components/airthings_wave_base/* @jeromelaban @kpfleming @ncareau
 esphome/components/airthings_wave_mini/* @ncareau

esphome/components/ags10/__init__.py

@@ -0,0 +1 @@
+CODEOWNERS = ["@mak-42"]

esphome/components/ags10/ags10.cpp

@@ -0,0 +1,212 @@
+#include "ags10.h"
+
+namespace esphome {
+namespace ags10 {
+static const char *const TAG = "ags10";
+
+// Data acquisition.
+static const uint8_t REG_TVOC = 0x00;
+// Zero-point calibration.
+static const uint8_t REG_CALIBRATION = 0x01;
+// Read version.
+static const uint8_t REG_VERSION = 0x11;
+// Read current resistance.
+static const uint8_t REG_RESISTANCE = 0x20;
+// Modify target address.
+static const uint8_t REG_ADDRESS = 0x21;
+
+// Zero-point calibration with current resistance.
+static const uint16_t ZP_CURRENT = 0x0000;
+// Zero-point reset.
+static const uint16_t ZP_DEFAULT = 0xFFFF;
+
+void AGS10Component::setup() {
+  ESP_LOGCONFIG(TAG, "Setting up ags10...");
+
+  auto version = this->read_version_();
+  if (version) {
+    ESP_LOGD(TAG, "AGS10 Sensor Version: 0x%02X", *version);
+    if (this->version_ != nullptr) {
+      this->version_->publish_state(*version);
+    }
+  } else {
+    ESP_LOGE(TAG, "AGS10 Sensor Version: unknown");
+  }
+
+  auto resistance = this->read_resistance_();
+  if (resistance) {
+    ESP_LOGD(TAG, "AGS10 Sensor Resistance: 0x%08X", *resistance);
+    if (this->resistance_ != nullptr) {
+      this->resistance_->publish_state(*resistance);
+    }
+  } else {
+    ESP_LOGE(TAG, "AGS10 Sensor Resistance: unknown");
+  }
+
+  ESP_LOGD(TAG, "Sensor initialized");
+}
+
+void AGS10Component::update() {
+  auto tvoc = this->read_tvoc_();
+  if (tvoc) {
+    this->tvoc_->publish_state(*tvoc);
+    this->status_clear_warning();
+  } else {
+    this->status_set_warning();
+  }
+}
+
+void AGS10Component::dump_config() {
+  ESP_LOGCONFIG(TAG, "AGS10:");
+  LOG_I2C_DEVICE(this);
+  switch (this->error_code_) {
+    case NONE:
+      break;
+    case COMMUNICATION_FAILED:
+      ESP_LOGE(TAG, "Communication with AGS10 failed!");
+      break;
+    case CRC_CHECK_FAILED:
+      ESP_LOGE(TAG, "The crc check failed");
+      break;
+    case ILLEGAL_STATUS:
+      ESP_LOGE(TAG, "AGS10 is not ready to return TVOC data or sensor in pre-heat stage.");
+      break;
+    case UNSUPPORTED_UNITS:
+      ESP_LOGE(TAG, "AGS10 returns TVOC data in unsupported units.");
+      break;
+    default:
+      ESP_LOGE(TAG, "Unknown error: %d", this->error_code_);
+      break;
+  }
+  LOG_UPDATE_INTERVAL(this);
+  LOG_SENSOR("  ", "TVOC Sensor", this->tvoc_);
+  LOG_SENSOR("  ", "Firmware Version Sensor", this->version_);
+  LOG_SENSOR("  ", "Resistance Sensor", this->resistance_);
+}
+
+/**
+ * Sets new I2C address of AGS10.
+ */
+bool AGS10Component::new_i2c_address(uint8_t newaddress) {
+  uint8_t rev_newaddress = ~newaddress;
+  std::array<uint8_t, 5> data{newaddress, rev_newaddress, newaddress, rev_newaddress, 0};
+  data[4] = calc_crc8_(data, 4);
+  if (!this->write_bytes(REG_ADDRESS, data)) {
+    this->error_code_ = COMMUNICATION_FAILED;
+    this->status_set_warning();
+    ESP_LOGE(TAG, "couldn't write the new I2C address 0x%02X", newaddress);
+    return false;
+  }
+  this->set_i2c_address(newaddress);
+  ESP_LOGW(TAG, "changed I2C address to 0x%02X", newaddress);
+  this->error_code_ = NONE;
+  this->status_clear_warning();
+  return true;
+}
+
+bool AGS10Component::set_zero_point_with_factory_defaults() { return this->set_zero_point_with(ZP_DEFAULT); }
+
+bool AGS10Component::set_zero_point_with_current_resistance() { return this->set_zero_point_with(ZP_CURRENT); }
+
+bool AGS10Component::set_zero_point_with(uint16_t value) {
+  std::array<uint8_t, 5> data{0x00, 0x0C, (uint8_t) ((value >> 8) & 0xFF), (uint8_t) (value & 0xFF), 0};
+  data[4] = calc_crc8_(data, 4);
+  if (!this->write_bytes(REG_CALIBRATION, data)) {
+    this->error_code_ = COMMUNICATION_FAILED;
+    this->status_set_warning();
+    ESP_LOGE(TAG, "unable to set zero-point calibration with 0x%02X", value);
+    return false;
+  }
+  if (value == ZP_CURRENT) {
+    ESP_LOGI(TAG, "zero-point calibration has been set with current resistance");
+  } else if (value == ZP_DEFAULT) {
+    ESP_LOGI(TAG, "zero-point calibration has been reset to the factory defaults");
+  } else {
+    ESP_LOGI(TAG, "zero-point calibration has been set with 0x%02X", value);
+  }
+  this->error_code_ = NONE;
+  this->status_clear_warning();
+  return true;
+}
+
+optional<uint32_t> AGS10Component::read_tvoc_() {
+  auto data = this->read_and_check_<5>(REG_TVOC);
+  if (!data) {
+    return nullopt;
+  }
+
+  auto res = *data;
+  auto status_byte = res[0];
+
+  int units = status_byte & 0x0e;
+  int status_bit = status_byte & 0x01;
+
+  if (status_bit != 0) {
+    this->error_code_ = ILLEGAL_STATUS;
+    ESP_LOGW(TAG, "Reading AGS10 data failed: illegal status (not ready or sensor in pre-heat stage)!");
+    return nullopt;
+  }
+
+  if (units != 0) {
+    this->error_code_ = UNSUPPORTED_UNITS;
+    ESP_LOGE(TAG, "Reading AGS10 data failed: unsupported units (%d)!", units);
+    return nullopt;
+  }
+
+  return encode_uint24(res[1], res[2], res[3]);
+}
+
+optional<uint8_t> AGS10Component::read_version_() {
+  auto data = this->read_and_check_<5>(REG_VERSION);
+  if (data) {
+    auto res = *data;
+    return res[3];
+  }
+  return nullopt;
+}
+
+optional<uint32_t> AGS10Component::read_resistance_() {
+  auto data = this->read_and_check_<5>(REG_RESISTANCE);
+  if (data) {
+    auto res = *data;
+    return encode_uint32(res[0], res[1], res[2], res[3]);
+  }
+  return nullopt;
+}
+
+template<size_t N> optional<std::array<uint8_t, N>> AGS10Component::read_and_check_(uint8_t a_register) {
+  auto data = this->read_bytes<N>(a_register);
+  if (!data.has_value()) {
+    this->error_code_ = COMMUNICATION_FAILED;
+    ESP_LOGE(TAG, "Reading AGS10 version failed!");
+    return optional<std::array<uint8_t, N>>();
+  }
+  auto len = N - 1;
+  auto res = *data;
+  auto crc_byte = res[len];
+
+  if (crc_byte != calc_crc8_(res, len)) {
+    this->error_code_ = CRC_CHECK_FAILED;
+    ESP_LOGE(TAG, "Reading AGS10 version failed: crc error!");
+    return optional<std::array<uint8_t, N>>();
+  }
+
+  return data;
+}
+
+template<size_t N> uint8_t AGS10Component::calc_crc8_(std::array<uint8_t, N> dat, uint8_t num) {
+  uint8_t i, byte1, crc = 0xFF;
+  for (byte1 = 0; byte1 < num; byte1++) {
+    crc ^= (dat[byte1]);
+    for (i = 0; i < 8; i++) {
+      if (crc & 0x80) {
+        crc = (crc << 1) ^ 0x31;
+      } else {
+        crc = (crc << 1);
+      }
+    }
+  }
+  return crc;
+}
+}  // namespace ags10
+}  // namespace esphome

esphome/components/ags10/ags10.h

@@ -0,0 +1,152 @@
+#pragma once
+
+#include "esphome/core/automation.h"
+#include "esphome/core/component.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/i2c/i2c.h"
+
+namespace esphome {
+namespace ags10 {
+
+class AGS10Component : public PollingComponent, public i2c::I2CDevice {
+ public:
+  /**
+   * Sets TVOC sensor.
+   */
+  void set_tvoc(sensor::Sensor *tvoc) { this->tvoc_ = tvoc; }
+
+  /**
+   * Sets version info sensor.
+   */
+  void set_version(sensor::Sensor *version) { this->version_ = version; }
+
+  /**
+   * Sets resistance info sensor.
+   */
+  void set_resistance(sensor::Sensor *resistance) { this->resistance_ = resistance; }
+
+  void setup() override;
+
+  void update() override;
+
+  void dump_config() override;
+
+  float get_setup_priority() const override { return setup_priority::DATA; }
+
+  /**
+   * Modifies target address of AGS10.
+   *
+   * New address is saved and takes effect immediately even after power-off.
+   */
+  bool new_i2c_address(uint8_t newaddress);
+
+  /**
+   * Sets zero-point with factory defaults.
+   */
+  bool set_zero_point_with_factory_defaults();
+
+  /**
+   * Sets zero-point with current sensor resistance.
+   */
+  bool set_zero_point_with_current_resistance();
+
+  /**
+   * Sets zero-point with the value.
+   */
+  bool set_zero_point_with(uint16_t value);
+
+ protected:
+  /**
+   *  TVOC.
+   */
+  sensor::Sensor *tvoc_{nullptr};
+
+  /**
+   * Firmvare version.
+   */
+  sensor::Sensor *version_{nullptr};
+
+  /**
+   * Resistance.
+   */
+  sensor::Sensor *resistance_{nullptr};
+
+  /**
+   *  Last operation error code.
+   */
+  enum ErrorCode {
+    NONE = 0,
+    COMMUNICATION_FAILED,
+    CRC_CHECK_FAILED,
+    ILLEGAL_STATUS,
+    UNSUPPORTED_UNITS,
+  } error_code_{NONE};
+
+  /**
+   *  Reads and returns value of TVOC.
+   */
+  optional<uint32_t> read_tvoc_();
+
+  /**
+   *  Reads and returns a firmware version of AGS10.
+   */
+  optional<uint8_t> read_version_();
+
+  /**
+   * Reads and returns the resistance of AGS10.
+   */
+  optional<uint32_t> read_resistance_();
+
+  /**
+   * Read, checks and returns data from the sensor.
+   */
+  template<size_t N> optional<std::array<uint8_t, N>> read_and_check_(uint8_t a_register);
+
+  /**
+   * Calculates CRC8 value.
+   *
+   * CRC8 calculation, initial value: 0xFF, polynomial: 0x31 (x8+ x5+ x4+1)
+   *
+   * @param[in] dat the data buffer
+   * @param num number of bytes in the buffer
+   */
+  template<size_t N> uint8_t calc_crc8_(std::array<uint8_t, N> dat, uint8_t num);
+};
+
+template<typename... Ts> class AGS10NewI2cAddressAction : public Action<Ts...>, public Parented<AGS10Component> {
+ public:
+  TEMPLATABLE_VALUE(uint8_t, new_address)
+
+  void play(Ts... x) override { this->parent_->new_i2c_address(this->new_address_.value(x...)); }
+};
+
+enum AGS10SetZeroPointActionMode {
+  // Zero-point reset.
+  FACTORY_DEFAULT,
+  // Zero-point calibration with current resistance.
+  CURRENT_VALUE,
+  // Zero-point calibration with custom resistance.
+  CUSTOM_VALUE,
+};
+
+template<typename... Ts> class AGS10SetZeroPointAction : public Action<Ts...>, public Parented<AGS10Component> {
+ public:
+  TEMPLATABLE_VALUE(uint16_t, value)
+  TEMPLATABLE_VALUE(AGS10SetZeroPointActionMode, mode)
+
+  void play(Ts... x) override {
+    switch (this->mode_.value(x...)) {
+      case FACTORY_DEFAULT:
+        this->parent_->set_zero_point_with_factory_defaults();
+        break;
+      case CURRENT_VALUE:
+        this->parent_->set_zero_point_with_current_resistance();
+        break;
+      case CUSTOM_VALUE:
+        this->parent_->set_zero_point_with(this->value_.value(x...));
+        break;
+    }
+  }
+};
+}  // namespace ags10
+}  // namespace esphome

esphome/components/ags10/sensor.py

@@ -0,0 +1,132 @@
+import esphome.codegen as cg
+from esphome import automation
+import esphome.config_validation as cv
+from esphome.components import i2c, sensor
+from esphome.const import (
+    CONF_ID,
+    ICON_RADIATOR,
+    ICON_RESTART,
+    DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS_PARTS,
+    ENTITY_CATEGORY_DIAGNOSTIC,
+    STATE_CLASS_MEASUREMENT,
+    UNIT_OHM,
+    UNIT_PARTS_PER_BILLION,
+    CONF_ADDRESS,
+    CONF_TVOC,
+    CONF_VERSION,
+    CONF_MODE,
+    CONF_VALUE,
+)
+
+CONF_RESISTANCE = "resistance"
+
+DEPENDENCIES = ["i2c"]
+
+ags10_ns = cg.esphome_ns.namespace("ags10")
+AGS10Component = ags10_ns.class_("AGS10Component", cg.PollingComponent, i2c.I2CDevice)
+
+# Actions
+AGS10NewI2cAddressAction = ags10_ns.class_(
+    "AGS10NewI2cAddressAction", automation.Action
+)
+AGS10SetZeroPointAction = ags10_ns.class_("AGS10SetZeroPointAction", automation.Action)
+
+CONFIG_SCHEMA = (
+    cv.Schema(
+        {
+            cv.GenerateID(): cv.declare_id(AGS10Component),
+            cv.Optional(CONF_TVOC): sensor.sensor_schema(
+                unit_of_measurement=UNIT_PARTS_PER_BILLION,
+                icon=ICON_RADIATOR,
+                accuracy_decimals=0,
+                device_class=DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS_PARTS,
+                state_class=STATE_CLASS_MEASUREMENT,
+            ),
+            cv.Optional(CONF_VERSION): sensor.sensor_schema(
+                icon=ICON_RESTART,
+                entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
+            ),
+            cv.Optional(CONF_RESISTANCE): sensor.sensor_schema(
+                unit_of_measurement=UNIT_OHM,
+                icon=ICON_RESTART,
+                accuracy_decimals=0,
+                state_class=STATE_CLASS_MEASUREMENT,
+                entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
+            ),
+        }
+    )
+    .extend(cv.polling_component_schema("60s"))
+    .extend(i2c.i2c_device_schema(0x1A))
+)
+
+FINAL_VALIDATE_SCHEMA = i2c.final_validate_device_schema("ags10", max_frequency="15khz")
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    await cg.register_component(var, config)
+    await i2c.register_i2c_device(var, config)
+
+    sens = await sensor.new_sensor(config[CONF_TVOC])
+    cg.add(var.set_tvoc(sens))
+
+    if version_config := config.get(CONF_VERSION):
+        sens = await sensor.new_sensor(version_config)
+        cg.add(var.set_version(sens))
+
+    if resistance_config := config.get(CONF_RESISTANCE):
+        sens = await sensor.new_sensor(resistance_config)
+        cg.add(var.set_resistance(sens))
+
+
+AGS10_NEW_I2C_ADDRESS_SCHEMA = cv.maybe_simple_value(
+    {
+        cv.GenerateID(): cv.use_id(AGS10Component),
+        cv.Required(CONF_ADDRESS): cv.templatable(cv.i2c_address),
+    },
+    key=CONF_ADDRESS,
+)
+
+
+@automation.register_action(
+    "ags10.new_i2c_address",
+    AGS10NewI2cAddressAction,
+    AGS10_NEW_I2C_ADDRESS_SCHEMA,
+)
+async def ags10newi2caddress_to_code(config, action_id, template_arg, args):
+    var = cg.new_Pvariable(action_id, template_arg)
+    await cg.register_parented(var, config[CONF_ID])
+    address = await cg.templatable(config[CONF_ADDRESS], args, int)
+    cg.add(var.set_new_address(address))
+    return var
+
+
+AGS10SetZeroPointActionMode = ags10_ns.enum("AGS10SetZeroPointActionMode")
+AGS10_SET_ZERO_POINT_ACTION_MODE = {
+    "FACTORY_DEFAULT": AGS10SetZeroPointActionMode.FACTORY_DEFAULT,
+    "CURRENT_VALUE": AGS10SetZeroPointActionMode.CURRENT_VALUE,
+    "CUSTOM_VALUE": AGS10SetZeroPointActionMode.CUSTOM_VALUE,
+}
+
+AGS10_SET_ZERO_POINT_SCHEMA = cv.Schema(
+    {
+        cv.GenerateID(): cv.use_id(AGS10Component),
+        cv.Required(CONF_MODE): cv.enum(AGS10_SET_ZERO_POINT_ACTION_MODE, upper=True),
+        cv.Optional(CONF_VALUE, default=0xFFFF): cv.templatable(cv.uint16_t),
+    },
+)
+
+
+@automation.register_action(
+    "ags10.set_zero_point",
+    AGS10SetZeroPointAction,
+    AGS10_SET_ZERO_POINT_SCHEMA,
+)
+async def ags10setzeropoint_to_code(config, action_id, template_arg, args):
+    var = cg.new_Pvariable(action_id, template_arg)
+    await cg.register_parented(var, config[CONF_ID])
+    mode = await cg.templatable(config.get(CONF_MODE), args, enumerate)
+    cg.add(var.set_mode(mode))
+    value = await cg.templatable(config[CONF_VALUE], args, int)
+    cg.add(var.set_value(value))
+    return var

tests/components/ags10/test.esp32-c3-idf.yaml

@@ -0,0 +1,12 @@
+i2c:
+  - id: i2c_ags10
+    scl: 5
+    sda: 4
+    frequency: 10kHz
+
+sensor:
+  - platform: ags10
+    id: ags10_1
+    tvoc:
+      name: AGS10 TVOC
+    update_interval: 60s

tests/components/ags10/test.esp32-c3.yaml

@@ -0,0 +1,12 @@
+i2c:
+  - id: i2c_ags10
+    scl: 5
+    sda: 4
+    frequency: 10kHz
+
+sensor:
+  - platform: ags10
+    id: ags10_1
+    tvoc:
+      name: AGS10 TVOC
+    update_interval: 60s

tests/components/ags10/test.esp32-idf.yaml

@@ -0,0 +1,12 @@
+i2c:
+  - id: i2c_ags10
+    scl: 16
+    sda: 17
+    frequency: 10kHz
+
+sensor:
+  - platform: ags10
+    id: ags10_1
+    tvoc:
+      name: AGS10 TVOC
+    update_interval: 60s

tests/components/ags10/test.esp32.yaml

@@ -0,0 +1,12 @@
+i2c:
+  - id: i2c_ags10
+    scl: 16
+    sda: 17
+    frequency: 10kHz
+
+sensor:
+  - platform: ags10
+    id: ags10_1
+    tvoc:
+      name: AGS10 TVOC
+    update_interval: 60s

tests/components/ags10/test.esp8266.yaml

@@ -0,0 +1,12 @@
+i2c:
+  - id: i2c_ags10
+    scl: 5
+    sda: 4
+    frequency: 10kHz
+
+sensor:
+  - platform: ags10
+    id: ags10_1
+    tvoc:
+      name: AGS10 TVOC
+    update_interval: 60s