update libraries A-D

Author: RobTillaart

README.md

@@ -1,13 +1,15 @@
 # Arduino libraries
 
+**NOTE** these libraries will all get their own repo, so this repository
+does not have the latest version of all libs anymore. That said I will update
+this bulk repo on request or if time permit.
+
+
 ### Introduction
 This repository contains several Arduino libraries I have written to be used in applications. 
 Most of them include example code how the libraries can be used. 
 Furthermore this repository contains a few stand alone applications.
 
-**NOTE** these libraries will all get their own repo, so this repository
-does not have the latest version of all libs anymore. That said I will update
-this bulk repo on request or if time permit.
 
 ### Questions
 For questions about the usage of the libraries, please post a question on the Arduino 

libraries/ACS712/ACS712.cpp

@@ -1,16 +1,17 @@
 //
 // FILE: ACS712.cpp
-// AUTHOR: Rob Tillaart
-// VERSION: 0.1.1
-// DATE: 2020-03-17
+// AUTHOR: Rob Tillaart, Pete Thompson
+// VERSION: 0.2.0
+// DATE: 2020-08-02
 // PURPOSE: ACS712 library - current measurement
 //
 // HISTORY:
 // 0.1.0 2020-03-17 initial version
 // 0.1.1 2020-03-18 first release version
-//
-// Released to the public domain
-//
+// 0.1.2	2020-03-21 automatic formfactor test
+// 0.1.3 2020-05-27 fix library.json
+// 0.1.4 2020-08-02 Allow for faster processors
+// 0.2.0 2020-08-02 Add autoMidPoint
 
 #include "ACS712.h"
 
@@ -22,26 +23,43 @@ ACS712::ACS712(uint8_t analogPin, float volts, uint16_t maxADC, uint8_t mVperA)
  _mVperAmpere = mVperA;
  _formFactor = 0.70710678119; // 0.5 * sqrt(2); TODO: should be smaller in practice 0.5 ?
  _midPoint = maxADC / 2;
+ _noisemV = 21; // Noise is 21mV according to datasheet
 }
 
-int ACS712::mA_AC()
+int ACS712::mA_AC(uint8_t freq)
 {
  uint32_t start = micros();
+ uint16_t period = ((freq == 60) ? 16670 : 20000);
+ uint16_t samples = 0;
+ uint16_t zeros = 0;
  int _min, _max;
  _min = _max = analogRead(_pin);
- while (micros() - start < 20000) // UNO ~180 samples...
+ while (micros() - start < period) // UNO ~180 samples...
  {
+ samples++;
  int val = analogRead(_pin);
  if (val < _min) _min = val;
  if (val > _max) _max = val;
+ if (abs(val - _midPoint) <= (_noisemV/_mVpstep)) zeros++;
  }
  int p2p = (_max - _min);
- // TODO determine _formFactor
- // two counters, a threshold and math is needed
- // D = (1.0 - #samples close to zero ) / #samples
- // FF = D * 0.5 * sqrt(2);
- 
- // math could be partially precalculated 
+
+ // automatic determine _formFactor / crest factor
+ float D = 0;
+ float FF = 0;
+ if (zeros > samples * 0.025)
+ {
+ D = 1.0 - (1.0 * zeros) / samples; // % SAMPLES NONE ZERO
+ FF = sqrt(D) * 0.5 * sqrt(2); // ASSUME NON ZERO PART ~ SINUS
+ }
+ else // # zeros is small => D --> 1 --> sqrt(D) --> 1
+ {
+ FF = 0.5 * sqrt(2);
+ }
+ _formFactor = FF;
+
+ // math could be partially precalculated: C = 1000.0 * 0.5 * _mVpstep / _mVperAmpere;
+ // rounding?
  return 1000.0 * 0.5 * p2p * _mVpstep * _formFactor / _mVperAmpere;
 }
 
@@ -53,4 +71,22 @@ int ACS712::mA_DC()
  return 1000.0 * steps * _mVpstep / _mVperAmpere;
 }
 
+// configure by sampling for 2 cycles of AC
+// Also works for DC as long as no current flowing
+void ACS712::autoMidPoint(uint8_t freq)
+{
+ uint32_t start = micros();
+ uint16_t twoPeriods = ((freq == 60) ? 16670 : 20000) * 2;
+ uint32_t total = 0;
+ uint32_t samples = 0;
+ while (micros() - start < twoPeriods) {
+ uint16_t reading = analogRead(_pin);
+ total += reading;
+ samples ++;
+ // Delaying ensures we won't overflow since we'll perform a maximum of 40,000 reads
+ delayMicroseconds(1);
+ }
+ _midPoint = total / samples;
+}
+
 // END OF FILE

libraries/ACS712/ACS712.h

@@ -2,18 +2,16 @@
 //
 // FILE: ACS712.h
 // AUTHOR: Rob Tillaart
-// VERSION: 0.1.1
-// DATE: 2020-03-17
+// VERSION: 0.2.0
+// DATE: 2020-08-02
 // PURPOSE: ACS712 library - current measurement
 //
-// Released to the public domain
-//
 // Tested with a RobotDyn ACS712 20A breakout + UNO.
 //
 
 #include "Arduino.h"
 
-#define ACS712_LIB_VERSION "0.1.1"
+#define ACS712_LIB_VERSION "0.1.3"
 
 
 class ACS712
@@ -31,8 +29,8 @@ class ACS712
  ACS712(uint8_t analogPin, float volts = 5.0, uint16_t maxADC = 1023, uint8_t mVperA = 100);
 
  // returns mA
- // blocks 20-21 ms to sample a whole 50 or 60 Hz period. // TODO HZ as param ??
- int mA_AC();
+ // blocks 20-21 ms to sample a whole 50 or 60 Hz period.
+ int mA_AC(uint8_t freq = 50);
 
  // returns mA
  // blocks < 1 ms
@@ -43,11 +41,17 @@ class ACS712
  inline uint16_t getMidPoint() { return _midPoint; };
  inline void incMidPoint() { _midPoint++; };
  inline void decMidPoint() { _midPoint--; };
+ // Auto midPoint, assuming zero DC current or any AC current
+ void autoMidPoint(uint8_t freq = 50);
 
  // also known as crest factor; affects AC only
  inline void setFormFactor(float ff) { _formFactor = ff; };
  inline float getFormFactor() { return _formFactor; };
 
+ // noise
+ inline void setNoisemV(uint8_t noisemV) { _noisemV = noisemV; };
+ inline uint8_t getNoisemV() { return _noisemV; };
+
  // AC and DC
  inline void setmVperAmp(uint8_t mva) { _mVperAmpere = mva; };
  inline uint8_t getmVperAmp() { return _mVperAmpere; };
@@ -58,6 +62,7 @@ class ACS712
  float _formFactor; // P2P -> RMS
  uint8_t _mVperAmpere;
  uint16_t _midPoint;
+ uint8_t _noisemV;
 };
 
 // END OF FILE

libraries/ACS712/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

libraries/ACS712/examples/ACS712_20_AC/ACS712_20_AC.ino

@@ -15,17 +15,28 @@
 // ACS712 30A uses 66 mV per A
 
 ACS712 ACS(A0, 5.0, 1023, 100);
+// ESP 32 example (requires resistors to step down the logic voltage)
+//ACS712 ACS(25, 5.0, 4095, 185);
 
 void setup()
 {
  Serial.begin(115200);
  Serial.println(__FILE__);
+
+ ACS.autoMidPoint();
+ Serial.print("MidPoint: ");
+ Serial.print(ACS.getMidPoint());
+ Serial.print(". Noise mV: ");
+ Serial.println(ACS.getNoisemV());
 }
 
 void loop()
 {
  int mA = ACS.mA_AC();
- Serial.println(mA);
+ Serial.print("mA: ");
+ Serial.print(mA);
+ Serial.print(". Form factor: ");
+ Serial.println(ACS.getFormFactor());
 }
 
 // END OF FILE

libraries/ACS712/examples/ACS712_20_AC_DEMO/ACS712_20_AC_DEMO.ino

@@ -15,11 +15,14 @@
 // ACS712 30A uses 66 mV per A
 
 ACS712 ACS(A0, 5.0, 1023, 100);
+// ESP 32 example (requires resistors to step down the logic voltage)
+//ACS712 ACS(25, 5.0, 4095, 185);
 
 void setup()
 {
  Serial.begin(115200);
  Serial.println(__FILE__);
+ ACS.autoMidPoint();
 }
 
 void loop()

libraries/ACS712/examples/ACS712_20_DC/ACS712_20_DC.ino

@@ -15,11 +15,14 @@
 // ACS712 30A uses 66 mV per A
 
 ACS712 ACS(A0, 5.0, 1023, 100);
+// ESP 32 example (requires resistors to step down the logic voltage)
+//ACS712 ACS(25, 5.0, 4095, 185);
 
 void setup()
 {
  Serial.begin(115200);
  Serial.println(__FILE__);
+ ACS.autoMidPoint();
 }
 
 void loop()

libraries/ACS712/examples/ACS712_20_DC_DEMO/ACS712_20_DC_DEMO.ino

@@ -15,11 +15,14 @@
 // ACS712 30A uses 66 mV per A
 
 ACS712 ACS(A0, 5.0, 1023, 100);
+// ESP 32 example (requires resistors to step down the logic voltage)
+//ACS712 ACS(25, 5.0, 4095, 185);
 
 void setup()
 {
  Serial.begin(115200);
  Serial.println(__FILE__);
+ ACS.autoMidPoint();
 }
 
 void loop()

libraries/ACS712/library.json

@@ -8,17 +8,20 @@
  "name": "Rob Tillaart",
  "email": "Rob.Tillaart@gmail.com",
  "maintainer": true
+ },
+ {
+ "name": "Pete Thompson",
+ "email": "pete.thompson@yahoo.com",
+ "maintainer": false
  }
+
  ],
  "repository":
  {
  "type": "git",
- "url": "https://github.com/RobTillaart/Arduino.git"
+ "url": "https://github.com/RobTillaart/ACS712"
  },
- "version":"0.1.1",
+ "version":"0.2.0",
  "frameworks": "arduino",
- "platforms": "*",
- "export": {
- "include": "libraries/ACS712"
- }
+ "platforms": "*"
 }

libraries/ACS712/library.properties

@@ -1,9 +1,11 @@
 name=ACS712
-version=0.1.1
-author=Rob Tillaart <rob.tillaart@gmail.com>
+version=0.2.0
+author=Rob Tillaart <rob.tillaart@gmail.com>, Pete Thompson <pete.thompson@yahoo.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
-sentence=ACS712 library for Arduino. 
+sentence=ACS712 library for Arduino.
 paragraph=Current measurement, tested with RobotDyn ACDC 20A Module.
 category=Signal Input/Output
-url=https://github.com/RobTillaart/Arduino.git
-architectures=*
+url=https://github.com/RobTillaart/ACS712
+architectures=*
+includes=ACS712.h
+depends=