0.1.2 INA236

Author: RobTillaart

libraries/INA236/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.1.2] - 2025-05-06
+- add **getLastError()** low level (I2C) error handling
+- update readme.md
+
 ## [0.1.1] - 2025-01-30
 - fix #2, cache ADCRange to improve getShuntVoltage()
 - add **INA_comparison_table.md**

libraries/INA236/INA236.cpp

@@ -1,7 +1,7 @@
 //    FILE: INA236.cpp
 //  AUTHOR: Rob Tillaart
 //          ported from INA226 to INA236 by Josef Tremmel
-// VERSION: 0.1.1
+// VERSION: 0.1.2
 //    DATE: 2024-05-27
 // PURPOSE: Arduino library for the INA236, I2C, 16 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA236
@@ -46,6 +46,7 @@ INA236::INA236(const uint8_t address, TwoWire *wire)
   _current_LSB = 0;
   _maxCurrent  = 0;
   _shunt       = 0;
+  _error       = 0;
 }
 
 
@@ -486,6 +487,18 @@ uint16_t INA236::getDieID()
 }
 
 
+////////////////////////////////////////////////////////
+//
+//  ERROR HANDLING
+//
+int INA236::getLastError()
+{
+  int e = _error;
+  _error = 0;
+  return e;
+}
+
+
 ////////////////////////////////////////////////////////
 //
 //  PRIVATE
@@ -494,12 +507,25 @@ uint16_t INA236::_readRegister(uint8_t reg)
 {
   _wire->beginTransmission(_address);
   _wire->write(reg);
-  _wire->endTransmission();
+  int n = _wire->endTransmission();
+  if (n != 0)
+  {
+    _error = -1;
+    return 0;
+  }
 
-  _wire->requestFrom(_address, (uint8_t)2);
-  uint16_t value = _wire->read();
-  value <<= 8;
-  value |= _wire->read();
+  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;
 }
 
@@ -510,7 +536,12 @@ uint16_t INA236::_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/INA236/INA236.h

@@ -2,7 +2,7 @@
 //    FILE: INA236.h
 //  AUTHOR: Rob Tillaart
 //          ported from INA226 to INA236 by Josef Tremmel
-// VERSION: 0.1.1
+// VERSION: 0.1.2
 //    DATE: 2024-05-27
 // PURPOSE: Arduino library for the INA236, I2C, 16 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA236
@@ -14,7 +14,7 @@
 #include "Wire.h"
 
 
-#define INA236_LIB_VERSION              "0.1.1"
+#define INA236_LIB_VERSION                (F("0.1.2"))
 
 
 //  set by setAlertRegister
@@ -168,6 +168,10 @@ class INA236
   //  DEBUG
   uint16_t getRegister(uint8_t reg)  { return _readRegister(reg); };
 
+  //
+  //  ERROR HANDLING
+  //
+  int      getLastError();
 
 private:
 
@@ -180,6 +184,8 @@ class INA236
 
   uint8_t   _address;
   TwoWire * _wire;
+
+  int       _error;
 };
 
 

libraries/INA236/INA_comparison_table.md

@@ -4,19 +4,21 @@
 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   |   -   |   -   |   -   |
+|                   |  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/INA236/README.md

@@ -37,13 +37,13 @@ A few important maxima, see datasheet, chapter 6.
 | current       |  20   | Ampere |  ?? TODO check
 
 
-#### Special characters
+### Special characters
 
 - Ω == Ohm = ALT-234 (Windows)
 - µ == micro = ALT-0181 (Windows)
 
 
-#### Related
+### Related
 
 - https://www.ti.com/product/INA236#tech-docs
 - https://www.ti.com/product/INA236#params
@@ -61,7 +61,7 @@ A few important maxima, see datasheet, chapter 6.
 
 ## I2C
 
-#### Address
+### Address
 
 The INA236 comes in two flavours, the INA236A and INA236B
 with two disjunct address ranges.
@@ -78,7 +78,7 @@ See table - from datasheet table 7.1, page 16.
 |  SCL  |     67    |  0x43  |     75    |  0x4B  |
 
 
-#### Performance
+### Performance
 
 To be elaborated, example sketch available.
 
@@ -126,7 +126,7 @@ Also see INA226 issue 30 for another typical deviation problem.
 ```
 
 
-#### Constructor
+### Constructor
 
 - **INA236(const uint8_t address, TwoWire \*wire = Wire)** Constructor to set 
 the address and optional Wire interface.
@@ -137,7 +137,7 @@ Note: one needs to set **Wire.begin()** before calling **begin()**.
 - **uint8_t getAddress()** returns the address set in the constructor.
 
 
-#### Core Functions
+### Core Functions
 
 Note the power and the current are not meaningful without calibrating the sensor.
 Also the value is not meaningful if there is no shunt connected.
@@ -168,7 +168,7 @@ Helper functions for the micro scale.
 - **float getPower_uW()** idem, in microWatt.
 
 
-#### Configuration
+### Configuration
 
 **Note:**
 The internal conversions runs in the background in the device.
@@ -237,7 +237,7 @@ Note: times are typical, check datasheet for operational range.
 Note: total conversion time can take up to 1024 \* 8.3 ms ~ 10 seconds.
 
 
-#### ADCRange
+### ADCRange
 
 The INA236 can set the ADC range to 20 mV (adcRange == true) 
 or to 80 mV (adcRange == false) to optimize the accuracy.
@@ -249,7 +249,7 @@ The function sets the voltage/LSB and returns false adcRange is out of range.
 Note: this function is not available on INA226.
 
 
-#### Calibration
+### Calibration
 
 See datasheet.
 
@@ -271,7 +271,7 @@ Value should not be zero.
 To print these values in scientific notation use https://github.com/RobTillaart/printHelpers 
 
 
-#### About normalization
+### About normalization
 
 **setMaxCurrentShunt()** will round the current_LSB to nearest round value (typical 0.001) by default (normalize == true). 
 - The user **must** check the return value == 0x000, otherwise the calibration register is **not** set.
@@ -285,7 +285,7 @@ normalize flag was set to true.
 See https://github.com/RobTillaart/INA236/pull/29 for details of the discussion.
 
 
-#### Error codes setMaxCurrentShunt
+### Error codes setMaxCurrentShunt
 
 |  descriptive name error        |  value   |  meaning  |
 |:-------------------------------|:--------:|:----------|
@@ -296,7 +296,7 @@ See https://github.com/RobTillaart/INA236/pull/29 for details of the discussion.
 |  INA236_ERR_NORMALIZE_FAILED   |  0x8003  |  not possible to normalize.
 
 
-#### Operating mode
+### Operating mode
 
 See datasheet, partially tested.
 
@@ -317,7 +317,7 @@ Descriptive mode functions (convenience wrappers).
 - **bool setModeShuntBusContinuous()** mode 7 - default.
 
 
-#### Alert functions
+### Alert functions
 
 See datasheet, not tested yet.
 
@@ -353,17 +353,22 @@ Returns true if write to register successful.
 The alert line falls when alert is reached.
 
 
-#### Meta information
+### Meta information
 
 - **uint16_t getManufacturerID()** should return 0x5449.
 - **uint16_t getDieID()** should return 0xA080.
 
 
-#### Debugging
+### Debugging
 
 - **uint16_t getRegister(uint8_t reg)** fetch registers directly, for debugging only.
 
 
+### Error Handling
+
+- **int getLastError()** returns last (I2C) error.
+
+
 ## Adjusting the range of the INA236
 
 **use at own risk**

libraries/INA236/keywords.txt

@@ -66,6 +66,7 @@ getAlertLimit	KEYWORD2
 getManufacturerID	KEYWORD2
 getDieID	KEYWORD2
 
+getLastError	KEYWORD2
 
 # Constants (LITERAL1)
 INA236_LIB_VERSION	LITERAL1

libraries/INA236/library.json

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

libraries/INA236/library.properties

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