0.3.0 INA228

Author: RobTillaart

libraries/INA228/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.3.0] - 2025-03-08
+- redo #20, INA.getEnergy => keep it UNsigned. Broken in 0.2.0
+
+----
+
 ## [0.2.0] - 2025-03-05
 - fix #20, INA.getCharge => make it signed.
 - add **getLastError()** low level (I2C) error handling

libraries/INA228/INA228.cpp

@@ -1,6 +1,6 @@
 //    FILE: INA228.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.3.0
 //    DATE: 2024-05-09
 // PURPOSE: Arduino library for the INA228, I2C, 20 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA228
@@ -162,7 +162,7 @@ double INA228::getEnergy()
   //  read 40 bit UNSIGNED as a double to prevent 64 bit integers
   //  double might be 8 or 4 byte, depends on platform
   //  40 bit ==> O(10^12)
-  double value = _readRegisterF(INA228_ENERGY);
+  double value = _readRegisterF(INA228_ENERGY, 'U');
   //  PAGE 31 (8.1.2)
   return value * (16 * 3.2) * _current_LSB;
 }
@@ -174,7 +174,7 @@ double INA228::getCharge()
   //  read 40 bit SIGNED as a float to prevent 64 bit integers
   //  double might be 8 or 4 byte, depends on platform
   //  40 bit ==> O(10^12)
-  double value = _readRegisterF(INA228_CHARGE);
+  double value = _readRegisterF(INA228_CHARGE, 'S');
   //  PAGE 32 (8.1.2)
   return value * _current_LSB;
 }
@@ -598,7 +598,7 @@ uint32_t INA228::_readRegister(uint8_t reg, uint8_t bytes)
 
 
 //  always 5 bytes
-double INA228::_readRegisterF(uint8_t reg)
+double INA228::_readRegisterF(uint8_t reg, char mode)
 {
   _error = 0;
   _wire->beginTransmission(_address);
@@ -611,28 +611,23 @@ double INA228::_readRegisterF(uint8_t reg)
   }
 
   double value = 0;
-
-  int32_t ival = 0;
   if (5 == _wire->requestFrom(_address, (uint8_t)5))
   {
+    uint32_t val = 0;
     //  fetch 4 MSB bytes first.
     for (int i = 0; i < 4; i++)
     {
-      ival <<= 8;
-      ival |= _wire->read();
+      val <<= 8;
+      val |= _wire->read();
     }
-    value = ival;
+    //  handle signed / unsigned by casting.
+    if (mode == 'U') value = val;
+    else             value = (int32_t) val;
+    //  process last byte
     value *= 256;
     //  note: mar05c
     uint8_t n = _wire->read();
     value += n;
-
-    //  ORG
-    // for (int i = 0; i < bytes; i++)
-    // {
-      // value *= 256.0;
-      // value += _wire->read();
-    // }
   }
   else
   {

libraries/INA228/INA228.h

@@ -1,7 +1,7 @@
 #pragma once
 //    FILE: INA228.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.3.0
 //    DATE: 2024-05-09
 // PURPOSE: Arduino library for the INA228, I2C, 20 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA228
@@ -16,7 +16,7 @@
 #include "Wire.h"
 
 
-#define INA228_LIB_VERSION          (F("0.2.0"))
+#define INA228_LIB_VERSION          (F("0.3.0"))
 
 
 //  for setMode() and getMode()
@@ -250,8 +250,8 @@ class INA228
 private:
   //  max 4 bytes
   uint32_t _readRegister(uint8_t reg, uint8_t bytes);
-  //  always 5 bytes
-  double   _readRegisterF(uint8_t reg);
+  //  always 5 bytes, mode == U ==> unsigned, otherwise signed
+  double   _readRegisterF(uint8_t reg, char mode);
   uint16_t _writeRegister(uint8_t reg, uint16_t value);
 
   float    _current_LSB;

libraries/INA228/README.md

@@ -35,7 +35,7 @@ Finally the INA228 has an **energy** and **charge** register.
 These are values accumulated over time, and only work in continuous mode.
 (to be investigated what those mean ).
 
-The INA228 also provides an ALERT line, to generate an interrupt
+The INA228 also provides an **ALERT** line, to generate an interrupt
 in case a predefined threshold has been met.
 This can be an under- or over-voltage, temperature or power limit.
 The library does not handle these interrupts.
@@ -46,11 +46,13 @@ The library is limited tested and verified with hardware.
 
 Feedback as always is welcome.
 
-### Breaking change 0.2.0
+
+### Breaking change 0.3.0
 
 The function **getCharge()** is updated as the value can be negative too.
 The previous versions assumed it could only be positive. See #22.
-These are obsolete now.
+0.3.0 fixed the **getEnergy()** which only can have positive values
+and was broken in 0.2.0. Versions before 0.3.0 are obsolete now.
 
 
 ### Details

libraries/INA228/keywords.txt

@@ -109,6 +109,7 @@ getManufacturer	KEYWORD2
 getDieID	KEYWORD2
 getRevision	KEYWORD2
 
+getLastError	KEYWORD2
 
 # Constants (LITERAL1)
 INA228_LIB_VERSION	LITERAL1

libraries/INA228/library.json

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

libraries/INA228/library.properties

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