From f19d27689fbbccd9faadf366a47dc2e0ad8f5e74 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Wed, 18 Jul 2018 12:24:20 -0400 Subject: [PATCH] Updating documentation --- README.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2295093..eae1d7f 100644 --- a/README.md +++ b/README.md @@ -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 +``` \ No newline at end of file