adding doxygen

sgp30 / sgp40 extra docs for fastTick() constant scanning

Author: mikeysklar

src/components/i2c/drivers/WipperSnapper_I2C_Driver_SGP30.h

@@ -95,13 +95,18 @@ class WipperSnapper_I2C_Driver_SGP30 : public WipperSnapper_I2C_Driver {
   Adafruit_SGP30 *_sgp30; ///< Pointer to SGP30 sensor object
 
   // Fast sampling state
-  uint32_t _lastFastMs = 0;
-  uint32_t _n = 0;
-  uint32_t _eco2Sum = 0;
-  uint32_t _tvocSum = 0;
+  uint32_t _lastFastMs = 0; ///< Millis timestamp of last 1 Hz background read.
+  uint32_t _n = 0;          ///< Number of samples accumulated since last publish.
+  uint32_t _eco2Sum = 0;    ///< Running sum of eCO2 samples for averaging.
+  uint32_t _tvocSum = 0;    ///< Running sum of TVOC samples for averaging.
 
+  /*******************************************************************************/
+  /*!
+      @brief  Returns whether IAQ background sampling should be active.
+      @return True if either eCO2 or TVOC metrics are configured to publish.
+  */
+  /*******************************************************************************/
   inline bool iaqEnabled() {
-    // Enable IAQ background reads if either metric is requested
     return (getSensorECO2Period() > 0) || (getSensorTVOCPeriod() > 0);
   }
 };

src/components/i2c/drivers/WipperSnapper_I2C_Driver_SGP40.h

@@ -147,13 +147,22 @@ class WipperSnapper_I2C_Driver_SGP40 : public WipperSnapper_I2C_Driver {
 
 protected:
   Adafruit_SGP40 *_sgp40; ///< SGP40
+
   // background accumulation state
-  uint32_t _lastFastMs = 0;
-  uint32_t _n = 0;
-  float _vocSum = 0.0f;
-  uint32_t _rawSum = 0;
+  uint32_t _lastFastMs = 0; ///< Millis timestamp of last 1 Hz background read.
+  uint32_t _n = 0;          ///< Number of samples accumulated since last publish.
+  float _vocSum = 0.0f;     ///< Running sum of VOC Index samples for averaging.
+  uint32_t _rawSum = 0;     ///< Running sum of raw SGP40 samples for averaging.
 
-  // enable fast sampling if either output is requested
+  /*******************************************************************************/
+  /*!
+      @brief  Returns whether VOC background sampling should be active.
+      @return True if either VOC Index or raw metrics are configured to publish.
+  */
+  /*******************************************************************************/
+  inline bool vocEnabled() {
+    return (getSensorVOCIndexPeriod() > 0) || (getSensorRawPeriod() > 0);
+  }
   inline bool vocEnabled() {
     return (getSensorVOCIndexPeriod() > 0) || (getSensorRawPeriod() > 0);
   }