Ppd42 x

platformio.ini

@@ -13,7 +13,7 @@ lib_deps =
     ESP Async [email protected]
     [email protected]
     [email protected]
-    ESPAsyncTCP@1.2.0
+    ESPAsyncTCP@1.1.3
 build_flags =
     -Wno-reorder
     -DUSE_WEB_SERVER

src/esphome/application.cpp

@@ -432,7 +432,6 @@ sensor::UltrasonicSensorComponent *Application::make_ultrasonic_sensor(const std
   return ultrasonic;
 }
 #endif
-
 #ifdef USE_WIFI_SIGNAL_SENSOR
 sensor::WiFiSignalSensor *Application::make_wifi_signal_sensor(const std::string &name, uint32_t update_interval) {
   auto *wifi = this->register_component(new WiFiSignalSensor(name, update_interval));
@@ -1090,6 +1089,13 @@ sensor::PMSX003Component *Application::make_pmsx003(UARTComponent *parent, senso
 }
 #endif
 
+#ifdef USE_PPD42X
+sensor::PPD42XComponent *Application::make_ppd42x(sensor::PPD42XType type, uint32_t update_interval,
+                                                  uint32_t time_out) {
+  return this->register_component(new PPD42XComponent(type, time_out, update_interval));
+}
+#endif
+
 #ifdef USE_A4988
 stepper::A4988 *Application::make_a4988(const GPIOOutputPin &step_pin, const GPIOOutputPin &dir_pin) {
   return this->register_component(new A4988(step_pin.copy(), dir_pin.copy()));

src/esphome/application.h

@@ -116,6 +116,7 @@
 #include "esphome/sensor/mqtt_subscribe_sensor.h"
 #include "esphome/sensor/ms5611.h"
 #include "esphome/sensor/pmsx003.h"
+#include "esphome/sensor/ppd42x.h"
 #include "esphome/sensor/pulse_counter.h"
 #include "esphome/sensor/rotary_encoder.h"
 #include "esphome/sensor/sensor.h"
@@ -810,6 +811,10 @@ class Application {
 #ifdef USE_PMSX003
   sensor::PMSX003Component *make_pmsx003(UARTComponent *parent, sensor::PMSX003Type type);
 #endif
+#ifdef USE_PPD42X
+  sensor::PPD42XComponent *make_ppd42x(sensor::PPD42XType type, uint32_t update_interval = 60000,
+                                       uint32_t time_out = 30000);
+#endif
 
 #ifdef USE_TOTAL_DAILY_ENERGY_SENSOR
   sensor::TotalDailyEnergy *make_total_daily_energy_sensor(const std::string &name, time::RealTimeClockComponent *time,

src/esphome/defines.h

@@ -124,6 +124,9 @@
 #define USE_MQTT_SUBSCRIBE_SENSOR
 #define USE_CSE7766
 #define USE_PMSX003
+#define USE_PPD42X
+#define USE_ENDSTOP_COVER
+#define USE_TIME_BASED_COVER
 #define USE_STEPPER
 #define USE_A4988
 #define USE_ULN2003

src/esphome/sensor/ppd42x.cpp

@@ -0,0 +1,129 @@
+#include "esphome/defines.h"
+
+#ifdef USE_PPD42X
+
+#include "esphome/sensor/ppd42x.h"
+#include "esphome/log.h"
+
+ESPHOME_NAMESPACE_BEGIN
+
+namespace sensor {
+
+static const char *TAG = "sensor.ppd42x";
+
+PPD42XComponent::PPD42XComponent(PPD42XType type, uint32_t update_interval, uint32_t time_out)
+    : ctype_(type), ui_(update_interval), timeout_ms_(time_out) {}
+
+void PPD42XComponent::loop() {
+  const uint32_t now = millis();
+  if ((now - this->starttime_) > this->ui_) {
+    uint32_t duration_pl_02_5 = pulseIn(this->pl_02_5_sensor_->pl_pin_->get_pin(),
+                                        uint8_t(!this->pl_02_5_sensor_->pl_pin_->is_inverted()), this->timeout_ms_);
+    uint32_t duration_pl_10_0 = pulseIn(this->pl_10_0_sensor_->pl_pin_->get_pin(),
+                                        uint8_t(!this->pl_10_0_sensor_->pl_pin_->is_inverted()), this->timeout_ms_);
+    this->lowpulseoccupancy_02_5_ = this->lowpulseoccupancy_02_5_ + duration_pl_02_5;
+    this->lowpulseoccupancy_10_0_ = this->lowpulseoccupancy_10_0_ + duration_pl_10_0;
+
+    if ((now - this->starttime_) > this->timeout_ms_) {
+      // last transmission too long ago
+      this->starttime_ = now;
+      parse_data_();
+    }
+  }
+}
+
+float PPD42XComponent::get_setup_priority() const { return setup_priority::HARDWARE_LATE; }
+
+void PPD42XComponent::parse_data_() {
+  switch (this->ctype_) {
+    case PPD42X_TYPE: {
+      float pl_02_5_concentration = us_to_pl(this->lowpulseoccupancy_02_5_, this->timeout_ms_);
+      float pl_10_0_concentration = us_to_pl(this->lowpulseoccupancy_10_0_, this->timeout_ms_);
+      ESP_LOGD(TAG, "Got PM2.5 Concentration %.0f pcs/L, PM10.0 Concentration: %f pcs/L", pl_02_5_concentration,
+               pl_10_0_concentration);
+      if (this->pl_02_5_sensor_ != nullptr)
+        this->pl_02_5_sensor_->publish_state(pl_02_5_concentration);
+      if (this->pl_10_0_sensor_ != nullptr)
+        this->pl_10_0_sensor_->publish_state(pl_10_0_concentration);
+      break;
+    }
+    case PPD42X_TYPE_NS: {
+      float pl_02_5_concentration = us_to_pl(this->lowpulseoccupancy_02_5_, this->timeout_ms_);
+      float pl_10_0_concentration = us_to_pl(this->lowpulseoccupancy_10_0_, this->timeout_ms_);
+      ESP_LOGD(TAG, "Got PM2.5 Concentration %.0f pcs/L, PM10.0 Concentration: %f pcs/L", pl_02_5_concentration,
+               pl_10_0_concentration);
+      if (this->pl_02_5_sensor_ != nullptr)
+        this->pl_02_5_sensor_->publish_state(pl_02_5_concentration);
+      if (this->pl_10_0_sensor_ != nullptr)
+        this->pl_10_0_sensor_->publish_state(pl_10_0_concentration);
+      break;
+    }
+    case PPD42X_TYPE_NJ: {
+      float pl_02_5_concentration = us_to_pl(this->lowpulseoccupancy_02_5_, this->timeout_ms_);
+      float pl_10_0_concentration = us_to_pl(this->lowpulseoccupancy_10_0_, this->timeout_ms_);
+      ESP_LOGD(TAG, "Got PM2.5 Concentration %.0f pcs/L, PM10.0 Concentration: %f pcs/L", pl_02_5_concentration,
+               pl_10_0_concentration);
+      if (this->pl_02_5_sensor_ != nullptr)
+        this->pl_02_5_sensor_->publish_state(pl_02_5_concentration);
+      if (this->pl_10_0_sensor_ != nullptr)
+        this->pl_10_0_sensor_->publish_state(pl_10_0_concentration);
+      break;
+    }
+  }
+}
+
+float PPD42XComponent::us_to_pl(uint32_t sample_length, uint32_t time_pm) {
+  float ratio = time_pm / (sample_length * 10.0f);
+  return 1.1f * powf(ratio, 3) - 3.8f * powf(ratio, 2) + 520.0f * ratio + 0.62f;
+}
+
+PPD42XSensor *PPD42XComponent::make_pl_02_5_sensor(const std::string &name, GPIOInputPin *pl) {
+  return this->pl_02_5_sensor_ = new PPD42XSensor(name, pl, PPD42X_SENSOR_TYPE_PM_02_5);
+}
+
+PPD42XSensor *PPD42XComponent::make_pl_10_0_sensor(const std::string &name, GPIOInputPin *pl) {
+  return this->pl_10_0_sensor_ = new PPD42XSensor(name, pl, PPD42X_SENSOR_TYPE_PM_10_0);
+}
+
+void PPD42XComponent::dump_config() {
+  ESP_LOGCONFIG(TAG, "PPD42X:");
+  LOG_SENSOR("  ", "PM2.5", this->pl_02_5_sensor_);
+  LOG_SENSOR("  ", "PM10.0", this->pl_10_0_sensor_);
+}
+
+std::string PPD42XSensor::unit_of_measurement() {
+  switch (this->stype_) {
+    case PPD42X_SENSOR_TYPE_PM_02_5:
+    case PPD42X_SENSOR_TYPE_PM_10_0:
+      return UNIT_PARTICLES_PER_LITER;
+  }
+  return "";
+}
+
+std::string PPD42XSensor::icon() {
+  switch (this->stype_) {
+    case PPD42X_SENSOR_TYPE_PM_02_5:
+    case PPD42X_SENSOR_TYPE_PM_10_0:
+      // Not the ideal icon, but Otto can't find a better one ;)
+      return ICON_CHEMICAL_WEAPON;
+  }
+  return "";
+}
+
+int8_t PPD42XSensor::accuracy_decimals() {
+  switch (this->stype_) {
+    case PPD42X_SENSOR_TYPE_PM_02_5:
+    case PPD42X_SENSOR_TYPE_PM_10_0:
+      return 0;
+  }
+  return 0;
+}
+// void PPD42XComponent::set_timeout_us(uint32_t timeout_us) { this->timeout_ms_ = timeout_us; }
+
+PPD42XSensor::PPD42XSensor(const std::string &name, GPIOInputPin *pl, PPD42XSensorType type)
+    : Sensor(name), pl_pin_(pl), stype_(type) {}
+}  // namespace sensor
+
+ESPHOME_NAMESPACE_END
+
+#endif  // USE_PPD42X

src/esphome/sensor/ppd42x.h

@@ -0,0 +1,76 @@
+#ifndef ESPHOME_SENSOR_PPD42X_H
+#define ESPHOME_SENSOR_PPD42X_H
+
+#include "esphome/defines.h"
+
+#ifdef USE_PPD42X
+
+#include "esphome/component.h"
+#include "esphome/sensor/sensor.h"
+#include "esphome/helpers.h"
+
+ESPHOME_NAMESPACE_BEGIN
+
+namespace sensor {
+
+enum PPD42XType {
+  PPD42X_TYPE = 0,
+  PPD42X_TYPE_NJ,
+  PPD42X_TYPE_NS,
+};
+
+enum PPD42XSensorType {
+  /// PM2.5 concentration in pcs/L, PPD42, PPD42NJ, PPD42NS
+  PPD42X_SENSOR_TYPE_PM_02_5,
+  /// PM10.0 concentration in pcs/L, PPD42X
+  PPD42X_SENSOR_TYPE_PM_10_0,
+};
+
+class PPD42XSensor : public sensor::Sensor {
+ public:
+  PPD42XSensor(const std::string &name, GPIOInputPin *pl, PPD42XSensorType type);
+
+  std::string unit_of_measurement() override;
+  std::string icon() override;
+  int8_t accuracy_decimals() override;
+  GPIOInputPin *pl_pin_;
+
+ protected:
+  const PPD42XSensorType stype_;
+
+};  // class PPD42XSensor
+
+class PPD42XComponent : public Component {
+ public:
+  PPD42XComponent(PPD42XType type, uint32_t update_interval, uint32_t time_out);
+  void set_timeout_us(uint32_t timeout_us);
+  void loop() override;
+  float get_setup_priority() const override;
+  void dump_config() override;
+
+  PPD42XSensor *make_pl_02_5_sensor(const std::string &name, GPIOInputPin *pl);
+  PPD42XSensor *make_pl_10_0_sensor(const std::string &name, GPIOInputPin *pl);
+
+ protected:
+  void parse_data_();
+  static float us_to_pl(uint32_t sample_length, uint32_t time_pm);
+
+  uint32_t timeout_ms_{30};
+  uint32_t starttime_{0};
+  uint32_t lowpulseoccupancy_02_5_{0};
+  uint32_t lowpulseoccupancy_10_0_{0};
+
+  uint32_t last_transmission_{0};
+  uint32_t ui_{0};
+  const PPD42XType ctype_;
+  PPD42XSensor *pl_02_5_sensor_{nullptr};
+  PPD42XSensor *pl_10_0_sensor_{nullptr};
+};  // class PPD42XComponent
+
+}  // namespace sensor
+
+ESPHOME_NAMESPACE_END
+
+#endif  // USE_PPD42X
+
+#endif  // ESPHOME_SENSOR_PPD42X_H

src/esphome/sensor/sensor.cpp

@@ -160,6 +160,7 @@ const char UNIT_K[] = "K";
 const char UNIT_MICROSIEMENS_PER_CENTIMETER[] = "µS/cm";
 const char UNIT_MICROGRAMS_PER_CUBIC_METER[] = "µg/m³";
 const char ICON_CHEMICAL_WEAPON[] = "mdi:chemical-weapon";
+const char UNIT_PARTICLES_PER_LITER[] = "pcs/l";
 
 SensorStateTrigger::SensorStateTrigger(Sensor *parent) {
   parent->add_on_state_callback([this](float value) { this->trigger(value); });

src/esphome/sensor/sensor.h

@@ -347,6 +347,7 @@ extern const char UNIT_DEGREES[];
 extern const char UNIT_K[];
 extern const char UNIT_MICROSIEMENS_PER_CENTIMETER[];
 extern const char UNIT_MICROGRAMS_PER_CUBIC_METER[];
+extern const char UNIT_PARTICLES_PER_LITER[];
 
 template<typename... Ts> SensorInRangeCondition<Ts...> *Sensor::make_sensor_in_range_condition() {
   return new SensorInRangeCondition<Ts...>(this);