0.1.1 INA238

Author: RobTillaart

libraries/INA238/CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.1.1] - 2025-12-27
+- Fix #2, getBusVoltage
+- add performance figures
+- minor edits
+
 ## [0.1.0] - 2025-12-27
 - initial version (publish)
 

libraries/INA238/INA238.cpp

@@ -1,6 +1,6 @@
 //    FILE: INA238.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.0
+// VERSION: 0.1.1
 //    DATE: 2025-06-11
 // PURPOSE: Arduino library for the INA238, I2C, 16 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA238
@@ -95,7 +95,7 @@ float INA238::getBusVoltage()
 {
   //  always positive, remove reserved bits.
   int16_t value = _readRegister(INA238_BUS_VOLTAGE, 2);
-  float bus_LSB = 3.125;  //  3.125 mV
+  float bus_LSB = 3.125e-3;  //  3.125 mV
   float voltage = value * bus_LSB;
   return voltage;
 }
@@ -282,8 +282,8 @@ uint8_t INA238::getAverage()
 int INA238::setMaxCurrentShunt(float maxCurrent, float shunt)
 {
   //  Shunt can be really small
-  if (shunt < 0.0001)   return -2;  //  TODO error code
-  if (maxCurrent < 0.0) return -3;  //  TODO error code
+  if (shunt < 0.0001)   return -2;
+  if (maxCurrent < 0.0) return -3;
   _maxCurrent = maxCurrent;
   _shunt = shunt;
   _current_LSB = _maxCurrent * 3.0517578125e-5;  //  pow(2, -15);
@@ -368,13 +368,13 @@ uint16_t INA238::getDiagnoseAlertBit(uint8_t bit)
 //  THRESHOLD AND LIMIT REGISTERS 12-17
 //  section 7.3.6, 7.6.1.10
 //
-//  TODO  (sync INA228)
+//  (sync INA228 whenever fixed)
 //  - API
-//  - return bool for setters
+//  - return bool for setters?
 //  - float voltage interface instead of uint16_t?  breaking!
 void INA238::setShuntOvervoltageTH(uint16_t threshold)
 {
-  //  TODO ADCRANGE DEPENDENT
+  //  ADCRANGE DEPENDENT
   //  Conversion Factor: 5 μV/LSB when ADCRANGE = 0
   //  1.25 μV/LSB when ADCRANGE = 1.
   //  float LSB = 5.0e-6;
@@ -384,23 +384,23 @@ void INA238::setShuntOvervoltageTH(uint16_t threshold)
 
 uint16_t INA238::getShuntOvervoltageTH()
 {
-  //  TODO ADCRANGE DEPENDENT
+  //  ADCRANGE DEPENDENT
   //  float LSB = 5.0e-6;
   //  if (_ADCRange == 1) LSB = 1.25e-6;
   return _readRegister(INA238_SOVL, 2);
 }
 
 void INA238::setShuntUndervoltageTH(uint16_t threshold)
 {
-  //  TODO ADCRANGE DEPENDENT
+  //  ADCRANGE DEPENDENT
   //  float LSB = 5.0e-6;
   //  if (_ADCRange == 1) LSB = 1.25e-6;
   _writeRegister(INA238_SUVL, threshold);
 }
 
 uint16_t INA238::getShuntUndervoltageTH()
 {
-  //  TODO ADCRANGE DEPENDENT
+  //  ADCRANGE DEPENDENT
   //  float LSB = 5.0e-6;
   //  if (_ADCRange == 1) LSB = 1.25e-6;
   return _readRegister(INA238_SUVL, 2);

libraries/INA238/INA238.h

@@ -1,7 +1,7 @@
 #pragma once
 //    FILE: INA238.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.0
+// VERSION: 0.1.1
 //    DATE: 2025-06-11
 // PURPOSE: Arduino library for the INA238, I2C, 16 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA238
@@ -14,7 +14,7 @@
 #include "Wire.h"
 
 
-#define INA238_LIB_VERSION          (F("0.1.0"))
+#define INA238_LIB_VERSION          (F("0.1.1"))
 
 
 //  for setMode() and getMode()
@@ -66,7 +66,6 @@ enum INA238_timing_enum {
 
 
 //  for diagnose/alert() bit fields.
-//  TODO bit masks?
 enum INA238_diag_enum {
   INA238_DIAG_MEMORY_STATUS      = 0,
   INA238_DIAG_CONVERT_COMPLETE   = 1,
@@ -190,8 +189,6 @@ class INA238
   //  read datasheet for details, section 7.3.6, page 16++
   //                              section 7.6.1.10, page 26++
   //
-  //  TODO - design and implement better API?
-  //
   void     setShuntOvervoltageTH(uint16_t threshold);
   uint16_t getShuntOvervoltageTH();
   void     setShuntUndervoltageTH(uint16_t threshold);

libraries/INA238/README.md

@@ -113,7 +113,7 @@ TODO Test
 
 ```
 
-TODO Test
+_Tested - see #2_
 
 
 ### Special characters
@@ -169,26 +169,23 @@ Note this might differ per breakout board.
 
 ### Performance
 
-TODO run tests and fill performance figures.
-
-Run **INA238_performance.ino** sketch to get a first indication.
-Numbers below are based upon tests with TODO.
+Run **INA238_performance.ino** sketch to get a first indication of your
+board used.
+Numbers below are based upon tests with RP2040 (see issue #2).
 
 Time in micros, I2C speed in kHz.
 
 |  I2C  |  function         |  time  |  notes  |
 |:-----:|:------------------|:------:|:-------:|
-|  100  |  getBusVoltage    |    |  100%
-|  100  |  getShuntVoltage  |    |
-|  100  |  getCurrent       |    |
-|  100  |  getPower         |    |
-|  100  |  getTemperature   |    |
-|  100  |  getEnergy        |    |
-|  100  |  getCharge        |    |
-|       |                   |    |  other functions similar gain.
-|  200  |  getBusVoltage    |    |
-|  400  |  getBusVoltage    |    |
-|  800  |  getBusVoltage    |    |
+|  100  |  getBusVoltage    |   620  |  100%
+|  100  |  getShuntVoltage  |   590  |   95%
+|  100  |  getCurrent       |   583  |   94%
+|  100  |  getPower         |   728  |  117%
+|  100  |  getTemperature   |   601  |   97%
+|       |                   |        |  other functions similar gain.
+|  200  |  getBusVoltage    |   350  |   56%
+|  400  |  getBusVoltage    |   237  |   38%
+|  800  |  getBusVoltage    |   167  |   27%
 
 
 Most non core functions are as fast as **getTemperature()**
@@ -279,8 +276,6 @@ Read datasheet for details, section 7.6.1.2, page 21++
 - **void setADCRange(bool flag)** flag = false => ~163.84 mV, true => ~40.96 mV
 - **bool getADCRange()** return set value.
 
-TODO: examples to show the effect of the ADC configuration.
-
 
 ### ADC mode
 
@@ -386,7 +381,7 @@ Read datasheet for details, section 7.3.6, page 16++
 
 Note: the implementation of this part is rather minimalistic and
 might be changed / extended in the future.
-Idem INA228 library.
+Idem see my INA228 library.
 
 #### Shunt
 
@@ -428,17 +423,22 @@ Idem INA228 library.
 - update documentation.
 - test and verify with hardware
 - keep sync INA228 where possible.
+- fix TODO's in code + readme.md
 
 #### Should
 
-- TODO's in code and docs.
-- add error handling.
 - how to detect nothing connected?
   - vshunt >  maxVShunt (new variable)
   - current > maxCurrent
+- examples
+  - example to show the effect of the ADC configuration.
+- improve error handling (INA228)
+  - constants/enum
 
 #### Could
 
+- improve API thresholds and limits (INA228)
+- improve API use bitmasks for diagnostics (INA228)
 - write examples, (please share yours).
 - improve unit tests
 - clean up magic numbers in the code?

libraries/INA238/examples/INA238_performance/performance_0.1.0.txt

@@ -1,7 +1,41 @@
-BOARD:  Arduino UNO
-IDE:    1.8.19
-
+BOARD:  RP2040
+IDE:    MSDEV
+See issue #2
 
 INA238_performance\INA238_performance.ino
 
-PLACEHOLDER (TODO HW TEST)
+INA238_LIB_VERSION: 0.1.0
+
+========================================================
+Speed: 100000
+getBusVoltage:    620
+getShuntVoltage:  590
+getCurrent:       583
+getPower:         728
+getTemperature:   601
+
+========================================================
+Speed: 200000
+getBusVoltage:    350
+getShuntVoltage:  334
+getCurrent:       344
+getPower:         396
+getTemperature:   336
+
+========================================================
+Speed: 400000
+getBusVoltage:    237
+getShuntVoltage:  202
+getCurrent:       208
+getPower:         252
+getTemperature:   213
+
+========================================================
+Speed: 800000
+getBusVoltage:    167
+getShuntVoltage:  152
+getCurrent:       164
+getPower:         187
+getTemperature:   161
+
+Done

libraries/INA238/library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/INA238.git"
   },
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

libraries/INA238/library.properties

@@ -1,5 +1,5 @@
 name=INA238
-version=0.1.0
+version=0.1.1
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino library for the INA238, I2C, 16 bit, voltage, current and power sensor.