update readme.md (#41)

- add badges to readme.md - minor edits
RobTillaart · Sep 20, 2023 · 5b73115 · 5b73115
1 parent 508b286
commit 5b73115
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 23 deletions.
diff --git a/ACS712.cpp b/ACS712.cpp
@@ -1,7 +1,7 @@
 //
 //    FILE: ACS712.cpp
 //  AUTHOR: Rob Tillaart, Pete Thompson
-// VERSION: 0.3.7
+// VERSION: 0.3.8
 //    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.7
+// VERSION: 0.3.8
 //    DATE: 2020-08-02
 // PURPOSE: ACS712 library - current measurement
 //     URL: https://github.com/RobTillaart/ACS712
@@ -13,7 +13,8 @@
 
 #include "Arduino.h"
 
-#define ACS712_LIB_VERSION        (F("0.3.7"))
+
+#define ACS712_LIB_VERSION        (F("0.3.8"))
 
 
 //  ACS712_FF_SINUS == 1.0/sqrt(2) == 0.5 * sqrt(2)

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,12 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.8] - 2023-09-19
+- add badges to readme.md
+- minor edits
+
+
 ## [0.3.7] - 2023-05-20
 - add example **estimateMidPointAC.ino** #37
 - update readme.md (sampling trick #38).
 - minor edits.
 
-
 ## [0.3.6] - 2023-04-19
 - add **autoMidPointDC(cycles)** see issue #35
 - add rounding to **autoMidPoint()**

diff --git a/README.md b/README.md
@@ -2,8 +2,11 @@
 [![Arduino CI](https://github.com/RobTillaart/ACS712/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/ACS712/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/ACS712/actions/workflows/arduino-lint.yml)
 [![JSON check](https://github.com/RobTillaart/ACS712/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/ACS712/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/ACS712.svg)](https://github.com/RobTillaart/ACS712/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/ACS712/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/ACS712.svg?maxAge=3600)](https://github.com/RobTillaart/ACS712/releases)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/ACS712.svg)](https://registry.platformio.org/libraries/robtillaart/ACS712)
 
 
 # ACS712
@@ -16,14 +19,17 @@ Library for the ACS712 Current Sensor - 5A, 20A, 30A and compatibles.
 The ACS712 is a chip to measure current, both AC or DC. The chip has an
 analogue output that provides a voltage that is linear with the current.
 The ACS712 library supports only a built in ADC by means of **analogRead()**.
-There are 4 core functions:
+
+However since 0.3.4 there is an experimental **setADC()**.
+
+The library has 4 core functions:
 
 - **float mA_peak2peak(frequency = 50, cycles = 1)**
 - **float mA_DC(cycles = 1)**
 - **float mA_AC(frequency = 50, cycles = 1)**
 - **float mA_AC_sampling(frequency = 50, cycles = 1)**
 
-The parameter cycles is used to do measure multiple cycles and average them.
+The parameter cycles is used to measure multiple cycles and average them.
 
 To measure DC current a single **analogRead()** with conversion math is
 sufficient to get a value.
@@ -36,8 +42,10 @@ This factor depends heavily on the signal form, hence its name.
 For a perfect sinus the value is sqrt(2)/2 == 1/sqrt(2).
 See **Form factor** below.
 
+For a 60 Hz environment the blocking is ~16.7 milliseconds, still pretty long.
+
 The **mA_AC_sampling()** calculates the average of the sumSquared of many measurements.
-It should be used when the form factor is not known.
+This function should be used when the form factor is not known.
 
 Note to make precise measurements, the power supply of both the ACS712 and the ADC of
 the processor should be as stable as possible.
@@ -59,8 +67,8 @@ mA LSB = (1000 * 5000 mV) / (maxADC * mVperA);
 ```
 
 Although no 16 bit ADC built in are known, it indicates what resolution
-could be obtained with such an ADC. It triggered the thought for supporting
-external ADC's with this library or a derived version. See future.
+could be obtained with such an ADC. It triggered the experimental supporting
+of external ADC's with this library.
 
 
 #### Tests
@@ -75,17 +83,16 @@ The library is at least confirmed to work with the following boards:
 | ESP32        |  3.3V   |   4096    | #15
 | Promicro     |  5.0V   |   1024    | #15
 
-Please let me know of other working platforms / processors.
-
+Please let me know of other working platforms / processors (and failing ones!).
 
 
 ## Compatibles
 
 Robodyn has a breakout for the ACS758 - 50 A. - See resolution below.
 This sensor has versions up to 200 Amps, so use with care!
 
-Allegromicro offers a lot of different current sensors, that might be compatible.
-These include bidirectional and unidirectional.
+Allegromicro offers a lot of different current sensors that might be compatible.
+These include bidirectional and unidirectional ones.
 The unidirectional seem to be for DC only.
 
 https://www.allegromicro.com/en/products/sense/current-sensor-ics/current-sensors-innovations
@@ -215,7 +222,7 @@ The library does not support this yet.
 
 #### Form factor
 
-The form factor is also known as the crest factor.
+The form factor is also known as the **crest factor**.
 It is only used for signals measured with **mA_AC()**.
 
 - **void setFormFactor(float formFactor = ACS712_FF_SINUS)** manually sets the form factor.
@@ -224,12 +231,12 @@ Must typical be between 0.0 and 1.0, see constants below.
 
 The library has a number of predefined form factors:
 
-|  definition          | value         | approx |  notes  |
-|:---------------------|:--------------|:------:|:--------|
-| ACS712_FF_SQUARE     | 1.0           | 1.000  |         |
-| ACS712_FF_SINUS      | 1.0 / sqrt(2) | 0.707  | default |
-| ACS712_FF_TRIANGLE   | 1.0 / sqrt(3) | 0.577  |         |
-| ACS712_FF_SAWTOOTH   | 1.0 / sqrt(3) | 0.577  |         |
+|  definition          |  value          |  approx  |  notes    |
+|:---------------------|:----------------|:--------:|:----------|
+|  ACS712_FF_SQUARE    |  1.0            |  1.000   |
+|  ACS712_FF_SINUS     |  1.0 / sqrt(2)  |  0.707   |  default  |
+|  ACS712_FF_TRIANGLE  |  1.0 / sqrt(3)  |  0.577   |
+|  ACS712_FF_SAWTOOTH  |  1.0 / sqrt(3)  |  0.577   |
 
 It is important to measure the current with a calibrated multimeter
 and determine / verify the form factor of the signal.
@@ -480,3 +487,12 @@ The examples show the basic working of the functions.
 - setADC() to support > 16 bit?
   - uint32_t performance penalty?
 
+
+## Support
+
+If you appreciate my libraries, you can support the development and maintenance.
+Improve the quality of the libraries by providing issues and Pull Requests, or
+donate through PayPal or GitHub sponsors.
+
+Thank you,
+
diff --git a/library.json b/library.json
@@ -21,9 +21,9 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/ACS712.git"
   },
-  "version": "0.3.7",
+  "version": "0.3.8",
   "license": "MIT",
-  "frameworks": "arduino",
+  "frameworks": "*",
   "platforms": "*",
   "headers": "ACS712.h"
 }
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=ACS712
-version=0.3.7
+version=0.3.8
 author=Rob Tillaart <[email protected]>, Pete Thompson <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=ACS712 library for Arduino.