0.1.5 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.1.5] - 2025-01-30
+- fix #17, cache ADCRange to improve getShuntVoltage()
+- add **INA_comparison_table.md**
+- minor edits
+
 ## [0.1.4] - 2024-10-28
 - add and rename wrappers for core functions
 - update all examples

libraries/INA228/INA228.cpp

@@ -1,8 +1,8 @@
 //    FILE: INA228.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.4
+// VERSION: 0.1.5
 //    DATE: 2024-05-09
-// PURPOSE: Arduino library for INA228 voltage, current and power sensor.
+// PURPOSE: Arduino library for the INA228, I2C, 20 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA228
 //          https://www.adafruit.com/product/5832           ( 10 A version)
 //          https://www.mateksys.com/?portfolio=i2c-ina-bm  (200 A version))
@@ -42,7 +42,7 @@
 #define INA228_CFG_CONVDLY          0x3FC0
 #define INA228_CFG_TEMPCOMP         0x0020
 #define INA228_CFG_ADCRANGE         0x0010
-#define INA228_CFG_RESERVED         0x000F
+#define INA228_CFG_RESERVED         0x000F  //  all unused bits
 
 
 //  ADC MASKS (register 1)
@@ -71,6 +71,8 @@ INA228::INA228(const uint8_t address, TwoWire *wire)
 bool INA228::begin()
 {
   if (! isConnected()) return false;
+
+  getADCRange();
   return true;
 }
 
@@ -107,7 +109,7 @@ float INA228::getShuntVoltage()
 {
   //  shunt_LSB depends on ADCRANGE in INA228_CONFIG register.
   float shunt_LSB = 312.5e-9;  //  312.5 nV
-  if (getADCRange() == 1)
+  if (_ADCRange == true)
   {
     shunt_LSB = 78.125e-9;     //  78.125 nV
   }
@@ -140,7 +142,7 @@ float INA228::getCurrent()
 //  PAGE 26 + 8.1.2
 float INA228::getPower()
 {
-  uint32_t value = _readRegister(INA228_POWER, 3) ;
+  uint32_t value = _readRegister(INA228_POWER, 3);
   //  PAGE 31 (8.1.2)
   return value * 3.2 * _current_LSB;
 }
@@ -192,8 +194,8 @@ bool INA228::setAccumulation(uint8_t value)
 {
   if (value > 1) return false;
   uint16_t reg = _readRegister(INA228_CONFIG, 2);
-  reg &= ~INA228_CFG_RSTACC;
   if (value == 1) reg |= INA228_CFG_RSTACC;
+  else            reg &= ~INA228_CFG_RSTACC;
   _writeRegister(INA228_CONFIG, reg);
   return true;
 }
@@ -221,8 +223,8 @@ uint8_t INA228::getConversionDelay()
 void INA228::setTemperatureCompensation(bool on)
 {
   uint16_t value = _readRegister(INA228_CONFIG, 2);
-  value &= ~INA228_CFG_TEMPCOMP;
   if (on) value |= INA228_CFG_TEMPCOMP;
+  else    value &= ~INA228_CFG_TEMPCOMP;
   _writeRegister(INA228_CONFIG, value);
 }
 
@@ -234,16 +236,20 @@ bool INA228::getTemperatureCompensation()
 
 void INA228::setADCRange(bool flag)
 {
+  //  if (flag == _ADCRange) return;
+  _ADCRange = flag;
   uint16_t value = _readRegister(INA228_CONFIG, 2);
-  value &= ~INA228_CFG_ADCRANGE;
   if (flag) value |= INA228_CFG_ADCRANGE;
+  else      value &= ~INA228_CFG_ADCRANGE;
+  //  if value has not changed we do not need to write it back.
   _writeRegister(INA228_CONFIG, value);
 }
 
 bool INA228::getADCRange()
 {
   uint16_t value = _readRegister(INA228_CONFIG, 2);
-  return (value & INA228_CFG_ADCRANGE) > 0;
+  _ADCRange = (value & INA228_CFG_ADCRANGE) > 0;
+  return _ADCRange;
 }
 
 
@@ -347,7 +353,7 @@ int INA228::setMaxCurrentShunt(float maxCurrent, float shunt)
   //  PAGE 31 (8.1.2)
   float shunt_cal = 13107.2e6 * _current_LSB * _shunt;
   //  depends on ADCRANGE in INA228_CONFIG register.
-  if (getADCRange() == 1)
+  if (_ADCRange == true)
   {
     shunt_cal *= 4;
   }
@@ -373,6 +379,7 @@ float INA228::getCurrentLSB()
   return _current_LSB;
 }
 
+
 ////////////////////////////////////////////////////////
 //
 //  SHUNT TEMPERATURE COEFFICIENT REGISTER 3
@@ -391,7 +398,6 @@ uint16_t INA228::getShuntTemperatureCoefficent()
 }
 
 
-
 ////////////////////////////////////////////////////////
 //
 //  DIAGNOSE ALERT REGISTER 11
@@ -411,7 +417,7 @@ void INA228::setDiagnoseAlertBit(uint8_t bit)
 {
   uint16_t value = _readRegister(INA228_DIAG_ALERT, 2);
   uint16_t mask = (1 << bit);
-  //  only write new value if needed.
+  //  only write new value if bit not set
   if ((value & mask) == 0)
   {
     value |= mask;
@@ -423,7 +429,7 @@ void INA228::clearDiagnoseAlertBit(uint8_t bit)
 {
   uint16_t value = _readRegister(INA228_DIAG_ALERT, 2);
   uint16_t mask = (1 << bit);
-  //  only write new value if needed.
+  //  only write new value if bit not set.
   if ((value & mask ) != 0)
   {
     value &= ~mask;
@@ -471,26 +477,26 @@ uint16_t INA228::getShuntUndervoltageTH()
 void INA228::setBusOvervoltageTH(uint16_t threshold)
 {
   if (threshold > 0x7FFF) return;
-  //float LSB = 3.125e-3;
+  //float LSB = 3.125e-3;  //  3.125 mV/LSB.
   _writeRegister(INA228_BOVL, threshold);
 }
 
 uint16_t INA228::getBusOvervoltageTH()
 {
-  //float LSB = 3.125e-3;
+  //float LSB = 3.125e-3;  //  3.125 mV/LSB.
   return _readRegister(INA228_BOVL, 2);
 }
 
 void INA228::setBusUndervoltageTH(uint16_t threshold)
 {
   if (threshold > 0x7FFF) return;
-  //float LSB = 3.125e-3;
+  //float LSB = 3.125e-3;  //  3.125 mV/LSB.
   _writeRegister(INA228_BUVL, threshold);
 }
 
 uint16_t INA228::getBusUndervoltageTH()
 {
-  //float LSB = 3.125e-3;
+  //float LSB = 3.125e-3;  //  3.125 mV/LSB.
   return _readRegister(INA228_BUVL, 2);
 }
 

libraries/INA228/INA228.h

@@ -1,9 +1,9 @@
 #pragma once
 //    FILE: INA228.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.4
+// VERSION: 0.1.5
 //    DATE: 2024-05-09
-// PURPOSE: Arduino library for INA228 voltage, current and power sensor.
+// PURPOSE: Arduino library for the INA228, I2C, 20 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA228
 //          https://www.adafruit.com/product/5832           ( 10 A version)
 //          https://www.mateksys.com/?portfolio=i2c-ina-bm  (200 A version))
@@ -16,7 +16,7 @@
 #include "Wire.h"
 
 
-#define INA228_LIB_VERSION          (F("0.1.4"))
+#define INA228_LIB_VERSION          (F("0.1.5"))
 
 
 //  for setMode() and getMode()
@@ -253,6 +253,7 @@ class INA228
   float    _current_LSB;
   float    _shunt;
   float    _maxCurrent;
+  bool     _ADCRange;
 
   uint8_t   _address;
   TwoWire * _wire;

libraries/INA228/INA_comparison_table.md

@@ -0,0 +1,24 @@
+
+## Comparison table INA sensors
+
+Comparison of my INA2xx libraries
+
+
+|                   |  219  |  226  |  228  |  229  |  236  |  239  | 3221  |
+|:------------------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|
+|  bits             |  12   |  16   |  20   |  20   |  16   |  16   |  13   |
+|  Max Voltage      |  26   |  36   |  85   |  85   |  48   |  85   |  26   |
+|  Communication    |  I2C  |  I2C  |  I2C  |  SPI  |  I2C  |  SPI  |  I2C  |
+|  Channels         |   1   |   1   |   1   |   1   |   1   |   1   |   3   |
+|                   |       |       |       |       |       |       |       |
+|  getBusVoltage    |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |
+|  getShuntVoltage  |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |
+|  getCurrent       |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |
+|  getPower         |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |
+|  getTemperature   |   -   |   -   |   Y   |   Y   |   -   |   Y   |   -   |
+|  getEnergy        |   -   |   -   |   Y   |   Y   |   -   |   -   |   -   |
+|  getCharge        |   -   |   -   |   Y   |   Y   |   -   |   -   |   -   |
+
+
+https://www.ti.com/amplifier-circuit/current-sense/digital-power-monitors/products.html
+

libraries/INA228/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024-2024 Rob Tillaart
+Copyright (c) 2024-2025 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

libraries/INA228/README.md

@@ -26,7 +26,7 @@ Most important difference is that the INA228 has a 20 bit ADC.
 This should result in higher precision however this is expected to only
 be visible with stable loads and low noise.
 
-Another important difference is that the INA228 works up to 85 Volts,
+An important difference is that the INA228 works up to 85 Volts,
 which is more than twice the 36 volt of the INA226.
 The INA228 has a build in temperature sensor (±1°C) to be used for
 monitoring and temperature compensation.
@@ -35,9 +35,10 @@ 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.
 
 The library is limited tested and verified with hardware.
 
@@ -141,10 +142,13 @@ _Tested_
 - https://www.ti.com/product/INA228#tech-docs
 - https://www.ti.com/product/INA228#params
 - https://www.ti.com/document-viewer/INA228/datasheet
-- https://github.com/RobTillaart/INA219
-- https://github.com/RobTillaart/INA226
-- https://github.com/RobTillaart/INA228
-- https://github.com/RobTillaart/INA3221_RT
+- https://github.com/RobTillaart/INA219  26 Volt, I2C, 12 bit
+- https://github.com/RobTillaart/INA226  36 Volt, I2C, 16 bit
+- https://github.com/RobTillaart/INA228  85 Volt, I2C, 20 bit
+- https://github.com/RobTillaart/INA236  48 Volt, I2C, 16 bit
+- https://github.com/RobTillaart/INA229  85 Volt, SPI, 20 bit
+- https://github.com/RobTillaart/INA239  85 Volt, SPI, 16 bit
+- https://github.com/RobTillaart/INA3221_RT  26 Volt, I2C, 13 bits (3 channel)
 - https://www.adafruit.com/product/5832
 - https://www.mateksys.com/?portfolio=i2c-ina-bm
 - https://github.com/RobTillaart/printHelpers  (for scientific notation)

libraries/INA228/examples/INA228_performance/performance_0.1.4.txt

@@ -0,0 +1,58 @@
+BOARD:  Arduino UNO
+IDE:    1.8.19
+
+
+INA228_performance\INA228_performance.ino
+
+INA228_LIB_VERSION: 0.1.4
+
+========================================================
+Speed: 100000
+
+test_core
+getBusVoltage:	688
+getShuntVoltage:	1244
+getCurrent:	684
+getPower:	680
+getTemperature:	588
+getEnergy:	936
+getCharge:	956
+
+========================================================
+Speed: 200000
+
+test_core
+getBusVoltage:	396
+getShuntVoltage:	720
+getCurrent:	400
+getPower:	392
+getTemperature:	344
+getEnergy:	556
+getCharge:	584
+
+========================================================
+Speed: 400000
+
+test_core
+getBusVoltage:	256
+getShuntVoltage:	456
+getCurrent:	252
+getPower:	256
+getTemperature:	216
+getEnergy:	364
+getCharge:	392
+
+========================================================
+Speed: 800000
+
+test_core
+getBusVoltage:	184
+getShuntVoltage:	328
+getCurrent:	184
+getPower:	180
+getTemperature:	160
+getEnergy:	276
+getCharge:	300
+
+Done
+

libraries/INA228/examples/INA228_performance/performance_0.1.5.txt

@@ -0,0 +1,58 @@
+BOARD:  Arduino UNO
+IDE:    1.8.19
+
+
+INA228_performance\INA228_performance.ino
+
+INA228_LIB_VERSION: 0.1.5
+
+========================================================
+Speed: 100000
+
+test_core
+getBusVoltage:	680
+getShuntVoltage:	684
+getCurrent:	688
+getPower:	680
+getTemperature:	580
+getEnergy:	932
+getCharge:	956
+
+========================================================
+Speed: 200000
+
+test_core
+getBusVoltage:	396
+getShuntVoltage:	396
+getCurrent:	396
+getPower:	396
+getTemperature:	348
+getEnergy:	556
+getCharge:	592
+
+========================================================
+Speed: 400000
+
+test_core
+getBusVoltage:	248
+getShuntVoltage:	256
+getCurrent:	256
+getPower:	256
+getTemperature:	220
+getEnergy:	364
+getCharge:	400
+
+========================================================
+Speed: 800000
+
+test_core
+getBusVoltage:	180
+getShuntVoltage:	188
+getCurrent:	188
+getPower:	184
+getTemperature:	160
+getEnergy:	276
+getCharge:	308
+
+Done
+