Max/thomasfredericks_Bounce2
1
0
Fork 0
Code Issues 5 Pull Requests 4 Actions Packages Projects Releases 17 Wiki Activity

Updating documentation

Browse Source
This commit is contained in:
Thomas O Fredericks
2018-07-18 12:24:20 -04:00
parent 045183b598
commit f19d27689f
1 changed files with 26 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+26 -9
View File
@@ -1,14 +1,20 @@
# BOUNCE 2
Debouncing library for Arduino and Wiring by Thomas Ouellet Fredericks with contributions from: Eric Lowry, Jim Schimpf, Tom Harkaway and Joachim Krüger.
Debouncing library for Arduino and Wiring by Thomas Ouellet Fredericks with contributions from: Eric Lowry, Jim Schimpf, Tom Harkaway, Joachim Krüger and MrGradgrind.
More about debouncing: http://en.wikipedia.org/wiki/Debounce#Contact_bounce
## GITHUB PAGE
https://github.com/thomasfredericks/Bounce2
## DOCUMENTATION
The complete class documentation can be found in the "docs" folder or [online here](http://thomasfredericks.github.io/Bounce2/).
# HAVE A QUESTION?
Please post your questions here
http://forum.arduino.cc/index.php?topic=266132.0
Please post your questions [here](http://forum.arduino.cc/index.php?topic=266132.0).
# INSTALLATION & DOWNLOAD
@@ -16,23 +22,34 @@ Install through your software's Library Manager or download the latest version [
The original version of Bounce (Bounce 1) is included in the download but not supported anymore.
# DOCUMENTATION
The complet documentation can be found in the "docs" folder or [online here](http://thomasfredericks.github.io/Bounce2/).
# DEBOUNCE ALGORITHMS
## Stable interval
## STABLE INTERVAL
By default, the Bounce library uses a stable interval to process the debouncing. This is simpler to understand and can cancel unwanted noise.
![](https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/extras/BouncySwitch_stable.png)
## Lock-out interval
## LOCK-OUT INTERVAL
By defining "#define BOUNCE_LOCK_OUT" in "Bounce.h" you can activate the alternative debouncing method. This method is a lot more responsive, but does not cancel noise.
By defining "#define BOUNCE_LOCK_OUT" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. This method is a lot more responsive, but does not cancel noise.
```
#define BOUNCE_LOCK_OUT
```
![](https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/extras/BouncySwitch_lockout.png)
## WITH PROMPT DETECTION
By defining "#define BOUNCE_WITH_PROMPT_DETECTION" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. Button state changes are available immediately so long as the previous state has been stable for the timeout period. Otherwise the state will be updated as soon as the timeout period allows.
* Able to report acurate switch time normally with no delay.
* Use when accurate switch transition timing is important.
```
#define BOUNCE_WITH_PROMPT_DETECTION
```