update examples + GitHub actions (#57)

RobTillaart · web-flow · commit ff8a48961308 · 2026-01-02T15:07:00.000+01:00
diff --git a/.github/workflows/arduino-lint.yml b/.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@v6
+      - uses: arduino/arduino-lint-action@v2
         with:
           library-manager: update
           compliance: strict
diff --git a/.github/workflows/arduino_test_runner.yml b/.github/workflows/arduino_test_runner.yml
@@ -6,9 +6,8 @@ jobs:
   runTest:
     runs-on: ubuntu-latest
     timeout-minutes: 20
-
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
diff --git a/.github/workflows/jsoncheck.yml b/.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@v6
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v2
         with:
diff --git a/ACS712.cpp b/ACS712.cpp
@@ -1,7 +1,7 @@
 //
 //    FILE: ACS712.cpp
 //  AUTHOR: Rob Tillaart, Pete Thompson
-// VERSION: 0.3.10
+// VERSION: 0.4.0
 //    DATE: 2020-08-02
 // PURPOSE: ACS712 library - current measurement
 //     URL: https://github.com/RobTillaart/ACS712
diff --git a/ACS712.h b/ACS712.h
@@ -2,7 +2,7 @@
 //
 //    FILE: ACS712.h
 //  AUTHOR: Rob Tillaart, Pete Thompson
-// VERSION: 0.3.10
+// VERSION: 0.4.0
 //    DATE: 2020-08-02
 // PURPOSE: ACS712 library - current measurement
 //     URL: https://github.com/RobTillaart/ACS712
@@ -14,7 +14,7 @@
 #include "Arduino.h"
 
 
-#define ACS712_LIB_VERSION              (F("0.3.10"))
+#define ACS712_LIB_VERSION              (F("0.4.0"))
 
 
 //  ACS712_FF_SINUS == 1.0/sqrt(2) == 0.5 * sqrt(2)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.4.0] 2026-01-02
+- update GitHub actions
+- update examples
+- bump version number
+- minor edits
+
+----
+
 ## [0.3.10] - 2024-10-20
 - update readme.md, ESPHome #51, kudos to uTZFu
 - add debug example.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2024 Rob Tillaart
+Copyright (c) 2020-2026 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
diff --git a/README.md b/README.md
@@ -414,7 +414,6 @@ for this "voltage divider effect".
 
 ### Examples:
 
-
 For a 5 A type sensor, 185 mV/A would be the normal value.
 After using a voltage divider one need to adjust the mVperAmp.
 
@@ -423,7 +422,7 @@ After using a voltage divider one need to adjust the mVperAmp.
 |  10200   |  4745     |  4745 / (10200 + 4745) = 0.3175 | 185 \* 0.3175 =  31.75  |
 |  4745    |  10200    | 10200 / (10200 + 4745) = 0.6825 | 185 \* 0.6825 =  68.25  |
 |  10200   |  9800     |  9800 / (10200 + 9800) = 0.4900 | 185 \* 0.4900 =  49.00  |
-|  1000    |  2200     |  2200 / (1000 + 2200)  = 0.6875 | 185 \* 0.6875 = 127.19  | 5V -> 3V3 ADC
+|  1000    |  2200     |  2200 / (1000 + 2200)  = 0.6875 | 185 \* 0.6875 = 127.19  |  5V -> 3V3 ADC
 |  300     |  75       |  75   / (300 + 75)     = 0.2000 | 185 \* 0.2000 =  37.00  |  5V -> 1V ADC
 
 
@@ -523,7 +522,7 @@ The examples show the basic working of the functions.
   - need to buy extra hardware
 
 
-#### Should - 0.3.x
+#### Should
 
 - investigate **estimateMidPoint(confidence)** See issue #35
   - is less blocking by spreading the sampling over many calls.
@@ -539,7 +538,7 @@ The examples show the basic working of the functions.
 
 #### Could
 
-- merge **mA_AC()** and **mA_AC_sampling()** into one. (0.4.0)
+- merge **mA_AC()** and **mA_AC_sampling()** into one
   - or remove - depreciate - the worst one
 - add range check to (all) set functions?
 - add unit test for **autoMidPointDC()** (needed?)
diff --git a/examples/ACS712_20_AC/ACS712_20_AC.ino b/examples/ACS712_20_AC/ACS712_20_AC.ino
@@ -14,9 +14,9 @@
 //  ACS712 30A uses  66 mV per A
 
 
-ACS712  ACS(A0, 5.0, 1023, 100);
+//  ACS712  ACS(A0, 5.0, 1023, 100);
 //  ESP 32 example (might requires resistors to step down the logic voltage)
-//  ACS712  ACS(25, 3.3, 4095, 185);
+ACS712  ACS(25, 3.3, 4095, 185);
 
 
 uint32_t start, stop;
@@ -26,9 +26,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
 
   //  use simulation
@@ -67,4 +69,3 @@ uint16_t signal(uint8_t p)
 
 
 //  -- END OF FILE --
-
diff --git a/examples/ACS712_20_AC_DEMO/ACS712_20_AC_DEMO.ino b/examples/ACS712_20_AC_DEMO/ACS712_20_AC_DEMO.ino
@@ -1,7 +1,7 @@
 //
 //    FILE: ACS712_20_AC_DEMO.ino
 //  AUTHOR: Rob Tillaart
-// PURPOSE: demo to set the mVperAmpere and Form FActor.
+// PURPOSE: demo to set the mVperAmpere and Form Factor.
 //     URL: https://github.com/RobTillaart/ACS712
 
 
@@ -23,9 +23,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.autoMidPoint();
 }
diff --git a/examples/ACS712_20_AC_SAMPLING_DEMO/ACS712_20_AC_SAMPLING_DEMO.ino b/examples/ACS712_20_AC_SAMPLING_DEMO/ACS712_20_AC_SAMPLING_DEMO.ino
@@ -23,10 +23,12 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
-  
+  Serial.println();
+
   ACS.autoMidPoint();
 }
 
diff --git a/examples/ACS712_20_AC_average/ACS712_20_AC_average.ino b/examples/ACS712_20_AC_average/ACS712_20_AC_average.ino
@@ -23,9 +23,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.autoMidPoint();
   Serial.print("MidPoint: ");
diff --git a/examples/ACS712_20_AC_compare/ACS712_20_AC_compare.ino b/examples/ACS712_20_AC_compare/ACS712_20_AC_compare.ino
@@ -23,9 +23,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.autoMidPoint();
   Serial.print("MidPoint: ");
diff --git a/examples/ACS712_20_AC_low_pass/ACS712_20_AC_low_pass.ino b/examples/ACS712_20_AC_low_pass/ACS712_20_AC_low_pass.ino
@@ -25,9 +25,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.autoMidPoint();
 
diff --git a/examples/ACS712_20_AC_midPoint_compare/ACS712_20_AC_midPoint_compare.ino b/examples/ACS712_20_AC_midPoint_compare/ACS712_20_AC_midPoint_compare.ino
@@ -23,10 +23,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
-  Serial.println(__FILE__);
   Serial.println();
+  Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   Serial.println("Compare different midPoint methods.\n");
 
diff --git a/examples/ACS712_20_AC_midPoint_performance/ACS712_20_AC_midPoint_performance.ino b/examples/ACS712_20_AC_midPoint_performance/ACS712_20_AC_midPoint_performance.ino
@@ -27,10 +27,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
-  Serial.println(__FILE__);
   Serial.println();
+  Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   Serial.println("Compare different midPoint methods.\n");
 
diff --git a/examples/ACS712_20_AC_simulation/ACS712_20_AC_simulation.ino b/examples/ACS712_20_AC_simulation/ACS712_20_AC_simulation.ino
@@ -26,9 +26,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   //  select simulated signal
   ACS.setADC(signal, 5, 1024);
diff --git a/examples/ACS712_20_AC_suppress_noise/ACS712_20_AC_suppress_noise.ino b/examples/ACS712_20_AC_suppress_noise/ACS712_20_AC_suppress_noise.ino
@@ -23,9 +23,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.autoMidPoint();
 
diff --git a/examples/ACS712_20_DC/ACS712_20_DC.ino b/examples/ACS712_20_DC/ACS712_20_DC.ino
@@ -25,9 +25,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.autoMidPoint();
   //  Serial.println(ACS.getMidPoint());
diff --git a/examples/ACS712_20_DC_DEMO/ACS712_20_DC_DEMO.ino b/examples/ACS712_20_DC_DEMO/ACS712_20_DC_DEMO.ino
@@ -23,9 +23,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.autoMidPoint();
 }
diff --git a/examples/ACS712_20_DC_external_ADC/ACS712_20_DC_external_ADC.ino b/examples/ACS712_20_DC_external_ADC/ACS712_20_DC_external_ADC.ino
@@ -7,6 +7,7 @@
 //  see also ACS712_ESP32_external_ADC.ino
 //  use with Arduino Serial Plotter
 
+
 #include "ACS712.h"
 
 
@@ -25,12 +26,14 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.setADC(testADC, 10, 1023);
-  
+
   //  ACS.autoMidPoint();
   //  Serial.println(ACS.getMidPoint());
 }
diff --git a/examples/ACS712_20_determine_form_factor/ACS712_20_determine_form_factor.ino b/examples/ACS712_20_determine_form_factor/ACS712_20_determine_form_factor.ino
@@ -24,9 +24,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   ACS.autoMidPoint();
 }
diff --git a/examples/ACS712_20_mV_noise_level/ACS712_20_mV_noise_level.ino b/examples/ACS712_20_mV_noise_level/ACS712_20_mV_noise_level.ino
@@ -23,9 +23,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 }
 
 
diff --git a/examples/ACS712_ESP32_external_ADC/ACS712_ESP32_external_ADC.ino b/examples/ACS712_ESP32_external_ADC/ACS712_ESP32_external_ADC.ino
@@ -39,10 +39,11 @@ uint16_t readADS1015(uint8_t pin)
 
 ///////////////////////////////////////////////////////////////
 
-void setup() 
+void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
diff --git a/examples/ACS712_I2C_display/ACS712_I2C_display.ino b/examples/ACS712_I2C_display/ACS712_I2C_display.ino
@@ -50,9 +50,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
 
   Wire.begin();
 
diff --git a/examples/ACS712_autoMidPointDC/ACS712_autoMidPointDC.ino b/examples/ACS712_autoMidPointDC/ACS712_autoMidPointDC.ino
@@ -25,9 +25,11 @@ void setup()
 {
   Serial.begin(115200);
   while (!Serial);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("ACS712_LIB_VERSION: ");
   Serial.println(ACS712_LIB_VERSION);
+  Serial.println();
   delay(10);
 
   //  might be different 1 cycle or 100.
@@ -39,7 +41,7 @@ void setup()
   Serial.println(stop - start);
   Serial.print("MP 1:\t");
   Serial.println(midPoint);
-  
+
   midPoint = ACS.autoMidPointDC(100);
   Serial.print("MP 100:\t");
   Serial.println(midPoint);
diff --git a/examples/ACS712_debug/ACS712_debug.ino b/examples/ACS712_debug/ACS712_debug.ino
diff --git a/examples/ACS712_detectFrequency/ACS712_detectFrequency.ino b/examples/ACS712_detectFrequency/ACS712_detectFrequency.ino
diff --git a/examples/RMS_by_sampling/RMS_by_sampling.ino b/examples/RMS_by_sampling/RMS_by_sampling.ino
diff --git a/examples/estimateMidPointAC/estimateMidPointAC.ino b/examples/estimateMidPointAC/estimateMidPointAC.ino
diff --git a/library.json b/library.json
diff --git a/library.properties b/library.properties
