diff --git a/Doxyfile b/Doxyfile index e0caafb..e2f3a50 100644 --- a/Doxyfile +++ b/Doxyfile @@ -906,7 +906,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = examples/bounce/bounce.ino +EXAMPLE_PATH = examples/bounce/bounce.ino examples/change/change.ino examples/bounce_multiple/bounce_multiple.ino examples/bounce2buttons/bounce2buttons.ino # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and diff --git a/README.md b/README.md index 60ce2f5..c9546f4 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Bounce debouncer = Bounce(); // Instantiate a Bounce object void setup() { debouncer.attach(BUTTON_PIN,INPUT_PULLUP); // Attach the debouncer to a pin with INPUT_PULLUP mode - debouncer.interval(500); + debouncer.interval(25); // Use a debounce interval of 25 milliseconds pinMode(LED_PIN,OUTPUT); // Setup the LED diff --git a/docs/_bounce2_8h_source.html b/docs/_bounce2_8h_source.html index 89bb0ea..c8928ec 100644 --- a/docs/_bounce2_8h_source.html +++ b/docs/_bounce2_8h_source.html @@ -66,16 +66,16 @@ $(function() {
|
+ Bounce2
+
+ |
+
Example of two instances of the Bounce class that switches the debug LED when either one of the two buttons is pressed.
+
+ 1.8.13
+
+
+
diff --git a/docs/bounce_8ino-example.html b/docs/bounce_8ino-example.html
index 7055158..ea9dc68 100644
--- a/docs/bounce_8ino-example.html
+++ b/docs/bounce_8ino-example.html
@@ -62,7 +62,7 @@ $(function() {
This is an example of how to use the Example_Test class. More details about this example.
+Simple example of the Bounce library that switches the debug LED when a button is pressed.
|
+ Bounce2
+
+ |
+
Detect the falling edge of multiple buttons. Eight buttons with internal pullups. Toggles a LED when any button is pressed. Buttons on pins 2,3,4,5,6,7,8,9
+
+ 1.8.13
+
+
+
diff --git a/docs/change_8ino-example.html b/docs/change_8ino-example.html
new file mode 100644
index 0000000..4b87ddc
--- /dev/null
+++ b/docs/change_8ino-example.html
@@ -0,0 +1,74 @@
+
+
+
+
+
+
+
+|
+ Bounce2
+
+ |
+
This example toggles the debug LED (pin 13) on or off when a button on pin 2 is pressed.
+
+ 1.8.13
+
+
+
diff --git a/docs/examples.html b/docs/examples.html
index 92294f5..76342e5 100644
--- a/docs/examples.html
+++ b/docs/examples.html
@@ -65,6 +65,12 @@ $(function() {
Debouncing library for Arduino and Wiring
-by Thomas Ouellet Fredericks
-with contributions from:
-Eric Lowry, Jim Schimpf, Tom Harkaway and Joachim Krüger.
-Please post your questions here : http://forum.arduino.cc/index.php?topic=266132.0
-Download the latest version (version 2) here :
-https://github.com/thomasfredericks/Bounce2/archive/master.zip
-Put the "Bounce2" folder in your Arduino or Wiring "libraries" folder.
-The latest version (version 2) documentation can be found here :
-https://github.com/thomasfredericks/Bounce2/wiki
-The original version of Bounce (Bounce 1) is included but not supported anymore.
-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
+See the bottom of this page for a basic usage example and the "examples" folder for more.
+https://github.com/thomasfredericks/Bounce2
+The complete class documentation can be found in the "docs" folder or online here.
+Please post your questions here.
+Install through your software's Library Manager or download the latest version here and put the "Bounce2" folder in your "libraries" folder.
+The original version of Bounce (Bounce 1) is included in the download but not supported anymore.
+By default, the Bounce library uses a stable interval to process the debouncing. This is simpler to understand and can cancel unwanted 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.
+
+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.
+