Merge pull request #6 from tyeth/offline-mode-INA-refactor-from-flat0808

Offline mode ina refactor from flat0808

Author: tyeth

.gitignore

@@ -42,6 +42,7 @@ src/.vscode/settings.json
 .DS_STORE
 examples/Wippersnapper_demo/build/
 src/Wippersnapper_demo.ino.cpp
+build_output_*.txt
 
 # Virtual environment directories
 .venv/

library.properties

@@ -7,4 +7,4 @@ paragraph=Arduino application for Adafruit.io WipperSnapper
 category=Communication
 url=https://github.com/adafruit/Adafruit_Wippersnapper_Arduino
 architectures=*
-depends=OmronD6T - Community Fork, SdFat - Adafruit Fork, Adafruit NeoPixel, Adafruit SPIFlash, ArduinoJson, Adafruit DotStar, Adafruit HDC302x, Adafruit INA219, Adafruit INA260 Library, Adafruit LTR329 and LTR303, Adafruit LTR390 Library, Adafruit MCP3421, Adafruit NAU7802 Library, Adafruit SleepyDog Library, Adafruit TMP117, Adafruit TinyUSB Library, Adafruit AHTX0, Adafruit BME280 Library, Adafruit BMP280 Library, Adafruit BMP3XX Library, Adafruit DPS310, Adafruit DS248x, Adafruit SCD30, Adafruit SGP30 Sensor, Adafruit SGP40 Sensor, Sensirion I2C SCD4x, Sensirion I2C SEN5X, Sensirion I2C SEN66, arduino-sht, Adafruit Si7021 Library, Adafruit MQTT Library, Adafruit MS8607, Adafruit MCP9808 Library, Adafruit MCP9600 Library, Adafruit MPL115A2, Adafruit MPRLS Library, Adafruit TSL2591 Library, Adafruit_VL53L0X, Adafruit VL53L1X, STM32duino VL53L4CD, STM32duino VL53L4CX, Adafruit_VL6180X, Adafruit PM25 AQI Sensor, Adafruit VCNL4020 Library, Adafruit VCNL4040, Adafruit VCNL4200 Library, Adafruit VEML7700 Library, Adafruit LC709203F, Adafruit LPS2X, Adafruit LPS28, Adafruit LPS35HW, Adafruit seesaw Library, Adafruit BME680 Library, Adafruit MAX1704X, Adafruit ADT7410 Library, Adafruit HTS221, Adafruit HTU21DF Library, Adafruit HTU31D Library, Adafruit PCT2075, hp_BH1750, ENS160 - Adafruit Fork, Adafruit BusIO, Adafruit Unified Sensor, Sensirion Core, Adafruit GFX Library, Adafruit LED Backpack Library, Adafruit LiquidCrystal, Adafruit SH110X, Adafruit SSD1306, RTClib, StreamUtils, Adafruit SHT4x Library, Adafruit GPS Library, Adafruit uBlox
+depends=OmronD6T - Community Fork, SdFat - Adafruit Fork, Adafruit NeoPixel, Adafruit SPIFlash, ArduinoJson, Adafruit DotStar, Adafruit HDC302x, Adafruit INA219, Adafruit INA237 and INA238 Library, Adafruit INA260 Library, Adafruit LTR329 and LTR303, Adafruit LTR390 Library, Adafruit MCP3421, Adafruit NAU7802 Library, Adafruit SleepyDog Library, Adafruit TMP117, Adafruit TinyUSB Library, Adafruit AHTX0, Adafruit BME280 Library, Adafruit BMP280 Library, Adafruit BMP3XX Library, Adafruit DPS310, Adafruit DS248x, Adafruit SCD30, Adafruit SGP30 Sensor, Adafruit SGP40 Sensor, Sensirion I2C SCD4x, Sensirion I2C SEN5X, Sensirion I2C SEN66, arduino-sht, Adafruit Si7021 Library, Adafruit MQTT Library, Adafruit MS8607, Adafruit MCP9808 Library, Adafruit MCP9600 Library, Adafruit MPL115A2, Adafruit MPRLS Library, Adafruit TSL2591 Library, Adafruit_VL53L0X, Adafruit VL53L1X, STM32duino VL53L4CD, STM32duino VL53L4CX, Adafruit_VL6180X, Adafruit PM25 AQI Sensor, Adafruit VCNL4020 Library, Adafruit VCNL4040, Adafruit VCNL4200 Library, Adafruit VEML7700 Library, Adafruit LC709203F, Adafruit LPS2X, Adafruit LPS28, Adafruit LPS35HW, Adafruit seesaw Library, Adafruit BME680 Library, Adafruit MAX1704X, Adafruit ADT7410 Library, Adafruit HTS221, Adafruit HTU21DF Library, Adafruit HTU31D Library, Adafruit PCT2075, hp_BH1750, ENS160 - Adafruit Fork, Adafruit BusIO, Adafruit Unified Sensor, Sensirion Core, Adafruit GFX Library, Adafruit LED Backpack Library, Adafruit LiquidCrystal, Adafruit SH110X, Adafruit SSD1306, RTClib, StreamUtils, Adafruit SHT4x Library, Adafruit GPS Library, Adafruit uBlox

platformio.ini

@@ -39,6 +39,7 @@ lib_deps =
     adafruit/Adafruit DPS310
     adafruit/Adafruit DS248x
     adafruit/Adafruit INA219
+    adafruit/Adafruit INA237 and INA238 Library
     adafruit/Adafruit INA260 Library
     adafruit/Adafruit HDC302x
     adafruit/Adafruit HTS221

src/Wippersnapper_V2.h

@@ -30,9 +30,7 @@
 */
 #ifdef WS_DEBUG
 #define WS_DEBUG_PRINT(...)                                                    \
-  {                                                                            \
-    WS_PRINTER.print(__VA_ARGS__);                                             \
-  } /**< Print debug message to serial */
+  { WS_PRINTER.print(__VA_ARGS__); } /**< Print debug message to serial */
 #define WS_DEBUG_PRINTLN(...)                                                  \
   {                                                                            \
     WS_PRINTER.println(__VA_ARGS__);                                           \
@@ -44,11 +42,9 @@
   } /**< Print debug message in hexadecimal */
 #else
 #define WS_DEBUG_PRINT(...)                                                    \
-  {                                                                            \
-  } /**< Debug print */
+  {} /**< Debug print */
 #define WS_DEBUG_PRINTLN(...)                                                  \
-  {                                                                            \
-  } /**< Debug println */
+  {} /**< Debug println */
 #endif
 
 /*!

src/components/i2c/controller.cpp

@@ -133,6 +133,26 @@ static const std::map<std::string, FnCreateI2CSensorDriver> I2cFactorySensor = {
         const char *driver_name) -> drvBase * {
        return new drvIna219(i2c, addr, mux_channel, driver_name);
      }},
+    {"ina228",
+     [](TwoWire *i2c, uint16_t addr, uint32_t mux_channel,
+        const char *driver_name) -> drvBase * {
+       return new drvIna228(i2c, addr, mux_channel, driver_name);
+     }},
+    {"ina237",
+     [](TwoWire *i2c, uint16_t addr, uint32_t mux_channel,
+        const char *driver_name) -> drvBase * {
+       return new drvIna237(i2c, addr, mux_channel, driver_name);
+     }},
+    {"ina238",
+     [](TwoWire *i2c, uint16_t addr, uint32_t mux_channel,
+        const char *driver_name) -> drvBase * {
+       return new drvIna238(i2c, addr, mux_channel, driver_name);
+     }},
+    {"ina260",
+     [](TwoWire *i2c, uint16_t addr, uint32_t mux_channel,
+        const char *driver_name) -> drvBase * {
+       return new drvIna260(i2c, addr, mux_channel, driver_name);
+     }},
     {"lc709203f",
      [](TwoWire *i2c, uint16_t addr, uint32_t mux_channel,
         const char *driver_name) -> drvBase * {
@@ -372,11 +392,12 @@ static const std::unordered_map<uint16_t, std::vector<const char *>>
         {0x38, {"aht20", "max17048"}},
         {0x39, {"tsl2591"}},
         {0x40,
-         {"htu21d", "htu31d", "ina219", "ina260", "ms8607", "si7021",
-          "stemma_soil"}},
-        {0x41, {"htu31d", "ina219", "ina260"}},
-        {0x44, {"hdc302x", "ina260", "sht3x", "sht4x"}},
-        {0x45, {"hdc302x", "ina260", "sht3x"}},
+         {"htu21d", "htu31d", "ina219", "ina228", "ina237", "ina238", "ina260",
+          "ms8607", "si7021", "stemma_soil"}},
+        {0x41, {"htu31d", "ina219", "ina228", "ina237", "ina238", "ina260"}},
+        {0x44,
+         {"hdc302x", "ina228", "ina237", "ina238", "ina260", "sht3x", "sht4x"}},
+        {0x45, {"hdc302x", "ina228", "ina237", "ina238", "ina260", "sht3x"}},
         {0x46, {"hdc302x"}},
         {0x47, {"hdc302x"}},
         {0x48, {"adt7410", "pct2075", "tmp117"}},

src/components/i2c/controller.h

@@ -33,6 +33,10 @@
 #include "drivers/drvHts221.h"
 #include "drivers/drvHtu21d.h"
 #include "drivers/drvIna219.h"
+#include "drivers/drvIna228.h"
+#include "drivers/drvIna237.h"
+#include "drivers/drvIna238.h"
+#include "drivers/drvIna260.h"
 #include "drivers/drvLc709203f.h"
 #include "drivers/drvLps22hb.h"
 #include "drivers/drvLps25hb.h"

src/components/i2c/drivers/drvBase.h

@@ -15,8 +15,11 @@
 
 #ifndef DRV_BASE_H
 #define DRV_BASE_H
+#include "helpers/ws_helper_macros.h"
 #include <Adafruit_Sensor.h>
 #include <Arduino.h>
+#include <Wire.h>
+#include <map>
 #include <protos/i2c.pb.h>
 
 #define NO_MUX_CH 0xFFFF;           ///< No MUX channel specified

src/components/i2c/drivers/drvIna228.cpp

@@ -0,0 +1,91 @@
+/*!
+ * @file drvIna228.cpp
+ *
+ * Device driver for the INA228 High Precision DC Current and Voltage Monitor
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Tyeth Gundry 2025 for Adafruit Industries.
+ *
+ * MIT license, all text here must be included in any redistribution.
+ *
+ */
+
+#include "drvIna228.h"
+#include <Adafruit_INA228.h>
+
+/*******************************************************************************/
+/*!
+    @brief    Destructor for an INA228 sensor.
+*/
+/*******************************************************************************/
+drvIna228::~drvIna228() {
+  if (_ina228) {
+    delete _ina228;
+    _ina228 = nullptr;
+  }
+}
+
+/*******************************************************************************/
+/*!
+    @brief    Initializes the INA228 sensor and begins I2C.
+    @returns  True if initialized successfully, False otherwise.
+*/
+/*******************************************************************************/
+bool drvIna228::begin() {
+  _ina228 = new Adafruit_INA228();
+  if (!_ina228->begin(_address, _i2c)) {
+    WS_DEBUG_PRINTLN("INA228 failed to initialise!");
+    return false;
+  }
+
+  _ina228->setShunt(0.015, 10.0);
+  if (_ina228->getCurrentConversionTime() != INA228_TIME_280_us) {
+    _ina228->setCurrentConversionTime(INA228_TIME_280_us);
+  }
+  if (_ina228->getAveragingCount() != INA228_COUNT_16) {
+    _ina228->setAveragingCount(INA228_COUNT_16);
+  }
+  if (_ina228->getVoltageConversionTime() != INA228_TIME_150_us) {
+    _ina228->setVoltageConversionTime(INA228_TIME_150_us);
+  }
+  return true;
+}
+
+/*******************************************************************************/
+/*!
+    @brief    Reads a voltage sensor and converts the
+              reading into the expected SI unit.
+    @param    voltageEvent
+              voltage sensor reading, in volts.
+    @returns  True if the sensor event was obtained successfully, False
+              otherwise.
+*/
+/*******************************************************************************/
+bool drvIna228::getEventVoltage(sensors_event_t *voltageEvent) {
+  voltageEvent->voltage = _ina228->getBusVoltage_V();
+  return true;
+}
+
+/**
+ * @brief   Get the current sensor event.
+ *
+ * @param   currentEvent  Pointer to the current sensor event.
+ *
+ * @returns True if the sensor event was obtained successfully, False
+ * otherwise.
+ */
+bool drvIna228::getEventCurrent(sensors_event_t *currentEvent) {
+  currentEvent->current = _ina228->getCurrent_mA();
+  return true;
+}
+
+void drvIna228::ConfigureDefaultSensorTypes() {
+  _default_sensor_types_count = 2;
+  _default_sensor_types[0] =
+      wippersnapper_sensor_SensorType_SENSOR_TYPE_VOLTAGE;
+  _default_sensor_types[1] =
+      wippersnapper_sensor_SensorType_SENSOR_TYPE_CURRENT;
+}

src/components/i2c/drivers/drvIna228.h

@@ -0,0 +1,89 @@
+/*!
+ * @file drvIna228.h
+ *
+ * Device driver for the INA228 High Precision DC Current and Voltage Monitor
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Tyeth Gundry 2025 for Adafruit Industries.
+ *
+ * MIT license, all text here must be included in any redistribution.
+ *
+ */
+#ifndef DRV_INA228_H
+#define DRV_INA228_H
+
+#include "drvBase.h"
+
+class Adafruit_INA228;
+
+/**************************************************************************/
+/*!
+    @brief  Class that provides a driver interface for a INA228 sensor.
+*/
+/**************************************************************************/
+class drvIna228 : public drvBase {
+public:
+  /*******************************************************************************/
+  /*!
+      @brief    Constructor for a INA228 sensor.
+      @param    i2c
+                The I2C interface.
+      @param    sensorAddress
+                7-bit device address.
+      @param    mux_channel
+                The I2C multiplexer channel.
+      @param    driver_name
+                The name of the driver.
+  */
+  /*******************************************************************************/
+  drvIna228(TwoWire *i2c, uint16_t sensorAddress, uint32_t mux_channel,
+            const char *driver_name)
+      : drvBase(i2c, sensorAddress, mux_channel, driver_name) {}
+
+  /*******************************************************************************/
+  /*!
+      @brief    Destructor for an INA228 sensor.
+  */
+  /*******************************************************************************/
+  ~drvIna228();
+
+  /*******************************************************************************/
+  /*!
+      @brief    Initializes the INA228 sensor and begins I2C.
+      @returns  True if initialized successfully, False otherwise.
+  */
+  /*******************************************************************************/
+  bool begin();
+
+  /*******************************************************************************/
+  /*!
+      @brief    Reads a voltage sensor and converts the
+                reading into the expected SI unit.
+      @param    voltageEvent
+                voltage sensor reading, in volts.
+      @returns  True if the sensor event was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventVoltage(sensors_event_t *voltageEvent);
+
+  /**
+   * @brief   Get the current sensor event.
+   *
+   * @param   currentEvent  Pointer to the current sensor event.
+   *
+   * @returns True if the sensor event was obtained successfully, False
+   * otherwise.
+   */
+  bool getEventCurrent(sensors_event_t *currentEvent);
+
+  void ConfigureDefaultSensorTypes() override;
+
+protected:
+  Adafruit_INA228 *_ina228; ///< Pointer to INA228 sensor object
+};
+
+#endif // DRV_INA228_H

src/components/i2c/drivers/drvIna237.cpp

@@ -0,0 +1,92 @@
+/*!
+ * @file drvIna237.cpp
+ *
+ * Device driver for the INA237 High Precision DC Current and Voltage Monitor
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) Tyeth Gundry 2025 for Adafruit Industries.
+ *
+ * MIT license, all text here must be included in any redistribution.
+ *
+ */
+
+#include "drvIna237.h"
+#include <Adafruit_INA237.h>
+
+/*******************************************************************************/
+/*!
+    @brief    Destructor for an INA237 sensor.
+*/
+/*******************************************************************************/
+drvIna237::~drvIna237() {
+  if (_ina237) {
+    delete _ina237;
+    _ina237 = nullptr;
+  }
+}
+
+/*******************************************************************************/
+/*!
+    @brief    Initializes the INA237 sensor and begins I2C.
+    @returns  True if initialized successfully, False otherwise.
+*/
+/*******************************************************************************/
+bool drvIna237::begin() {
+  _ina237 = new Adafruit_INA237();
+  if (!_ina237->begin(_address, _i2c)) {
+    WS_DEBUG_PRINTLN("INA237 failed to initialise!");
+    return false;
+  }
+
+  _ina237->setShunt(0.015, 10.0);
+  if (_ina237->getCurrentConversionTime() != INA2XX_TIME_280_us) {
+    _ina237->setCurrentConversionTime(INA2XX_TIME_280_us);
+  }
+  if (_ina237->getAveragingCount() != INA2XX_COUNT_16) {
+    _ina237->setAveragingCount(INA2XX_COUNT_16);
+  }
+  if (_ina237->getVoltageConversionTime() != INA2XX_TIME_150_us) {
+    _ina237->setVoltageConversionTime(INA2XX_TIME_150_us);
+  }
+
+  return true;
+}
+
+/*******************************************************************************/
+/*!
+    @brief    Reads a voltage sensor and converts the
+              reading into the expected SI unit.
+    @param    voltageEvent
+              voltage sensor reading, in volts.
+    @returns  True if the sensor event was obtained successfully, False
+              otherwise.
+*/
+/*******************************************************************************/
+bool drvIna237::getEventVoltage(sensors_event_t *voltageEvent) {
+  voltageEvent->voltage = _ina237->getBusVoltage_V();
+  return true;
+}
+
+/**
+ * @brief   Get the current sensor event.
+ *
+ * @param   currentEvent  Pointer to the current sensor event.
+ *
+ * @returns True if the sensor event was obtained successfully, False
+ * otherwise.
+ */
+bool drvIna237::getEventCurrent(sensors_event_t *currentEvent) {
+  currentEvent->current = _ina237->getCurrent_mA();
+  return true;
+}
+
+void drvIna237::ConfigureDefaultSensorTypes() {
+  _default_sensor_types_count = 2;
+  _default_sensor_types[0] =
+      wippersnapper_sensor_SensorType_SENSOR_TYPE_VOLTAGE;
+  _default_sensor_types[1] =
+      wippersnapper_sensor_SensorType_SENSOR_TYPE_CURRENT;
+}