0.4.0 INA229

Author: RobTillaart

libraries/INA229/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.4.0] - 2025-03-08
+- redo #8, INA.getEnergy => keep it UNsigned. Broken in 0.3.0
+- update keywords.txt
+
+----
+
 ## [0.3.0] - 2025-03-05
 - fix #8,INA.getCharge => make it signed.
 

libraries/INA229/INA229.cpp

@@ -1,6 +1,6 @@
 //    FILE: INA229.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.4.0
 //    DATE: 2025-01-22
 // PURPOSE: Arduino library for the INA229, SPI, 20 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA229
@@ -190,10 +190,10 @@ float INA229::getTemperature()
 //  PAGE 24 + 8.1.2
 double INA229::getEnergy()
 {
-  //  read 40 bit unsigned as a double to prevent 64 bit integers
+  //  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(INA229_ENERGY);
+  double value = _readRegisterF(INA229_ENERGY, 'U');
   //  PAGE 31 (8.1.2)
   return value * (16 * 3.2) * _current_LSB;
 }
@@ -202,10 +202,10 @@ double INA229::getEnergy()
 //  PAGE 24 + 8.1.2
 double INA229::getCharge()
 {
-  //  read 40 bit unsigned as a float to prevent 64 bit integers
+  //  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(INA229_CHARGE);
+  double value = _readRegisterF(INA229_CHARGE, 'S');
   //  PAGE 32 (8.1.2)
   return value * _current_LSB;
 }
@@ -650,25 +650,27 @@ uint32_t INA229::_readRegister(uint8_t reg, uint8_t bytes)  //  bytes = 2 or 3.
 }
 
 
-double INA229::_readRegisterF(uint8_t reg)
+double INA229::_readRegisterF(uint8_t reg, char mode)
 {
   //  Dedicated SPI code
   double value = 0;
-  int32_t ival = 0;
   uint8_t addr = (reg << 2) + 1;  //  1 = Read flag.  P18 datasheet
 
   digitalWrite(_select, LOW);
   if (_hwSPI)
   {
     _mySPI->beginTransaction(_spi_settings);
-    ival = _mySPI->transfer(addr);
+    uint32_t val = _mySPI->transfer(addr);
     //  fetch 4 MSB bytes
     for (int i = 0; i < 4; i++)
     {
-      ival <<= 8;
-      ival |= _mySPI->transfer(0x00);
+      val <<= 8;
+      val |= _mySPI->transfer(0x00);
     }
-    value = ival;
+    //  handle signed / unsigned by casting.
+    if (mode == 'U') value = val;
+    else             value = (int32_t) val;
+    //  process last byte
     value *= 256;
     //  fetch last LSB byte
     uint8_t n = _mySPI->transfer(0x00);
@@ -677,14 +679,17 @@ double INA229::_readRegisterF(uint8_t reg)
   }
   else      //  Software SPI
   {
-    ival = swSPI_transfer(addr);
+    uint32_t val = swSPI_transfer(addr);
     //  fetch 4 MSB bytes
     for (int i = 0; i < 4; i++)
     {
-      ival <<= 8;
-      ival |= swSPI_transfer(0x00);
+      val <<= 8;
+      val |= swSPI_transfer(0x00);
     }
-    value = ival;
+    //  handle signed / unsigned by casting.
+    if (mode == 'U') value = val;
+    else             value = (int32_t) val;
+    //  process last byte
     value *= 256;
     //  fetch last LSB byte
     uint8_t n = swSPI_transfer(0x00);

libraries/INA229/INA229.h

@@ -1,7 +1,7 @@
 #pragma once
 //    FILE: INA229.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.4.0
 //    DATE: 2025-01-22
 // PURPOSE: Arduino library for the INA229, SPI, 20 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA229
@@ -13,7 +13,7 @@
 #include "SPI.h"
 
 
-#define INA229_LIB_VERSION          (F("0.3.0"))
+#define INA229_LIB_VERSION          (F("0.4.0"))
 
 
 #ifndef __SPI_CLASS__
@@ -265,8 +265,8 @@ class INA229
 private:
   //  max 4 bytes
   uint32_t _readRegister(uint8_t reg, uint8_t bytes);
-  //  5 bytes or more
-  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/INA229/README.md

@@ -48,11 +48,12 @@ ends in the code, please report them.
 Feedback as always is welcome.
 
 
-### Breaking change 0.3.0
+### Breaking change 0.4.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.
+The previous versions assumed it could only be positive. See #8.
+0.4.0 fixed the **getEnergy()** which only can have positive values
+and was broken in 0.3.0. Versions before 0.4.0 are obsolete now.
 
 
 ### Update 0.2.0

libraries/INA229/keywords.txt

@@ -13,6 +13,7 @@ getBusVolt	KEYWORD2
 getBusMilliVolt	KEYWORD2
 getBusMicroVolt	KEYWORD2
 
+
 getShuntVoltage	KEYWORD2
 getShuntVolt	KEYWORD2
 getShuntMilliVolt	KEYWORD2
@@ -24,21 +25,40 @@ getAmpere	KEYWORD2
 getMilliAmpere	KEYWORD2
 getMicroAmpere	KEYWORD2
 
+
 getPower	KEYWORD2
 getWatt	KEYWORD2
 getMilliWatt	KEYWORD2
 getMicroWatt	KEYWORD2
 getKiloWatt	KEYWORD2
 
+
 getTemperature	KEYWORD2
 
 
-#########################
+getEnergy	KEYWORD2
+getJoule	KEYWORD2
+getMegaJoule	KEYWORD2
+getKiloJoule	KEYWORD2
+getMilliJoule	KEYWORD2
+getMicroJoule	KEYWORD2
+getWattHour	KEYWORD2
+getKiloWattHour	KEYWORD2
+
+
+getCharge	KEYWORD2
+getCoulomb	KEYWORD2
+getMilliCoulomb	KEYWORD2
+getMicroCoulomb	KEYWORD2
 
 
 reset	KEYWORD2
+setAccumulation	KEYWORD2
+getAccumulation	KEYWORD2
 setConversionDelay	KEYWORD2
 getConversionDelay	KEYWORD2
+setTemperatureCompensation	KEYWORD2
+getTemperatureCompensation	KEYWORD2
 setADCRange	KEYWORD2
 getADCRange	KEYWORD2
 
@@ -88,6 +108,11 @@ getDieID	KEYWORD2
 getRevision	KEYWORD2
 
 
+setSPIspeed	KEYWORD2
+getSPIspeed	KEYWORD2
+usesHWSPI	KEYWORD2
+
+
 # Constants (LITERAL1)
 INA229_LIB_VERSION	LITERAL1
 

libraries/INA229/library.json

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

libraries/INA229/library.properties

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