0.1.4 INA236

Author: RobTillaart

libraries/INA236/.github/workflows/arduino-lint.yml

@@ -6,8 +6,8 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
-      - uses: arduino/arduino-lint-action@v1
+      - uses: actions/checkout@v5
+      - uses: arduino/arduino-lint-action@v2
         with:
           library-manager: update
           compliance: strict

libraries/INA236/.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

libraries/INA236/.github/workflows/jsoncheck.yml

@@ -5,13 +5,15 @@ on:
     paths:
       - '**.json'
   pull_request:
+    paths:
+      - '**.json'
 
 jobs:
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v2
         with:

libraries/INA236/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.1.4] - 2025-08-18
+- update GitHub actions
+- allow overrule INA236_MINIMAL_SHUNT on command line.
+- update reference in readme.md (fix #8)
+- minor edits.
+
 ## [0.1.3] - 2025-07-21
 - Sync INA228, setADCRange() calls setMaxCurrentShunt();
 - update readme.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.3
+// VERSION: 0.1.4
 //    DATE: 2024-05-27
 // PURPOSE: Arduino library for the INA236, I2C, 16 bit, voltage, current and power sensor.
 //     URL: https://github.com/RobTillaart/INA236
@@ -160,7 +160,7 @@ bool INA236::setADCRange(bool flag)
   if (flag) value |= INA236_CONF_ADCRANGE_MASK;
   else      value &= ~INA236_CONF_ADCRANGE_MASK;
   _writeRegister(INA236_CONFIGURATION, value);
-  //  INA228, #26 
+  //  INA228, #26
   bool rv = setMaxCurrentShunt(getMaxCurrent(), getShunt()) == 0;
   return rv;
 }

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.3
+// VERSION: 0.1.4
 //    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                (F("0.1.3"))
+#define INA236_LIB_VERSION                (F("0.1.4"))
 
 
 //  set by setAlertRegister
@@ -41,8 +41,10 @@
 #define INA236_ERR_SHUNT_LOW              0x8002
 #define INA236_ERR_NORMALIZE_FAILED       0x8003
 
-//  See INA226 issue #26
+//  See INA226 issue #26 + INA236 issue #8
+#ifndef INA236_MINIMAL_SHUNT
 #define INA236_MINIMAL_SHUNT              0.001
+#endif
 
 #define INA236_MAX_WAIT_MS                600   //  millis
 

libraries/INA236/README.md

@@ -16,11 +16,13 @@ Arduino library for the INA236, I2C, 16 bit, voltage, current and power sensor.
 
 ## Description
 
+**Experimental**
+
 _This documentation is based upon the INA226 library, 
 and may contain information not updated yet.
 Please open an issue if needed._
 
-**Experimental** library for the INA236 current and power sensor.  
+Experimental library for the INA236 current and power sensor.  
 Ported and updated from INA226 to INA236 by Josef Tremmel (thanks!).
 
 Read datasheet for details.
@@ -51,8 +53,10 @@ A few important maxima, see datasheet, chapter 6.
 - 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/INA229  85 Volt, SPI, 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/INA260  36 Volt, I2C, 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
@@ -136,7 +140,7 @@ Note: one needs to set **Wire.begin()** before calling **begin()**.
 - **bool isConnected()** returns true if the INA236 address is on the I2C bus.
 - **uint8_t getAddress()** returns the address set in the constructor.
 
-### BUS VOLTAGE
+### Bus voltage
 
 Main function + wrappers.
 
@@ -146,7 +150,7 @@ This value is always positive.
 - **float getBusMilliVolt()**
 - **float getBusMicroVolt()**
 
-### SHUNT VOLTAGE
+### Shunt voltage
 
 - **float getShuntVoltage()** idem, Returns value in volts.
 Note the value can be positive or negative as the INA229 is bidirectional.
@@ -156,15 +160,15 @@ Note the value can be positive or negative as the INA229 is bidirectional.
 - **int32_t getShuntVoltageRAW()** integer version requested in issue #3.
 Returns raw ADC value, 20 bits with sign extended.
 
-### SHUNT CURRENT
+### Shunt current
 
 - **float getCurrent()** returns the current through the shunt in Ampere.
 Note this value can be positive or negative as the INA229 is bidirectional.
 - **float getAmpere()**
 - **float getMilliAmpere()**
 - **float getMicroAmpere()**
 
-### POWER
+### Power
 
 - **float getPower()** returns the current x BusVoltage in Watt.
 - **float getWatt()**
@@ -390,13 +394,20 @@ The alert line falls when alert is reached.
 ## Adjusting the range of the INA236
 
 **use at own risk**
-In issue #26 a hack is made to scale the INA236 to 300A by using a very small shunt.
-The library has a minimal limit for the shunt of 0.001 ohm.
-This limit can be overruled to support other ranges like the one discussed in #26.
-Overruling can be done by patching the following value in the INA236.h file.
+
+See INA226, issue 26 - https://github.com/RobTillaart/INA226/issues/26
+See INA236, issue 8  - https://github.com/RobTillaart/INA236/issues/8
+
+In issue #26 a hack is made to scale the INA226 to 300A by using a very small shunt.
+The INA236 library has a minimal limit for the shunt of 0.001 Ohm = 1 mOhm.
+This limit can be overruled to support wider ranges like the one discussed in #26.
+Overruling can be done by changing the value in the **INA236.h** file,
+or by defining INA236_MINIMAL_SHUNT on the command line.
 
 ```cpp
-#define INA236_MINIMAL_SHUNT             (0.001)
+#ifndef INA236_MINIMAL_SHUNT
+#define INA236_MINIMAL_SHUNT              0.001
+#endif
 ```
 
 Be aware that
@@ -418,7 +429,6 @@ Be aware that
 
 #### Could
 
-
 #### Won't
 
 

libraries/INA236/examples/INA236_array/INA236_array.ino

@@ -24,6 +24,7 @@ INA236 INA[INA_COUNT] =
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("INA236_LIB_VERSION: ");
   Serial.println(INA236_LIB_VERSION);

libraries/INA236/examples/INA236_compare_normalize/INA236_compare_normalize.ino

@@ -14,6 +14,7 @@ INA236 INA(0x40);
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("INA236_LIB_VERSION: ");
   Serial.println(INA236_LIB_VERSION);

libraries/INA236/examples/INA236_demo/INA236_demo.ino

@@ -14,6 +14,7 @@ INA236 INA(0x40);
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("INA236_LIB_VERSION: ");
   Serial.println(INA236_LIB_VERSION);