doxygen accumulation vars

Author: mikeysklar

src/components/i2c/drivers/WipperSnapper_I2C_Driver_SGP30.h

@@ -59,6 +59,13 @@ class WipperSnapper_I2C_Driver_SGP30 : public WipperSnapper_I2C_Driver {
     return true;
   }
 
+  /*******************************************************************************/
+  /*!
+      @brief    Reads the current eCO2 value (ppm).
+      @param    senseEvent Pointer to event to fill.
+      @returns  True if a value was obtained, False otherwise.
+  */
+  /*******************************************************************************/
   bool getEventECO2(sensors_event_t *senseEvent) override {
     if (!_sgp30)
       return false;
@@ -68,6 +75,13 @@ class WipperSnapper_I2C_Driver_SGP30 : public WipperSnapper_I2C_Driver {
     return ok;
   }
 
+  /*******************************************************************************/
+  /*!
+      @brief    Reads the current TVOC value (ppb).
+      @param    senseEvent Pointer to event to fill.
+      @returns  True if a value was obtained, False otherwise.
+  */
+  /*******************************************************************************/
   bool getEventTVOC(sensors_event_t *senseEvent) override {
     if (!_sgp30)
       return false;
@@ -77,6 +91,13 @@ class WipperSnapper_I2C_Driver_SGP30 : public WipperSnapper_I2C_Driver {
     return ok;
   }
 
+  /*******************************************************************************/
+  /*!
+      @brief    Background sampler to maintain ~1 Hz IAQ reads and accumulate
+                samples for later averaging at publish time.
+      @note     Must be non-blocking; invoked once per update loop.
+  */
+  /*******************************************************************************/
   void fastTick() override {
     if (!iaqEnabled())
       return; // nothing enabled, save cycles
@@ -95,15 +116,21 @@ 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; ///< Last millisecond timestamp of a fastTick sample.
+  uint32_t _n = 0;          ///< Number of accumulated background samples.
+  uint32_t _eco2Sum = 0;    ///< Sum of eCO2 samples for averaging.
+  uint32_t _tvocSum = 0;    ///< Sum of TVOC samples for averaging.
 
+  /*******************************************************************************/
+  /*!
+      @brief    Indicates whether IAQ background sampling should run.
+      @returns  True if either eCO2 or TVOC periods are enabled; otherwise false.
+  */
+  /*******************************************************************************/
   inline bool iaqEnabled() {
     // Enable IAQ background reads if either metric is requested
     return (getSensorECO2Period() > 0) || (getSensorTVOCPeriod() > 0);
   }
 };
 
-#endif // WipperSnapper_I2C_Driver_SGP30
+#endif // WipperSnapper_I2C_Driver_SGP30_H

src/components/i2c/drivers/WipperSnapper_I2C_Driver_SGP40.h

@@ -146,17 +146,23 @@ 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;
+ Adafruit_SGP40 *_sgp40; ///< Pointer to the underlying Adafruit SGP40 object.
 
-  // enable fast sampling if either output is requested
+  // Background accumulation state
+  uint32_t _lastFastMs = 0; ///< Millisecond timestamp of last fastTick sample.
+  uint32_t _n = 0;          ///< Number of background samples accumulated.
+  float _vocSum = 0.0f;     ///< Sum of VOC index samples for averaging.
+  uint32_t _rawSum = 0;     ///< Sum of raw signal samples for averaging.
+
+  /*******************************************************************************/
+  /*!
+      @brief    Indicates whether VOC background sampling should run.
+      @returns  True if either VOC index or raw period polling is enabled;
+                otherwise false.
+  */
+  /*******************************************************************************/
   inline bool vocEnabled() {
     return (getSensorVOCIndexPeriod() > 0) || (getSensorRawPeriod() > 0);
   }
-};
 
 #endif // WipperSnapper_I2C_Driver_SGP40_H