0.4.1 INA3221_RT

Author: RobTillaart

libraries/INA3221_RT/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.4.1] - 2025-03-06
+- add **getLastError()** low level (I2C) error handling
+- update readme.md
+
 ## [0.4.0] - 2024-10-27
 - fix #8, config functions, kudos to joachymus
 - update readme.md

libraries/INA3221_RT/INA3221.cpp

@@ -1,6 +1,6 @@
 //    FILE: INA3221.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.4.0
+// VERSION: 0.4.1
 //    DATE: 2024-02-05
 // PURPOSE: Arduino library for the I2C INA3221 3 channel voltage and current sensor.
 //     URL: https://github.com/RobTillaart/INA3221_RT
@@ -49,6 +49,7 @@ INA3221::INA3221(const uint8_t address, TwoWire *wire)
   _shunt[0]    = 0.1;  //  Ohm
   _shunt[1]    = 0.1;  //  Ohm
   _shunt[2]    = 0.1;  //  Ohm
+  _error       = 0;
 }
 
 bool INA3221::begin()
@@ -67,7 +68,7 @@ bool INA3221::isConnected()
 uint8_t INA3221::getAddress()
 {
   return _address;
-};
+}
 
 
 ////////////////////////////////////////////////////////
@@ -384,6 +385,18 @@ uint16_t INA3221::getDieID()
 }
 
 
+////////////////////////////////////////////////////////
+//
+//  ERROR HANDLING
+//
+int INA3221::getLastError()
+{
+  int e = _error;
+  _error = 0;
+  return e;
+}
+
+
 ////////////////////////////////////////////////////////
 //
 //  PRIVATE
@@ -392,12 +405,25 @@ uint16_t INA3221::_readRegister(uint8_t reg)
 {
   _wire->beginTransmission(_address);
   _wire->write(reg);
-  _wire->endTransmission();
-
-  _wire->requestFrom(_address, (uint8_t)2);
-  uint16_t value = _wire->read();
-  value <<= 8;
-  value |= _wire->read();
+  int n = _wire->endTransmission();
+  if (n != 0)
+  {
+    _error = -1;
+    return 0;
+  }
+
+  uint16_t value = 0;
+  if (2 == _wire->requestFrom(_address, (uint8_t)2))
+  {
+    value = _wire->read();
+    value <<= 8;
+    value |= _wire->read();
+  }
+  else
+  {
+    _error = -2;
+    return 0;
+  }
   return value;
 }
 
@@ -408,7 +434,12 @@ uint16_t INA3221::_writeRegister(uint8_t reg, uint16_t value)
   _wire->write(reg);
   _wire->write(value >> 8);
   _wire->write(value & 0xFF);
-  return _wire->endTransmission();
+  int n = _wire->endTransmission();
+  if (n != 0)
+  {
+    _error = -1;
+  }
+  return n;
 }
 
 

libraries/INA3221_RT/INA3221.h

@@ -1,7 +1,7 @@
 #pragma once
 //    FILE: INA3221.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.4.0
+// VERSION: 0.4.1
 //    DATE: 2024-02-05
 // PURPOSE: Arduino library for the I2C INA3221 3 channel voltage and current sensor.
 //     URL: https://github.com/RobTillaart/INA3221_RT
@@ -13,7 +13,7 @@
 #include "Wire.h"
 
 
-#define INA3221_LIB_VERSION                (F("0.4.0"))
+#define INA3221_LIB_VERSION                (F("0.4.1"))
 
 
 class INA3221
@@ -127,6 +127,12 @@ class INA3221
   };
 
 
+  //
+  //  ERROR HANDLING
+  //
+  int      getLastError();
+
+
 private:
 
   uint16_t _readRegister(uint8_t reg);
@@ -135,6 +141,8 @@ class INA3221
 
   uint8_t   _address;
   TwoWire * _wire;
+
+  int       _error;
 };
 
 

libraries/INA3221_RT/INA_comparison_table.md

@@ -0,0 +1,24 @@
+
+## Comparison table INA sensors
+
+Comparison of my INA2xx libraries
+
+
+|                   |  219  |  226  |  228  |  229  |  236  |  239  |  260  | 3221  |
+|:------------------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|
+|  bits             |  12   |  16   |  20   |  20   |  16   |  16   |  16   |  13   |
+|  Max Voltage      |  26   |  36   |  85   |  85   |  48   |  85   |  36   |  26   |
+|  Communication    |  I2C  |  I2C  |  I2C  |  SPI  |  I2C  |  SPI  |  I2C  |  I2C  |
+|  Channels         |   1   |   1   |   1   |   1   |   1   |   1   |   1   |   3   |
+|                   |       |       |       |       |       |       |       |       |
+|  getBusVoltage    |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |
+|  getShuntVoltage  |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |
+|  getCurrent       |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |   Y   |
+|  getPower         |   Y   |   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/INA3221_RT/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/INA3221_RT/README.md

@@ -80,10 +80,19 @@ As always feedback is welcome, please open an issue on GitHub.
 
 ### Related
 
-- https://github.com/RobTillaart/INA219
-- https://github.com/RobTillaart/INA226
-- https://github.com/RobTillaart/INA228
-- https://github.com/RobTillaart/INA3221_RT
+- https://www.ti.com/product/INA3221#tech-docs
+- https://www.ti.com/product/INA3221#params
+- https://www.ti.com/document-viewer/INA3221/datasheet
+- 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/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)
+
 
 
 ## I2C
@@ -413,6 +422,11 @@ If your device returns other ManufacturerID or DieID, please let me know.
 - **uint16_t putRegister(uint8_t reg, uint16_t value)** load registers directly, for debugging only.
 
 
+### Error Handling
+
+- **int getLastError()** returns last (I2C) error.
+
+
 ## Future
 
 

libraries/INA3221_RT/examples/INA3221_array/INA3221_array.ino

@@ -20,6 +20,7 @@ INA3221 INA[INADEVICES]
 
 void setup()
 {
+  while(!Serial);
   Serial.begin(115200);
   Serial.println(__FILE__);
   Serial.print("INA3221_LIB_VERSION: ");

libraries/INA3221_RT/examples/INA3221_demo/INA3221_demo.ino

@@ -13,6 +13,7 @@ INA3221 INA(0x40);
 
 void setup()
 {
+  while(!Serial);
   Serial.begin(115200);
   Serial.println(__FILE__);
   Serial.print("INA3221_LIB_VERSION: ");

libraries/INA3221_RT/examples/INA3221_performance/INA3221_performance.ino

@@ -13,6 +13,7 @@ uint32_t start, stop;
 
 void setup()
 {
+  while(!Serial);
   Serial.begin(115200);
   Serial.println(__FILE__);
   Serial.print("INA3221_LIB_VERSION: ");

libraries/INA3221_RT/examples/INA3221_test_BCVT/INA3221_test_BCVT.ino

@@ -14,6 +14,7 @@ uint32_t start, stop;
 
 void setup()
 {
+  while(!Serial);
   Serial.begin(115200);
   Serial.println(__FILE__);
   Serial.print("INA3221_LIB_VERSION: ");