0.1.3 INA219

Author: RobTillaart

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

@@ -6,7 +6,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: arduino/arduino-lint-action@v1
         with:
           library-manager: update

libraries/INA219/.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

libraries/INA219/.github/workflows/jsoncheck.yml

@@ -10,7 +10,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v1
         with:

libraries/INA219/CHANGELOG.md

@@ -6,11 +6,24 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.1.3] - 2023-03-31
+- fix setBusADC() range check
+- fix setShuntADC() range check
+- fix setMode() range check
+- add getMathOverflowFlag()
+- add getConversionFlag()
+- add example to test settings
+- add example to test I2C speed
+- update readme.md
+- update GitHub actions
+- update license 2023
+- minor edits
+
+
 ## [0.1.2] - 2022-11-14
 - Add RP2040 support to build-CI.
 - Add CHANGELOG.md
 
-
 ## [0.1.1] - 2022-09-06
 - refactor and first public release
 

libraries/INA219/INA219.cpp

@@ -1,11 +1,9 @@
 //    FILE: INA219.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.2
+// VERSION: 0.1.3
 //    DATE: 2021-05-18
 // PURPOSE: Arduino library for INA219 voltage, current and power sensor
 //     URL: https://github.com/RobTillaart/INA219
-//
-// HISTORY: see changelog.md
 
 
 #include "INA219.h"
@@ -90,7 +88,7 @@ float INA219::getBusVoltage()
 {
   uint16_t value = _readRegister(INA219_BUS_VOLTAGE);
   uint8_t flags = value & 0x03;
-  //  overflow handling
+  //  math overflow handling
   if (flags & 0x01) return -100;
   float voltage = (value >> 3)  * 4e-3;   //  fixed 4 mV
   return voltage;
@@ -112,6 +110,20 @@ float INA219::getCurrent()
 }
 
 
+bool INA219::getMathOverflowFlag()
+{
+  uint16_t value = _readRegister(INA219_BUS_VOLTAGE);
+  return ((value & 0x0001) == 0x0001);
+}
+
+
+bool INA219::getConversionFlag()
+{
+  uint16_t value = _readRegister(INA219_BUS_VOLTAGE);
+  return ((value & 0x0002) == 0x0002);
+}
+
+
 ////////////////////////////////////////////////////////
 //
 //  CONFIGURATION
@@ -178,7 +190,7 @@ uint8_t INA219::getGain()
 
 bool INA219::setBusADC(uint8_t mask)
 {
-  if (mask > 0x000F) return false;
+  if (mask > 0x0F) return false;
 
   //  TODO improve this one. datasheet.
   //       two functions
@@ -204,7 +216,7 @@ uint8_t INA219::getBusADC()
 
 bool INA219::setShuntADC(uint8_t mask)
 {
-  if (mask > 0x000F) return false;
+  if (mask > 0x0F) return false;
 
   //  TODO improve this one. datasheet.
   //       two functions
@@ -227,7 +239,7 @@ uint8_t INA219::getShuntADC()
 
 bool INA219::setMode(uint8_t mode)
 {
-  if (mode > 8) return false;
+  if (mode > 7) return false;
   uint16_t config = _readRegister(INA219_CONFIGURATION);
   config &= ~INA219_CONF_MODE;
   config |= mode;
@@ -250,7 +262,7 @@ uint8_t INA219::getMode()
 //
 bool INA219::setMaxCurrentShunt(float maxCurrent, float shunt)
 {
-  #define printdebug true
+  // #define printdebug
   uint16_t calib = 0;
 
   if (maxCurrent < 0.001) return false;
@@ -288,7 +300,7 @@ bool INA219::setMaxCurrentShunt(float maxCurrent, float shunt)
 
 ////////////////////////////////////////////////////////
 //
-// PRIVATE
+//  PRIVATE
 //
 
 uint16_t INA219::_readRegister(uint8_t reg)
@@ -315,5 +327,5 @@ uint16_t INA219::_writeRegister(uint8_t reg, uint16_t value)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

libraries/INA219/INA219.h

@@ -1,20 +1,20 @@
 #pragma once
 //    FILE: INA219.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.2
+// VERSION: 0.1.3
 //    DATE: 2021-05-18
 // PURPOSE: Arduino library for INA219 voltage, current and power sensor
 //     URL: https://github.com/RobTillaart/INA219
 //
-//  Read the datasheet for the details
+//  Read the datasheet for the details how to connect!
 //
 
 
 #include "Arduino.h"
 #include "Wire.h"
 
 
-#define INA219_LIB_VERSION              (F("0.1.2"))
+#define INA219_LIB_VERSION              (F("0.1.3"))
 
 
 class INA219
@@ -30,11 +30,13 @@ class INA219
   bool     isConnected();
 
 
-  //  CORE FUNCTIONS            //  Register
-  float    getShuntVoltage();   //  01
-  float    getBusVoltage();     //  02
-  float    getPower();          //  03
-  float    getCurrent();        //  04
+  //  CORE FUNCTIONS               //  Register
+  float    getShuntVoltage();      //  01
+  float    getBusVoltage();        //  02
+  float    getPower();             //  03
+  float    getCurrent();           //  04
+  bool     getMathOverflowFlag();  //  02
+  bool     getConversionFlag();    //  02
 
 
   //  SCALE HELPERS
@@ -71,7 +73,7 @@ class INA219
   bool     setModeADCOff()             { return setMode(4); };
   bool     setModeShuntContinuous()    { return setMode(5); };
   bool     setModeBusContinuous()      { return setMode(6); };
-  bool     setModeShuntBusContinuous() { return setMode(7); };  // default.
+  bool     setModeShuntBusContinuous() { return setMode(7); };  //  default.
 
 
   //  CALIBRATION
@@ -109,5 +111,5 @@ class INA219
 };
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

libraries/INA219/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2022 Rob Tillaart
+Copyright (c) 2021-2023 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