Add SDP3x sensor (#2064)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
Co-authored-by: Otto Winter <otto@otto-winter.com>

CODEOWNERS

@@ -97,6 +97,7 @@ esphome/components/rf_bridge/* @jesserockz
 esphome/components/rtttl/* @glmnet
 esphome/components/script/* @esphome/core
 esphome/components/sdm_meter/* @jesserockz @polyfaces
+esphome/components/sdp3x/* @Azimath
 esphome/components/selec_meter/* @sourabhjaiswal
 esphome/components/sensor/* @esphome/core
 esphome/components/sgp40/* @SenexCrenshaw
@@ -128,6 +129,7 @@ esphome/components/thermostat/* @kbx81
 esphome/components/time/* @OttoWinter
 esphome/components/tm1637/* @glmnet
 esphome/components/tmp102/* @timsavage
+esphome/components/tmp117/* @Azimath
 esphome/components/tof10120/* @wstrzalka
 esphome/components/tuya/binary_sensor/* @jesserockz
 esphome/components/tuya/climate/* @jesserockz

esphome/components/sdp3x/sdp3x.cpp

@@ -0,0 +1,124 @@
+#include "sdp3x.h"
+#include "esphome/core/log.h"
+#include "esphome/core/helpers.h"
+
+namespace esphome {
+namespace sdp3x {
+
+static const char *const TAG = "sdp3x.sensor";
+static const uint8_t SDP3X_SOFT_RESET[2] = {0x00, 0x06};
+static const uint8_t SDP3X_READ_ID1[2] = {0x36, 0x7C};
+static const uint8_t SDP3X_READ_ID2[2] = {0xE1, 0x02};
+static const uint8_t SDP3X_START_DP_AVG[2] = {0x36, 0x15};
+static const uint8_t SDP3X_STOP_MEAS[2] = {0x3F, 0xF9};
+
+void SDP3XComponent::update() { this->read_pressure_(); }
+
+void SDP3XComponent::setup() {
+  ESP_LOGD(TAG, "Setting up SDP3X...");
+
+  if (!this->write_bytes_raw(SDP3X_STOP_MEAS, 2)) {
+    ESP_LOGW(TAG, "Stop SDP3X failed!");  // This sometimes fails for no good reason
+  }
+
+  if (!this->write_bytes_raw(SDP3X_SOFT_RESET, 2)) {
+    ESP_LOGW(TAG, "Soft Reset SDP3X failed!");  // This sometimes fails for no good reason
+  }
+
+  delay_microseconds_accurate(20000);
+
+  if (!this->write_bytes_raw(SDP3X_READ_ID1, 2)) {
+    ESP_LOGE(TAG, "Read ID1 SDP3X failed!");
+    this->mark_failed();
+    return;
+  }
+  if (!this->write_bytes_raw(SDP3X_READ_ID2, 2)) {
+    ESP_LOGE(TAG, "Read ID2 SDP3X failed!");
+    this->mark_failed();
+    return;
+  }
+
+  uint8_t data[18];
+  if (!this->read_bytes_raw(data, 18)) {
+    ESP_LOGE(TAG, "Read ID SDP3X failed!");
+    this->mark_failed();
+    return;
+  }
+
+  if (!(check_crc_(&data[0], 2, data[2]) && check_crc_(&data[3], 2, data[5]))) {
+    ESP_LOGE(TAG, "CRC ID SDP3X failed!");
+    this->mark_failed();
+    return;
+  }
+
+  if (data[3] == 0x01) {
+    ESP_LOGCONFIG(TAG, "SDP3X is SDP31");
+    pressure_scale_factor_ = 60.0f * 100.0f;  // Scale factors converted to hPa per count
+  } else if (data[3] == 0x02) {
+    ESP_LOGCONFIG(TAG, "SDP3X is SDP32");
+    pressure_scale_factor_ = 240.0f * 100.0f;
+  }
+
+  if (!this->write_bytes_raw(SDP3X_START_DP_AVG, 2)) {
+    ESP_LOGE(TAG, "Start Measurements SDP3X failed!");
+    this->mark_failed();
+    return;
+  }
+  ESP_LOGCONFIG(TAG, "SDP3X started!");
+}
+void SDP3XComponent::dump_config() {
+  LOG_SENSOR("  ", "SDP3X", this);
+  LOG_I2C_DEVICE(this);
+  if (this->is_failed()) {
+    ESP_LOGE(TAG, "  Connection with SDP3X failed!");
+  }
+  LOG_UPDATE_INTERVAL(this);
+}
+
+void SDP3XComponent::read_pressure_() {
+  uint8_t data[9];
+  if (!this->read_bytes_raw(data, 9)) {
+    ESP_LOGW(TAG, "Couldn't read SDP3X data!");
+    this->status_set_warning();
+    return;
+  }
+
+  if (!(check_crc_(&data[0], 2, data[2]) && check_crc_(&data[3], 2, data[5]) && check_crc_(&data[6], 2, data[8]))) {
+    ESP_LOGW(TAG, "Invalid SDP3X data!");
+    this->status_set_warning();
+    return;
+  }
+
+  int16_t pressure_raw = encode_uint16(data[0], data[1]);
+  float pressure = pressure_raw / pressure_scale_factor_;
+  ESP_LOGV(TAG, "Got raw pressure=%d, scale factor =%.3f ", pressure_raw, pressure_scale_factor_);
+  ESP_LOGD(TAG, "Got Pressure=%.3f hPa", pressure);
+
+  this->publish_state(pressure);
+  this->status_clear_warning();
+}
+
+float SDP3XComponent::get_setup_priority() const { return setup_priority::DATA; }
+
+// Check CRC function from SDP3X sample code provided by sensirion
+// Returns true if a checksum is OK
+bool SDP3XComponent::check_crc_(const uint8_t data[], uint8_t size, uint8_t checksum) {
+  uint8_t crc = 0xFF;
+
+  // calculates 8-Bit checksum with given polynomial 0x31 (x^8 + x^5 + x^4 + 1)
+  for (int i = 0; i < size; i++) {
+    crc ^= (data[i]);
+    for (uint8_t bit = 8; bit > 0; --bit) {
+      if (crc & 0x80)
+        crc = (crc << 1) ^ 0x31;
+      else
+        crc = (crc << 1);
+    }
+  }
+
+  // verify checksum
+  return (crc == checksum);
+}
+
+}  // namespace sdp3x
+}  // namespace esphome

esphome/components/sdp3x/sdp3x.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/i2c/i2c.h"
+
+namespace esphome {
+namespace sdp3x {
+
+class SDP3XComponent : public PollingComponent, public i2c::I2CDevice, public sensor::Sensor {
+ public:
+  /// Schedule temperature+pressure readings.
+  void update() override;
+  /// Setup the sensor and test for a connection.
+  void setup() override;
+  void dump_config() override;
+
+  float get_setup_priority() const override;
+
+ protected:
+  /// Internal method to read the pressure from the component after it has been scheduled.
+  void read_pressure_();
+
+  bool check_crc_(const uint8_t data[], uint8_t size, uint8_t checksum);
+
+  float pressure_scale_factor_ = 0.0f;  // hPa per count
+};
+
+}  // namespace sdp3x
+}  // namespace esphome

esphome/components/sdp3x/sensor.py

@@ -0,0 +1,40 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import i2c, sensor
+from esphome.const import (
+    CONF_ID,
+    DEVICE_CLASS_PRESSURE,
+    ICON_EMPTY,
+    STATE_CLASS_MEASUREMENT,
+    UNIT_HECTOPASCAL,
+)
+
+DEPENDENCIES = ["i2c"]
+CODEOWNERS = ["@Azimath"]
+
+sdp3x_ns = cg.esphome_ns.namespace("sdp3x")
+SDP3XComponent = sdp3x_ns.class_("SDP3XComponent", cg.PollingComponent, i2c.I2CDevice)
+
+CONFIG_SCHEMA = (
+    sensor.sensor_schema(
+        UNIT_HECTOPASCAL,
+        ICON_EMPTY,
+        3,
+        DEVICE_CLASS_PRESSURE,
+        STATE_CLASS_MEASUREMENT,
+    )
+    .extend(
+        {
+            cv.GenerateID(): cv.declare_id(SDP3XComponent),
+        }
+    )
+    .extend(cv.polling_component_schema("60s"))
+    .extend(i2c.i2c_device_schema(0x21))
+)
+
+
+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)
+    await sensor.register_sensor(var, config)

esphome/components/tmp117/sensor.py

@@ -11,6 +11,7 @@ from esphome.const import (
 )
 
 DEPENDENCIES = ["i2c"]
+CODEOWNERS = ["@Azimath"]
 
 tmp117_ns = cg.esphome_ns.namespace("tmp117")
 TMP117Component = tmp117_ns.class_(

tests/test1.yaml

@@ -922,6 +922,11 @@ sensor:
     id: ph_ezo
     address: 99
     unit_of_measurement: 'pH'
+  - platform: sdp3x
+    name: "HVAC Filter Pressure drop"
+    id: filter_pressure
+    update_interval: 5s
+    accuracy_decimals: 3
   - platform: cs5460a
     id: cs5460a1
     current: