derived from sen5x driver

platformio.ini

@@ -85,6 +85,7 @@ lib_deps =
     https://github.com/Sensirion/arduino-sht.git
     https://github.com/Sensirion/arduino-i2c-scd4x.git
     https://github.com/Sensirion/arduino-i2c-sen5x.git
+    https://github.com/Sensirion/arduino-i2c-sen66.git
     https://github.com/adafruit/WiFiNINA.git
     https://github.com/Starmbi/hp_BH1750.git
     https://github.com/adafruit/Adafruit_TinyUSB_Arduino.git

src/components/i2c/drivers/WipperSnapper_I2C_Driver_SEN6X.h

@@ -0,0 +1,340 @@
+/*!
+ * @file WipperSnapper_I2C_Driver_SEN6x.h
+ *
+ * Device driver for the SEN66 Particulate Matter, Temperature, Humidity, VOC, NOX, and CO2 sensor.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Marni Brewster 2022 for Adafruit Industries.
+ * Modified (c) by Martin Ebner 2024 https://github.com/MartinEbnerSensirion
+ *
+ * MIT license, all text here must be included in any redistribution.
+ *
+ */
+
+#ifndef WipperSnapper_I2C_Driver_SEN6X_H
+#define WipperSnapper_I2C_Driver_SEN6X_H
+
+#include "WipperSnapper_I2C_Driver.h"
+#include <SensirionI2CSen66.h>
+#include <Wire.h>
+
+/**************************************************************************/
+/*!
+    @brief  Class that provides a driver interface for the SEN6X sensor.
+*/
+/**************************************************************************/
+class WipperSnapper_I2C_Driver_SEN6X : public WipperSnapper_I2C_Driver {
+
+  const float OVERFLOW_SEN6X = (0xFFFF / 10); // maxes out at u_int16 / 10
+
+public:
+  /*******************************************************************************/
+  /*!
+      @brief    Constructor for a SEN6X sensor.
+      @param    i2c
+                The I2C interface.
+      @param    sensorAddress
+                7-bit device address.
+  */
+  /*******************************************************************************/
+  WipperSnapper_I2C_Driver_SEN6X(TwoWire *i2c, uint16_t sensorAddress)
+      : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
+    _i2c = i2c;
+    _sensorAddress = sensorAddress;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Initializes the SEN6X sensor and begins I2C.
+      @returns  True if initialized successfully, False otherwise.
+  */
+  /*******************************************************************************/
+  bool begin() {
+    _sen = new SensirionI2cSen66();
+    _sen->begin(*_i2c, (uint8_t)_sensorAddress);
+    u_int16_t error_stop = _sen->deviceReset();
+    if (error_stop != 0) {
+      return false;
+    }
+    // Wait 1 second for sensors to start recording + 100ms for reset command
+    delay(1100);
+    u_int16_t error_start = _sen->startContinuousMeasurement();
+    if (error_start != 0) {
+      return false;
+    }
+
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X's current temperature.
+      @param    tempEvent
+                Pointer to an Adafruit_Sensor event.
+      @returns  True if the temperature was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventAmbientTemp(sensors_event_t *tempEvent) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+    if ((_tempSensorPeriod != 0 && error != 0) || ambientTemperature == NAN) {
+      return false;
+    }
+
+    tempEvent->temperature = ambientTemperature;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X's current relative humidity reading.
+      @param    humidEvent
+                Pointer to an Adafruit_Sensor event.
+      @returns  True if the humidity was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventRelativeHumidity(sensors_event_t *humidEvent) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+    if ((_humidSensorPeriod != 0 && error != 0) || ambientHumidity == NAN) {
+      return false;
+    }
+
+    humidEvent->relative_humidity = ambientHumidity;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X's current NOX reading.
+                Note: If this value is unknown, which is true for SEN54,
+                NAN is returned. During the first 10..11 seconds after
+                power-on or device reset, this value will be NAN as well.
+      @param    noxIndexEvent
+                  Adafruit Sensor event for NOx Index (0-500, 1 is normal)
+      @returns  True if the sensor value was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventNOxIndex(sensors_event_t *noxIndexEvent) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+    if ((_NOxIndexPeriod != 0 && error != 0) || noxIndex == NAN) {
+      return false;
+    }
+
+    noxIndexEvent->nox_index = noxIndex;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X's current VOC reading.
+      @param    vocIndexEvent
+                  Adafruit Sensor event for VOC Index (1-500, 100 is normal)
+      @returns  True if the sensor value was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventVOCIndex(sensors_event_t *vocIndexEvent) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+    if ((_VOCIndexPeriod != 0 && error != 0) || vocIndex == NAN) {
+      return false;
+    }
+
+    vocIndexEvent->voc_index = vocIndex;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X sensor's PM1.0 STD reading.
+      @param    pm10StdEvent
+                  Adafruit Sensor event for PM1.0
+      @returns  True if the sensor value was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventPM10_STD(sensors_event_t *pm10StdEvent) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+    if ((_PM10SensorPeriod != 0 && error != 0) ||
+        massConcentrationPm1p0 == NAN ||
+        massConcentrationPm1p0 == OVERFLOW_SEN6X) {
+      return false;
+    }
+
+    pm10StdEvent->pm10_std = massConcentrationPm1p0;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X sensor's PM2.5 STD reading.
+      @param    pm25StdEvent
+                  Adafruit Sensor event for PM2.5
+      @returns  True if the sensor value was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventPM25_STD(sensors_event_t *pm25StdEvent) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+    if ((_PM25SensorPeriod != 0 && error != 0) ||
+        massConcentrationPm2p5 == NAN ||
+        massConcentrationPm2p5 == OVERFLOW_SEN6X) {
+      return false;
+    }
+
+    pm25StdEvent->pm25_std = massConcentrationPm2p5;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X sensor's PM4.0 STD reading.
+      @param    pm40StdEvent
+                  Adafruit Sensor event for PM4.0
+      @returns  True if the sensor value was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventPM40_STD(sensors_event_t *pm40StdEvent) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+    if ((_PM25SensorPeriod != 0 && error != 0) ||
+        massConcentrationPm4p0 == NAN ||
+        massConcentrationPm4p0 == OVERFLOW_SEN6X) {
+      return false;
+    }
+
+    pm40StdEvent->data[0] = massConcentrationPm4p0;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X sensor's PM10.0 STD reading.
+      @param    pm100StdEvent
+                  Adafruit Sensor event for PM10.0
+      @returns  True if the sensor value was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventPM100_STD(sensors_event_t *pm100StdEvent) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+    if ((_PM100SensorPeriod != 0 && error != 0) ||
+        massConcentrationPm10p0 == NAN ||
+        massConcentrationPm10p0 == OVERFLOW_SEN6X) {
+      return false;
+    }
+
+    pm100StdEvent->pm100_std = massConcentrationPm10p0;
+    return true;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the SEN6X sensor's CO2 reading.
+      @param    co2Event
+                  Adafruit Sensor event for CO2
+      @returns  True if the sensor value was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventCO2(sensors_event_t *co2Event) {
+    float massConcentrationPm1p0, massConcentrationPm2p5,
+        massConcentrationPm4p0, massConcentrationPm10p0, ambientHumidity,
+        ambientTemperature, vocIndex, noxIndex;
+    uint16_t co2;
+    uint16_t error;
+
+    error = _sen->readMeasuredValues(
+        massConcentrationPm1p0, massConcentrationPm2p5, massConcentrationPm4p0,
+        massConcentrationPm10p0, ambientHumidity, ambientTemperature, vocIndex,
+        noxIndex, co2);
+
+    if ((_CO2SensorPeriod != 0 && error != 0) || co2 == NAN) {
+      return false;
+    }
+
+    co2Event->CO2 = co2;
+    return true;
+  }
+
+protected:
+  SensirionI2cSen66 *_sen; ///< SEN6X driver object
+};
+
+#endif // WipperSnapper_I2C_Driver_SEN6X