Merge pull request #27 from Sensirion/probing

Introduce probing on detection

Author: quentin-cy

src/I2CAutoDetector.h

@@ -20,7 +20,7 @@ class I2CAutoDetector : public IAutoDetector {
 
 
     explicit I2CAutoDetector(TwoWire& wire):
-      _wire(wire),
+      mWire(wire),
       mDetectionTable{createMappingInstance<SensorMappingT>(wire)...}{};
 
     virtual ~I2CAutoDetector() {
@@ -44,13 +44,18 @@ class I2CAutoDetector : public IAutoDetector {
      * @param sensorList SensorList to which add the found sensors
      */
     virtual void findSensors(SensorList& sensorList) override {
-      for (auto tableEntry:mDetectionTable){      
-        _wire.beginTransmission(tableEntry->getI2cAddress());
-        const byte error = _wire.endTransmission();
+      for (auto tableEntry:mDetectionTable){ 
+        if (sensorList.containsSensor(tableEntry->getI2cAddress())) continue;
+        
+        mWire.beginTransmission(tableEntry->getI2cAddress());
+        const byte error = mWire.endTransmission();
         if (error){
             continue;
         }
-        sensorList.addSensor(&tableEntry->getSensor());
+        tableEntry->getSensor().start();
+        if (!tableEntry->getSensor().probe()) continue;
+
+        sensorList.addSensorIfNotPresent(&tableEntry->getSensor());
       }
     }
 
@@ -59,7 +64,7 @@ class I2CAutoDetector : public IAutoDetector {
     using DetectableSensorsT = std::array<ISensorToAddressMapping*, 
           sizeof...(SensorMappingT)>;
 
-    TwoWire& _wire;
+    TwoWire& mWire;
     DetectableSensorsT mDetectionTable;
 
 

src/ISensor.h

@@ -50,6 +50,13 @@ class ISensor {
      */
     virtual size_t getNumberOfDataPoints() const = 0;
 
+    /**
+     * @brief Get the I2C address used by this sensor
+     *
+     * @return uint8_t the I2C address
+     */
+    virtual uint8_t getI2CAddress() const = 0;
+
     /**
      * @brief Call driver methods to perform measurement and update DataPoints
      *
@@ -118,6 +125,15 @@ class ISensor {
      * @return void*
      */
     virtual void* getDriver() = 0;
+
+    /**
+     * @brief Probe the sensor to ensure the right sensor is detected
+     *
+     * @return true if sensor is responding properly, false otherwise.
+     */
+    virtual bool probe() {
+        return true;
+    }
 };
 } // namespace sensirion::upt::i2c_autodetect 
 

src/SensorList.cpp

@@ -9,17 +9,23 @@ constexpr auto TAG = "SensorList";
 
 SensorList::~SensorList() {}
 
-void SensorList::addSensor(ISensor* pSensor) {
-    auto found = std::find_if(mSensorCollection.begin(),
-    mSensorCollection.end(), [pSensor](SensorStateMachine* x) {
-        return x->getSensor()->getDeviceType() == pSensor->getDeviceType();
-    });
-    if (found == mSensorCollection.end()){
+
+void SensorList::addSensorIfNotPresent(ISensor* pSensor) {
+    if (!containsSensor(pSensor->getDeviceType())){
         mSensorCollection.push_back(new SensorStateMachine(pSensor));
     }
 }
 
 
+bool SensorList::containsSensor(uint8_t address) const{
+        auto iter = std::find_if(mSensorCollection.begin(),
+    mSensorCollection.end(), [address](SensorStateMachine* s) {
+        return s->getSensor()->getI2CAddress() == address;
+    });
+    return iter != mSensorCollection.end();
+}
+
+
 size_t SensorList::getTotalNumberOfDataPoints() const {
     size_t totalNumberOfDataPoints = 0;
     for (auto s : mSensorCollection) {
@@ -56,12 +62,19 @@ bool SensorList::containsSensor(core::DeviceType deviceType) const {
 
 void SensorList::removeLostSensors() {
     std::vector<SensorStateMachine*> livingSensors{};
+    std::vector<SensorStateMachine*> lostSensors{};
     for (auto s: mSensorCollection){
         if(s->getSensorState() != SensorStatus::LOST){
             livingSensors.push_back(s);
         }
+        else{
+            lostSensors.push_back(s);
+        }
     }
     mSensorCollection.clear();
     mSensorCollection = livingSensors;
+    for (auto s: lostSensors){
+        delete s;
+    }
 }
 } // namespace sensirion::upt::i2c_autodetect 

src/SensorList.h

@@ -31,7 +31,17 @@ class SensorList {
      *
      * @param[in] pSensor pointer to the sensor to be added to the list
      */
-    void addSensor(ISensor* pSensor);
+    void addSensorIfNotPresent(ISensor* pSensor);
+
+    /**
+     * @brief check if the given I2C address is already used by a sensor in
+     * the list
+     *
+     * @param[in] address to be checked for in the list
+     *
+     * @returns True if the address is found, false otherwise.
+     */
+    bool containsSensor(uint8_t address) const;
 
     /**
      * @brief Counts sensors contained in the list

src/SensorWrappers/Scd30.cpp

@@ -5,18 +5,18 @@
 namespace sensirion::upt::i2c_autodetect{
 
 Scd30::Scd30(TwoWire& wire, const uint16_t address) : 
-    _wire(wire), _address{address}, _metaData{core::SCD30()}{};
+    mWire(wire), mAddress{address}, mMetadata{core::SCD30()}{};
 
 uint16_t Scd30::start() {
-    _driver.begin(_wire, _address);
+    mDriver.begin(mWire, mAddress);
     return 0;
 }
 
 uint16_t Scd30::measureAndWrite(MeasurementList& measurements,
                                 const unsigned long timeStamp) {
     // Check data ready
     uint16_t dataReadyFlag = 0;
-    uint16_t error = _driver.getDataReady(dataReadyFlag);
+    uint16_t error = mDriver.getDataReady(dataReadyFlag);
     if (error) {
         return error;
     }
@@ -29,20 +29,20 @@ uint16_t Scd30::measureAndWrite(MeasurementList& measurements,
     float temperature;
     float humidity;
     error =
-        _driver.readMeasurementData(co2Concentration, temperature, humidity);
+        mDriver.readMeasurementData(co2Concentration, temperature, humidity);
     if (error) {
         return error;
     }
 
-    measurements.emplace_back(_metaData, 
+    measurements.emplace_back(mMetadata, 
         core::SignalType::CO2_PARTS_PER_MILLION,
         core::DataPoint{timeStamp, co2Concentration});
 
-    measurements.emplace_back(_metaData, 
+    measurements.emplace_back(mMetadata, 
         core::SignalType::TEMPERATURE_DEGREES_CELSIUS, 
         core::DataPoint{timeStamp, temperature});
 
-    measurements.emplace_back(_metaData, 
+    measurements.emplace_back(mMetadata, 
         core::SignalType::RELATIVE_HUMIDITY_PERCENTAGE, 
         core::DataPoint{timeStamp, humidity});
 
@@ -53,7 +53,7 @@ uint16_t Scd30::measureAndWrite(MeasurementList& measurements,
      * 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 = _driver.getDataReady(dataReadyFlag);
+    error = mDriver.getDataReady(dataReadyFlag);
     if (error) {
         return error;
     }
@@ -62,9 +62,9 @@ uint16_t Scd30::measureAndWrite(MeasurementList& measurements,
 
 uint16_t Scd30::initializationStep() {
     // stop potentially previously started measurement
-    _driver.stopPeriodicMeasurement();
+    mDriver.stopPeriodicMeasurement();
     // Start Measurement
-    uint16_t error = _driver.startPeriodicMeasurement(0);
+    uint16_t error = mDriver.startPeriodicMeasurement(0);
     if (error) {
         return error;
     }
@@ -74,32 +74,36 @@ uint16_t Scd30::initializationStep() {
     for (size_t i = 0; i < 64; i++) {
         sensorID |= (random(2) << i);
     }
-    _metaData.deviceID = sensorID;
+    mMetadata.deviceID = sensorID;
 
     /* See explanatory comment for measureAndWrite() */
     uint16_t dataReadyFlag;
-    error = _driver.getDataReady(dataReadyFlag);
+    error = mDriver.getDataReady(dataReadyFlag);
     return error;
 }
 
 core::DeviceType Scd30::getDeviceType() const {
-    return _metaData.deviceType;
+    return mMetadata.deviceType;
     ;
 }
 
 core::MetaData Scd30::getMetaData() const {
-    return _metaData;
+    return mMetadata;
 }
 
 size_t Scd30::getNumberOfDataPoints() const {
     return 3;
 }
 
+uint8_t Scd30::getI2CAddress() const {
+    return mAddress;
+};
+
 unsigned long Scd30::getMinimumMeasurementIntervalMs() const {
     return 2000;
 }
 
 void* Scd30::getDriver() {
-    return reinterpret_cast<void*>(&_driver);
+    return reinterpret_cast<void*>(&mDriver);
 }
 } // namespace sensirion::upt::i2c_autodetect 

src/SensorWrappers/Scd30.h

@@ -16,15 +16,16 @@ class Scd30 : public ISensor {
     uint16_t initializationStep() override;
     DeviceType getDeviceType() const override;
     core::MetaData getMetaData() const override;
+    uint8_t getI2CAddress() const override;
     size_t getNumberOfDataPoints() const override;
     unsigned long getMinimumMeasurementIntervalMs() const override;
     void* getDriver() override;
 
   private:
-    TwoWire& _wire;
-    uint16_t _address;
-    SensirionI2cScd30 _driver;
-    core::MetaData _metaData;
+    TwoWire& mWire;
+    uint16_t mAddress;
+    SensirionI2cScd30 mDriver;
+    core::MetaData mMetadata;
 };
 } // namespace sensirion::upt::i2c_autodetect 
 

src/SensorWrappers/Scd4x.cpp

@@ -67,6 +67,10 @@ core::MetaData Scd4x::getMetaData() const {
     return mMetadata;
 }
 
+uint8_t Scd4x::getI2CAddress() const {
+    return mAddress;
+};
+
 size_t Scd4x::getNumberOfDataPoints() const {
     return 3;
 }

src/SensorWrappers/Scd4x.h

@@ -17,6 +17,7 @@ class Scd4x : public ISensor {
     DeviceType getDeviceType() const override;
     core::MetaData getMetaData() const override;
     size_t getNumberOfDataPoints() const override;
+    uint8_t getI2CAddress() const override;
     unsigned long getMinimumMeasurementIntervalMs() const override;
     // Same as measurement interval
     unsigned long getInitializationIntervalMs() const override;