Fix issue with probing

Probing failed for certain sensors if a e.g. a measurement was
running. This commit ensures that measurements are stopped or
the device is reset before probing if necessary.

Fix several clang tidy issues.

Prepare for 3.0.1 bugfix release

Author: psachs

.gitignore

@@ -5,3 +5,4 @@ latex
 src/html/**
 src/latex/**
 examples/**/*.cpp
+.idea/

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.1]
+
+### Fixed
+- Fix probing not working without power cycle for certain sensors, if e.g. a measurement was still ongoing.
+
 ## [3.0.0]
 
 ### Added

library.properties

@@ -1,5 +1,5 @@
 name=Sensirion UPT I2C Auto Detection
-version=3.0.0
+version=3.0.1
 author=Jonas Stolle, Maximilian Paulsen
 maintainer=Sensirion AG <sensirion.com>
 sentence=Automatically detects Sensirion Sensors on an I2C bus and reads out measurement data.

platformio.ini

@@ -13,14 +13,14 @@ default_envs = basicUsage
 
 [common]
 lib_deps_external =
-    Sensirion/Sensirion Core@0.7.1
+    Sensirion/Sensirion Core@0.7.2
     Sensirion/Sensirion UPT Core@^1.0.0
     Sensirion/Sensirion I2C SHT4x@1.1.2
     Sensirion/Sensirion I2C SCD4x@1.1.0
     Sensirion/Sensirion I2C SFA3x@1.0.0
     Sensirion/Sensirion I2C SVM4x@0.2.0
     Sensirion/Sensirion I2C SEN5X@0.3.0
-    Sensirion/Sensirion I2C SCD30@0.1.0
+    Sensirion/Sensirion I2C SCD30@1.0.0
     Sensirion/Sensirion I2C SGP41@1.0.0
     Sensirion/Sensirion I2C STC3x@1.0.1
     Sensirion/Sensirion I2C SEN66@1.1.0

src/SensorWrappers/Scd30.cpp

@@ -2,10 +2,10 @@
 #include "SensirionCore.h"
 #include "Sensirion_UPT_Core.h"
 
-namespace sensirion::upt::i2c_autodetect{
+namespace sensirion::upt::i2c_autodetect {
 
-Scd30::Scd30(TwoWire& wire, const uint16_t address) : 
-    mWire(wire), mAddress{address}, mMetadata{core::SCD30()}{};
+Scd30::Scd30(TwoWire& wire, const uint16_t address)
+    : mWire(wire), mAddress{address}, mMetadata{core::SCD30()} {};
 
 uint16_t Scd30::start() {
     mDriver.begin(mWire, mAddress);
@@ -24,7 +24,6 @@ uint16_t Scd30::measureAndWrite(MeasurementList& measurements,
         return 1;
     }
 
-  
     float co2Concentration;
     float temperature;
     float humidity;
@@ -34,30 +33,29 @@ uint16_t Scd30::measureAndWrite(MeasurementList& measurements,
         return error;
     }
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::CO2_PARTS_PER_MILLION,
-        core::DataPoint{timeStamp, co2Concentration});
+    measurements.emplace_back(mMetadata,
+                              core::SignalType::CO2_PARTS_PER_MILLION,
+                              core::DataPoint{timeStamp, co2Concentration});
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::TEMPERATURE_DEGREES_CELSIUS, 
-        core::DataPoint{timeStamp, temperature});
+    measurements.emplace_back(mMetadata,
+                              core::SignalType::TEMPERATURE_DEGREES_CELSIUS,
+                              core::DataPoint{timeStamp, temperature});
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::RELATIVE_HUMIDITY_PERCENTAGE, 
-        core::DataPoint{timeStamp, humidity});
+    measurements.emplace_back(mMetadata,
+                              core::SignalType::RELATIVE_HUMIDITY_PERCENTAGE,
+                              core::DataPoint{timeStamp, humidity});
 
-
-    /* Prepare next reading by querying the dataReadyFlag. We don't need the
+    /* Prepare the next reading by querying the dataReadyFlag. We don't need the
      * value of the flag, but the query seems to finalize setting off the
-     * measurement process, and enables much faster signal readout at the next
+     * measurement process and enables a much faster signal readout at the next
      * call of this function as it then is not required to enter a wait loop
      * (see SensirionI2cScd30::blockingReadMeasurementData()). This procedure is
      * only required for SCD30. */
     error = mDriver.getDataReady(dataReadyFlag);
     if (error) {
         return error;
     }
-    return HighLevelError::NoError;
+    return NoError;
 }
 
 uint16_t Scd30::initializationStep() {
@@ -105,11 +103,13 @@ unsigned long Scd30::getMinimumMeasurementIntervalMs() const {
 
 bool Scd30::probe() {
     uint8_t major, minor;
-    uint16_t error = mDriver.readFirmwareVersion(major, minor);
-    return (error == HighLevelError::NoError);
+    // stop potential running measurement
+    mDriver.stopPeriodicMeasurement();
+    const uint16_t error = mDriver.readFirmwareVersion(major, minor);
+    return (error == NoError);
 }
 
 void* Scd30::getDriver() {
-    return reinterpret_cast<void*>(&mDriver);
+    return &mDriver;
 }
-} // namespace sensirion::upt::i2c_autodetect 
+}  // namespace sensirion::upt::i2c_autodetect

src/SensorWrappers/Scd4x.cpp

@@ -2,11 +2,10 @@
 #include "SensirionCore.h"
 #include "Sensirion_UPT_Core.h"
 
-namespace sensirion::upt::i2c_autodetect{
+namespace sensirion::upt::i2c_autodetect {
 
-Scd4x::Scd4x(TwoWire& wire, const uint16_t address) : mWire(wire), 
-    mAddress{address},
-    mMetadata{core::SCD4X()}{};
+Scd4x::Scd4x(TwoWire& wire, const uint16_t address)
+    : mWire(wire), mAddress{address}, mMetadata{core::SCD4X()} {};
 
 uint16_t Scd4x::start() {
     mDriver.begin(mWire, mAddress);
@@ -18,22 +17,22 @@ uint16_t Scd4x::measureAndWrite(MeasurementList& measurements,
     uint16_t co2;
     float temp;
     float humi;
-    uint16_t error = mDriver.readMeasurement(co2, temp, humi);
+    const uint16_t error = mDriver.readMeasurement(co2, temp, humi);
     if (error) {
         return error;
     }
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::CO2_PARTS_PER_MILLION,
+    measurements.emplace_back(
+        mMetadata, core::SignalType::CO2_PARTS_PER_MILLION,
         core::DataPoint{timeStamp, static_cast<float>(co2)});
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::TEMPERATURE_DEGREES_CELSIUS,
-        core::DataPoint{timeStamp, temp});        
+    measurements.emplace_back(mMetadata,
+                              core::SignalType::TEMPERATURE_DEGREES_CELSIUS,
+                              core::DataPoint{timeStamp, temp});
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::RELATIVE_HUMIDITY_PERCENTAGE,
-        core::DataPoint{timeStamp, humi});      
+    measurements.emplace_back(mMetadata,
+                              core::SignalType::RELATIVE_HUMIDITY_PERCENTAGE,
+                              core::DataPoint{timeStamp, humi});
 
     return HighLevelError::NoError;
 }
@@ -86,16 +85,19 @@ unsigned long Scd4x::getInitializationIntervalMs() const {
 }
 
 bool Scd4x::probe() {
+    // stop potential running measurement
+    mDriver.stopPeriodicMeasurement();
     SCD4xSensorVariant aSensorVariant = SCD4X_SENSOR_VARIANT_MASK;
-    uint16_t error = mDriver.getSensorVariant(aSensorVariant);
-    bool isKnownVariant = (aSensorVariant == SCD4X_SENSOR_VARIANT_SCD40) ||
-                            (aSensorVariant == SCD4X_SENSOR_VARIANT_SCD41) ||
-                            (aSensorVariant == SCD4X_SENSOR_VARIANT_SCD42) ||
-                            (aSensorVariant == SCD4X_SENSOR_VARIANT_SCD43);
+    const uint16_t error = mDriver.getSensorVariant(aSensorVariant);
+    const bool isKnownVariant =
+        (aSensorVariant == SCD4X_SENSOR_VARIANT_SCD40) ||
+        (aSensorVariant == SCD4X_SENSOR_VARIANT_SCD41) ||
+        (aSensorVariant == SCD4X_SENSOR_VARIANT_SCD42) ||
+        (aSensorVariant == SCD4X_SENSOR_VARIANT_SCD43);
     return (error == 0 && isKnownVariant);
 }
 
 void* Scd4x::getDriver() {
-    return std::addressof(mDriver);
+    return &mDriver;
 }
-} // namespace sensirion::upt::i2c_autodetect 
+}  // namespace sensirion::upt::i2c_autodetect

src/SensorWrappers/Sen5x.cpp

@@ -2,12 +2,10 @@
 #include "SensirionCore.h"
 #include <map>
 
-namespace sensirion::upt::i2c_autodetect{
+namespace sensirion::upt::i2c_autodetect {
 
-Sen5x::Sen5x(TwoWire& wire, uint16_t address) : 
-    mWire(wire),
-    mAddress{address},
-    mMetadata{core::SEN5X()} {};
+Sen5x::Sen5x(TwoWire& wire, uint16_t address)
+    : mWire(wire), mAddress{address}, mMetadata{core::SEN5X()} {};
 
 uint16_t Sen5x::start() {
     mDriver.begin(mWire);
@@ -37,48 +35,41 @@ uint16_t Sen5x::measureAndWrite(MeasurementList& measurements,
         return error;
     }
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::PM1P0_MICRO_GRAMM_PER_CUBIC_METER,
+    measurements.emplace_back(
+        mMetadata, core::SignalType::PM1P0_MICRO_GRAMM_PER_CUBIC_METER,
         core::DataPoint{timeStamp, massConcentrationPm1p0});
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::PM2P5_MICRO_GRAMM_PER_CUBIC_METER,
+    measurements.emplace_back(
+        mMetadata, core::SignalType::PM2P5_MICRO_GRAMM_PER_CUBIC_METER,
         core::DataPoint{timeStamp, massConcentrationPm2p5});
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::PM4P0_MICRO_GRAMM_PER_CUBIC_METER,
+    measurements.emplace_back(
+        mMetadata, core::SignalType::PM4P0_MICRO_GRAMM_PER_CUBIC_METER,
         core::DataPoint{timeStamp, massConcentrationPm4p0});
 
-    measurements.emplace_back(mMetadata, 
-        core::SignalType::PM10P0_MICRO_GRAMM_PER_CUBIC_METER,
+    measurements.emplace_back(
+        mMetadata, core::SignalType::PM10P0_MICRO_GRAMM_PER_CUBIC_METER,
         core::DataPoint{timeStamp, massConcentrationPm10p0});
 
+    // Versions 54, 55
+    if (getDeviceType() == core::SEN54() or getDeviceType() == core::SEN55()) {
 
-
-    // Verions 54, 55
-    if (getDeviceType() == core::SEN54() or
-        getDeviceType() == core::SEN55()) {
-
-        measurements.emplace_back(mMetadata, 
-            core::SignalType::RELATIVE_HUMIDITY_PERCENTAGE,
+        measurements.emplace_back(
+            mMetadata, core::SignalType::RELATIVE_HUMIDITY_PERCENTAGE,
             core::DataPoint{timeStamp, ambientHumidity});
 
-        measurements.emplace_back(mMetadata, 
-            core::SignalType::TEMPERATURE_DEGREES_CELSIUS,
+        measurements.emplace_back(
+            mMetadata, core::SignalType::TEMPERATURE_DEGREES_CELSIUS,
             core::DataPoint{timeStamp, ambientTemperature});
 
-        measurements.emplace_back(mMetadata, 
-            core::SignalType::VOC_INDEX,
-            core::DataPoint{timeStamp, vocIndex});
-
+        measurements.emplace_back(mMetadata, core::SignalType::VOC_INDEX,
+                                  core::DataPoint{timeStamp, vocIndex});
     }
     // Version 55
     if (getDeviceType() == core::SEN55()) {
 
-        measurements.emplace_back(mMetadata, 
-            core::SignalType::NOX_INDEX,
-            core::DataPoint{timeStamp, noxIndex});
-
+        measurements.emplace_back(mMetadata, core::SignalType::NOX_INDEX,
+                                  core::DataPoint{timeStamp, noxIndex});
     }
     return HighLevelError::NoError;
 }
@@ -97,14 +88,14 @@ uint16_t Sen5x::initializationStep() {
     }
 
     // Get sensor unique ID (last 8 chars of serial no.)
-    uint8_t serialNumberSize = 32;
+    constexpr uint8_t serialNumberSize = 32;
     unsigned char serialNumber[serialNumberSize];
     error = mDriver.getSerialNumber(serialNumber, serialNumberSize);
     if (error) {
         return error;
     }
-    size_t actualLen = strlen((const char*)serialNumber);
-    size_t numBytesToCopy = min(8, (int)actualLen);
+    size_t actualLen = strlen(reinterpret_cast<const char*>(serialNumber));
+    size_t numBytesToCopy = min(8, static_cast<int>(actualLen));
     uint64_t sensorID = 0;
     for (int i = 0; i < numBytesToCopy - 1; i++) {
         sensorID |= (serialNumber[actualLen - numBytesToCopy - 1 + i]);
@@ -139,7 +130,7 @@ size_t Sen5x::getNumberOfDataPoints() const {
         {core::SEN55(), 8},
     };
     const auto iter = deviceToSignalCount.find(getDeviceType());
-    if (iter == deviceToSignalCount.cend()){
+    if (iter == deviceToSignalCount.cend()) {
         return 0;
     }
     return iter->second;
@@ -150,21 +141,25 @@ unsigned long Sen5x::getMinimumMeasurementIntervalMs() const {
 }
 
 bool Sen5x::probe() {
-    return _determineSensorVersion() == HighLevelError::NoError;
+    // reset the device before probing to ensure a clean state
+    mDriver.deviceReset();
+
+    return _determineSensorVersion() == NoError;
 }
 
 void* Sen5x::getDriver() {
-    return reinterpret_cast<void*>(&mDriver);
+    return &mDriver;
 }
 
 uint8_t Sen5x::getI2CAddress() const {
     return mAddress;
 };
 
 uint16_t Sen5x::_determineSensorVersion() {
-    uint8_t sensorNameSize = 32;
+    constexpr uint8_t sensorNameSize = 32;
     unsigned char sensorNameStr[sensorNameSize];
-    uint16_t error = mDriver.getProductName(sensorNameStr, sensorNameSize);
+    const uint16_t error =
+        mDriver.getProductName(sensorNameStr, sensorNameSize);
 
     if (error) {
         return error;
@@ -183,4 +178,4 @@ uint16_t Sen5x::_determineSensorVersion() {
     }
     return 0;
 }
-} // namespace sensirion::upt::i2c_autodetect 
+}  // namespace sensirion::upt::i2c_autodetect