bsec: configure sensors for low power+caching

facchinm · facchinm · commit aeb9f6b5848c · 2024-03-28T16:17:56.000+01:00
diff --git a/src/AirQualityClass.cpp b/src/AirQualityClass.cpp
@@ -29,6 +29,24 @@ AirQualityClass::~AirQualityClass()
 {
 }
 
+/* Configure the BSEC library with information about the sensor
+    18v/33v = Voltage at Vdd. 1.8V or 3.3V
+    3s/300s = BSEC operating mode, BSEC_SAMPLE_RATE_LP or BSEC_SAMPLE_RATE_ULP
+    4d/28d = Operating age of the sensor in days
+    generic_18v_3s_4d
+    generic_18v_3s_28d
+    generic_18v_300s_4d
+    generic_18v_300s_28d
+    generic_33v_3s_4d
+    generic_33v_3s_28d
+    generic_33v_300s_4d
+    generic_33v_300s_28d
+*/
+
+extern "C" const uint8_t bsec_config_iaq[] = {
+#include "config/generic_33v_3s_4d/bsec_iaq.txt"
+};
+
 int AirQualityClass::begin()
 {
   _revision = board_revision();
@@ -39,6 +57,7 @@ int AirQualityClass::begin()
       if (checkIaqSensorStatus() == STATUS_ERROR){
         return 0;
       }
+      iaqSensor->setConfig(bsec_config_iaq);
 
       bsec_virtual_sensor_t sensorList[13] = {
         BSEC_OUTPUT_IAQ,
@@ -55,7 +74,7 @@ int AirQualityClass::begin()
         BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY,
         BSEC_OUTPUT_GAS_PERCENTAGE
       };
-      iaqSensor->updateSubscription(sensorList, 13, BSEC_SAMPLE_RATE_CONT);
+      iaqSensor->updateSubscription(sensorList, 13, BSEC_SAMPLE_RATE_LP);
       if (checkIaqSensorStatus() == STATUS_ERROR){
         return 0;
       }
@@ -94,62 +113,63 @@ void AirQualityClass::end()
 
 float AirQualityClass::readVOC()
 {
-  float reading = 0.0;
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    reading = iaqSensor->breathVocEquivalent;
+    if(iaqSensor->run()){
+      breathVocEquivalent = iaqSensor->breathVocEquivalent;
+    }
   }
-  return reading;
+  return breathVocEquivalent;
 }
 
 float AirQualityClass::readGasResistor()
 {
-  float reading = 0.0;
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    reading = iaqSensor->gasResistance;
+    if(iaqSensor->run()){
+      gasResistance = iaqSensor->gasResistance;
+    }
   }
-  return reading;
+  return gasResistance;
 }
 
 float AirQualityClass::readIAQ()
 {
-  float reading = 0.0;
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    reading = iaqSensor->iaq;
+    if(iaqSensor->run()){
+      iaq = iaqSensor->iaq;
+    }
   }
-  return reading;
+  return iaq;
 }
 
 float AirQualityClass::readIAQAccuracy()
 {
-  float reading = 0.0;
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    reading = iaqSensor->iaqAccuracy;
+    if(iaqSensor->run()){
+      iaqAccuracy = iaqSensor->iaqAccuracy;
+    }
   }
-  return reading;
+  return iaqAccuracy;
 }
 
 float AirQualityClass::readStaticIAQ()
 {
-  float reading = 0.0;
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    reading = iaqSensor->staticIaq;
+    if(iaqSensor->run()){
+      staticIaq = iaqSensor->staticIaq;
+    }
   }
-  return reading;
+  return staticIaq;
 }
 
 
 float AirQualityClass::readCO2()
 {
   float reading = 0.0;
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    reading = iaqSensor->co2Equivalent;
+    if(iaqSensor->run()){
+      co2Equivalent = iaqSensor->co2Equivalent;
+    }
   }
-  return reading;
+  return co2Equivalent;
 }
 
diff --git a/src/AirQualityClass.h b/src/AirQualityClass.h
@@ -25,6 +25,12 @@ class AirQualityClass {
   private:
     // Helper functions declarations
     int checkIaqSensorStatus(void);
+    float breathVocEquivalent = 0.0f;
+    float gasResistance = 0.0f;
+    float iaq = 0.0f;
+    float iaqAccuracy = 0.0f;
+    float staticIaq = 0.0f;
+    float co2Equivalent = 0.0f;
 
   private:
 
diff --git a/src/EnvClass.cpp b/src/EnvClass.cpp
@@ -30,6 +30,8 @@ EnvClass::~EnvClass()
 {
 }
 
+extern const uint8_t bsec_config_iaq[];
+
 int EnvClass::begin()
 {
   _revision = board_revision();
@@ -40,21 +42,25 @@ int EnvClass::begin()
       if (checkIaqSensorStatus() == STATUS_ERROR){
         return 0;
       }
+      iaqSensor->setConfig(bsec_config_iaq);
 
-      bsec_virtual_sensor_t sensorList[10] = {
-        BSEC_OUTPUT_RAW_TEMPERATURE,
-        BSEC_OUTPUT_RAW_PRESSURE,
-        BSEC_OUTPUT_RAW_HUMIDITY,
-        BSEC_OUTPUT_RAW_GAS,
+      bsec_virtual_sensor_t sensorList[13] = {
         BSEC_OUTPUT_IAQ,
         BSEC_OUTPUT_STATIC_IAQ,
         BSEC_OUTPUT_CO2_EQUIVALENT,
         BSEC_OUTPUT_BREATH_VOC_EQUIVALENT,
+        BSEC_OUTPUT_RAW_TEMPERATURE,
+        BSEC_OUTPUT_RAW_PRESSURE,
+        BSEC_OUTPUT_RAW_HUMIDITY,
+        BSEC_OUTPUT_RAW_GAS,
+        BSEC_OUTPUT_STABILIZATION_STATUS,
+        BSEC_OUTPUT_RUN_IN_STATUS,
         BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE,
         BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY,
+        BSEC_OUTPUT_GAS_PERCENTAGE
       };
 
-      iaqSensor->updateSubscription(sensorList, 10, BSEC_SAMPLE_RATE_CONT);
+      iaqSensor->updateSubscription(sensorList, 10, BSEC_SAMPLE_RATE_LP);
       if (checkIaqSensorStatus() == STATUS_ERROR){
         return 0;
       }
@@ -102,12 +108,13 @@ void EnvClass::end()
 float EnvClass::readTemperature(int units /*= CELSIUS*/)
 {
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    float reading = iaqSensor->temperature;
+    if(iaqSensor->run()){
+      temperature = iaqSensor->temperature;
+    }
     if (units == FAHRENHEIT){
-      return (reading * 9.0 / 5.0) + 32.0;
+      return (temperature * 9.0 / 5.0) + 32.0;
     } else {
-      return reading;
+      return temperature;
     }
   }
   return HTS221->readTemperature(units);
@@ -116,9 +123,10 @@ float EnvClass::readTemperature(int units /*= CELSIUS*/)
 float EnvClass::readHumidity()
 {
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    return iaqSensor->humidity;
-
+    if(iaqSensor->run()){
+      humidity = iaqSensor->humidity;
+    }
+    return humidity;
   }
   return HTS221->readHumidity();
 }
diff --git a/src/EnvClass.h b/src/EnvClass.h
@@ -28,6 +28,8 @@ class EnvClass {
 
     int (*board_revision)(void);
     int _revision;
+    float temperature = 0.0f;
+    float humidity = 0.0f;
 };
 
 #endif //_ENVCLASS_H_INCLUDED
diff --git a/src/PressureClass.cpp b/src/PressureClass.cpp
@@ -29,6 +29,8 @@ PressureClass::~PressureClass()
 {
 }
 
+extern const uint8_t bsec_config_iaq[];
+
 int PressureClass::begin()
 {
   _revision = board_revision();
@@ -39,21 +41,25 @@ int PressureClass::begin()
       if (checkIaqSensorStatus() == STATUS_ERROR){
         return 0;
       }
+      iaqSensor->setConfig(bsec_config_iaq);
 
-      bsec_virtual_sensor_t sensorList[10] = {
-        BSEC_OUTPUT_RAW_TEMPERATURE,
-        BSEC_OUTPUT_RAW_PRESSURE,
-        BSEC_OUTPUT_RAW_HUMIDITY,
-        BSEC_OUTPUT_RAW_GAS,
+      bsec_virtual_sensor_t sensorList[13] = {
         BSEC_OUTPUT_IAQ,
         BSEC_OUTPUT_STATIC_IAQ,
         BSEC_OUTPUT_CO2_EQUIVALENT,
         BSEC_OUTPUT_BREATH_VOC_EQUIVALENT,
+        BSEC_OUTPUT_RAW_TEMPERATURE,
+        BSEC_OUTPUT_RAW_PRESSURE,
+        BSEC_OUTPUT_RAW_HUMIDITY,
+        BSEC_OUTPUT_RAW_GAS,
+        BSEC_OUTPUT_STABILIZATION_STATUS,
+        BSEC_OUTPUT_RUN_IN_STATUS,
         BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE,
         BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY,
+        BSEC_OUTPUT_GAS_PERCENTAGE
       };
 
-      iaqSensor->updateSubscription(sensorList, 10, BSEC_SAMPLE_RATE_CONT);
+      iaqSensor->updateSubscription(sensorList, 10, BSEC_SAMPLE_RATE_LP);
       if (checkIaqSensorStatus() == STATUS_ERROR){
         return 0;
       }
@@ -102,14 +108,15 @@ void PressureClass::end()
 float PressureClass::readPressure(int units)
 {
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){ }
-    float reading = iaqSensor->pressure/1000;
+    if(iaqSensor->run()){
+      pressure = iaqSensor->pressure/1000;
+    }
     if (units == MILLIBAR) { // 1 kPa = 10 millibar
-      return reading * 10;
+      return pressure * 10;
     } else if (units == PSI) {  // 1 kPa = 0.145038 PSI
-      return reading * 0.145038;
+      return pressure * 0.145038;
     } else {
-      return reading;
+      return pressure;
     }
   }
   return LPS22HB->readPressure(units);
@@ -118,12 +125,13 @@ float PressureClass::readPressure(int units)
 float PressureClass::readTemperature(int units /*= CELSIUS*/)
 {
   if (_revision == BOARD_REVISION_2) {
-    while(!iaqSensor->run()){}
-    float reading = iaqSensor->temperature;
+    if(iaqSensor->run()){
+      temperature = iaqSensor->temperature;
+    }
     if (units == FAHRENHEIT){
-      return (reading * 9.0 / 5.0) + 32.0;
+      return (temperature * 9.0 / 5.0) + 32.0;
     } else {
-      return reading;
+      return temperature;
     }
   }
   return LPS22HB->readTemperature();
diff --git a/src/PressureClass.h b/src/PressureClass.h
@@ -24,6 +24,8 @@ class PressureClass {
 
     LPS22HBClass* LPS22HB;
 
+    float pressure = 0.0f;
+    float temperature = 0.0f;
 
   private:
 

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,24 @@ AirQualityClass::~AirQualityClass()`
`29`	`29`	`{`
`30`	`30`	`}`
`31`	`31`
	`32`	`+/* Configure the BSEC library with information about the sensor`
	`33`	`+ 18v/33v = Voltage at Vdd. 1.8V or 3.3V`
	`34`	`+ 3s/300s = BSEC operating mode, BSEC_SAMPLE_RATE_LP or BSEC_SAMPLE_RATE_ULP`
	`35`	`+ 4d/28d = Operating age of the sensor in days`
	`36`	`+ generic_18v_3s_4d`
	`37`	`+ generic_18v_3s_28d`
	`38`	`+ generic_18v_300s_4d`
	`39`	`+ generic_18v_300s_28d`
	`40`	`+ generic_33v_3s_4d`
	`41`	`+ generic_33v_3s_28d`
	`42`	`+ generic_33v_300s_4d`
	`43`	`+ generic_33v_300s_28d`
	`44`	`+*/`
	`45`	`+`
	`46`	`+extern "C" const uint8_t bsec_config_iaq[] = {`
	`47`	`+#include "config/generic_33v_3s_4d/bsec_iaq.txt"`
	`48`	`+};`
	`49`	`+`
`32`	`50`	`int AirQualityClass::begin()`
`33`	`51`	`{`
`34`	`52`	`_revision = board_revision();`
`@@ -39,6 +57,7 @@ int AirQualityClass::begin()`
`39`	`57`	`if (checkIaqSensorStatus() == STATUS_ERROR){`
`40`	`58`	`return 0;`
`41`	`59`	`}`
	`60`	`+ iaqSensor->setConfig(bsec_config_iaq);`
`42`	`61`
`43`	`62`	`bsec_virtual_sensor_t sensorList[13] = {`
`44`	`63`	`BSEC_OUTPUT_IAQ,`
`@@ -55,7 +74,7 @@ int AirQualityClass::begin()`
`55`	`74`	`BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY,`
`56`	`75`	`BSEC_OUTPUT_GAS_PERCENTAGE`
`57`	`76`	`};`
`58`		`- iaqSensor->updateSubscription(sensorList, 13, BSEC_SAMPLE_RATE_CONT);`
	`77`	`+ iaqSensor->updateSubscription(sensorList, 13, BSEC_SAMPLE_RATE_LP);`
`59`	`78`	`if (checkIaqSensorStatus() == STATUS_ERROR){`
`60`	`79`	`return 0;`
`61`	`80`	`}`
`@@ -94,62 +113,63 @@ void AirQualityClass::end()`
`94`	`113`
`95`	`114`	`float AirQualityClass::readVOC()`
`96`	`115`	`{`
`97`		`- float reading = 0.0;`
`98`	`116`	`if (_revision == BOARD_REVISION_2) {`
`99`		`- while(!iaqSensor->run()){ }`
`100`		`- reading = iaqSensor->breathVocEquivalent;`
	`117`	`+ if(iaqSensor->run()){`
	`118`	`+ breathVocEquivalent = iaqSensor->breathVocEquivalent;`
	`119`	`+ }`
`101`	`120`	`}`
`102`		`- return reading;`
	`121`	`+ return breathVocEquivalent;`
`103`	`122`	`}`
`104`	`123`
`105`	`124`	`float AirQualityClass::readGasResistor()`
`106`	`125`	`{`
`107`		`- float reading = 0.0;`
`108`	`126`	`if (_revision == BOARD_REVISION_2) {`
`109`		`- while(!iaqSensor->run()){ }`
`110`		`- reading = iaqSensor->gasResistance;`
	`127`	`+ if(iaqSensor->run()){`
	`128`	`+ gasResistance = iaqSensor->gasResistance;`
	`129`	`+ }`
`111`	`130`	`}`
`112`		`- return reading;`
	`131`	`+ return gasResistance;`
`113`	`132`	`}`
`114`	`133`
`115`	`134`	`float AirQualityClass::readIAQ()`
`116`	`135`	`{`
`117`		`- float reading = 0.0;`
`118`	`136`	`if (_revision == BOARD_REVISION_2) {`
`119`		`- while(!iaqSensor->run()){ }`
`120`		`- reading = iaqSensor->iaq;`
	`137`	`+ if(iaqSensor->run()){`
	`138`	`+ iaq = iaqSensor->iaq;`
	`139`	`+ }`
`121`	`140`	`}`
`122`		`- return reading;`
	`141`	`+ return iaq;`
`123`	`142`	`}`
`124`	`143`
`125`	`144`	`float AirQualityClass::readIAQAccuracy()`
`126`	`145`	`{`
`127`		`- float reading = 0.0;`
`128`	`146`	`if (_revision == BOARD_REVISION_2) {`
`129`		`- while(!iaqSensor->run()){ }`
`130`		`- reading = iaqSensor->iaqAccuracy;`
	`147`	`+ if(iaqSensor->run()){`
	`148`	`+ iaqAccuracy = iaqSensor->iaqAccuracy;`
	`149`	`+ }`
`131`	`150`	`}`
`132`		`- return reading;`
	`151`	`+ return iaqAccuracy;`
`133`	`152`	`}`
`134`	`153`
`135`	`154`	`float AirQualityClass::readStaticIAQ()`
`136`	`155`	`{`
`137`		`- float reading = 0.0;`
`138`	`156`	`if (_revision == BOARD_REVISION_2) {`
`139`		`- while(!iaqSensor->run()){ }`
`140`		`- reading = iaqSensor->staticIaq;`
	`157`	`+ if(iaqSensor->run()){`
	`158`	`+ staticIaq = iaqSensor->staticIaq;`
	`159`	`+ }`
`141`	`160`	`}`
`142`		`- return reading;`
	`161`	`+ return staticIaq;`
`143`	`162`	`}`
`144`	`163`
`145`	`164`
`146`	`165`	`float AirQualityClass::readCO2()`
`147`	`166`	`{`
`148`	`167`	`float reading = 0.0;`
`149`	`168`	`if (_revision == BOARD_REVISION_2) {`
`150`		`- while(!iaqSensor->run()){ }`
`151`		`- reading = iaqSensor->co2Equivalent;`
	`169`	`+ if(iaqSensor->run()){`
	`170`	`+ co2Equivalent = iaqSensor->co2Equivalent;`
	`171`	`+ }`
`152`	`172`	`}`
`153`		`- return reading;`
	`173`	`+ return co2Equivalent;`
`154`	`174`	`}`
`155`	`175`