From 00c6993ee449a26c0475c6b8f7fd1999ae9f4c75 Mon Sep 17 00:00:00 2001 From: lathoub Date: Sun, 25 Aug 2019 10:15:30 +0200 Subject: [PATCH 01/53] update tyo accept external currentState --- src/Bounce2.cpp | 45 +++++++++++++++++++++++++-------------------- src/Bounce2.h | 19 +++++++++++++------ 2 files changed, 38 insertions(+), 26 deletions(-) diff --git a/src/Bounce2.cpp b/src/Bounce2.cpp index 049452c..2fda2cc 100644 --- a/src/Bounce2.cpp +++ b/src/Bounce2.cpp @@ -17,20 +17,25 @@ Bounce::Bounce() void Bounce::attach(int pin) { this->pin = pin; - state = 0; - if (readCurrentState()) { - setStateFlag(DEBOUNCED_STATE | UNSTABLE_STATE); - } -#ifdef BOUNCE_LOCK_OUT - previous_millis = 0; -#else - previous_millis = millis(); -#endif + bool currentState = readCurrentState(); + attach(currentState); } -void Bounce::attach(int pin, int mode){ - setPinMode(pin, mode); - this->attach(pin); +void Bounce::attach(int pin, int mode) { + setPinMode(pin, mode); + this->attach(pin); +} + +void Bounce::attach(bool currentState) { + state = 0; + if (currentState) { + setStateFlag(DEBOUNCED_STATE | UNSTABLE_STATE); + } +#ifdef BOUNCE_LOCK_OUT + previous_millis = 0; +#else + previous_millis = millis(); +#endif } void Bounce::interval(uint16_t interval_millis) @@ -39,6 +44,14 @@ void Bounce::interval(uint16_t interval_millis) } bool Bounce::update() +{ + // Read the state of the switch in a temporary variable. + bool currentState = readCurrentState(); + + update(currentState); +} + +bool Bounce::update(bool currentState) { unsetStateFlag(CHANGED_STATE); @@ -46,7 +59,6 @@ bool Bounce::update() // Ignore everything if we are locked out if (millis() - previous_millis >= interval_millis) { - bool currentState = readCurrentState(); if ( currentState != getStateFlag(DEBOUNCED_STATE) ) { previous_millis = millis(); changeState(); @@ -55,9 +67,6 @@ bool Bounce::update() #elif defined BOUNCE_WITH_PROMPT_DETECTION - // Read the state of the switch port into a temporary variable. - bool readState = readCurrentState(); - if ( readState != getStateFlag(DEBOUNCED_STATE) ) { // We have seen a change from the current button state. @@ -81,10 +90,6 @@ bool Bounce::update() #else - // Read the state of the switch in a temporary variable. - bool currentState = readCurrentState(); - - // If the reading is different from last reading, reset the debounce counter if ( currentState != getStateFlag(UNSTABLE_STATE) ) { previous_millis = millis(); diff --git a/src/Bounce2.h b/src/Bounce2.h index da3d429..738bcf6 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -93,11 +93,16 @@ class Bounce */ void attach(int pin, int mode); - /** - Attach to a pin for advanced users. Only attach the pin this way once you have previously set it up. Otherwise use attach(int pin, int mode). - */ - void attach(int pin); - + /** + Attach to a pin for advanced users. Only attach the pin this way once you have previously set it up. Otherwise use attach(int pin, int mode). + */ + void attach(int pin); + + /** + + */ + void attach(bool currentValue); + /** @brief Sets the debounce interval in milliseconds. @@ -117,7 +122,9 @@ class Bounce @return True if the pin changed state. */ - bool update(); + bool update(); + + bool update(bool); /** @brief Returns the pin's state (HIGH or LOW). -- 2.54.0 From 79317fe13489dfcda92c9344c634b2f023c719c6 Mon Sep 17 00:00:00 2001 From: lathoub Date: Sun, 25 Aug 2019 12:00:03 +0200 Subject: [PATCH 02/53] cleanup + comments --- src/Bounce2.h | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/src/Bounce2.h b/src/Bounce2.h index 738bcf6..ce3674e 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -99,7 +99,10 @@ class Bounce void attach(int pin); /** - + @brief current values are provides externally from this library (eg from shifting registred). readDigital can be slow when reading a lot of buttons + + @param currentValue + */ void attach(bool currentValue); @@ -124,10 +127,17 @@ class Bounce bool update(); - bool update(bool); + /*! + @brief "update" the object state value externally. This has to be done as often as possible (that means to include it in your loop()). Only call update() once per loop(). + + @return True if the pin changed state. + */ + bool update(bool currentValue); /** - @brief Returns the pin's state (HIGH or LOW). + @brief Returns the pin's state (HIGH or LOW). + + Do not use when providing values externally @return HIGH or LOW. */ -- 2.54.0 From 01e6fc9398d3a59544c20d6d8000117d6dcd0246 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Sat, 5 Oct 2019 16:14:33 -0400 Subject: [PATCH 03/53] Added a protected changed() function --- src/Bounce2.cpp | 2 +- src/Bounce2.h | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/Bounce2.cpp b/src/Bounce2.cpp index 049452c..1400123 100644 --- a/src/Bounce2.cpp +++ b/src/Bounce2.cpp @@ -104,7 +104,7 @@ bool Bounce::update() #endif - return getStateFlag(CHANGED_STATE); + return changed(); } diff --git a/src/Bounce2.h b/src/Bounce2.h index da3d429..a48f7e9 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -194,6 +194,10 @@ class Bounce inline void unsetStateFlag(const uint8_t flag) {state &= ~flag;} inline void toggleStateFlag(const uint8_t flag) {state ^= flag;} inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);} + + protected: + bool Bounce::changed( ) { return getStateFlag(CHANGED_STATE); } + }; #endif -- 2.54.0 From 220a287467764cc11d3f0f58a038af8d459f4403 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Sun, 6 Oct 2019 13:01:12 -0400 Subject: [PATCH 04/53] Made changed() public instead of protected --- src/Bounce2.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Bounce2.h b/src/Bounce2.h index a48f7e9..a8ee6d6 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -195,7 +195,7 @@ class Bounce inline void toggleStateFlag(const uint8_t flag) {state ^= flag;} inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);} - protected: + public: bool Bounce::changed( ) { return getStateFlag(CHANGED_STATE); } }; -- 2.54.0 From 51032991ac52342d98384baf48cd585dc95f1218 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Thu, 7 Nov 2019 09:33:43 -0500 Subject: [PATCH 05/53] Update Bounce2.h --- src/Bounce2.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/Bounce2.h b/src/Bounce2.h index a8ee6d6..d2ce620 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -26,6 +26,12 @@ Previous contributions by Eric Lowry, Jim Schimpf and Tom Harkaway * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ +/** + * @todo Make Bounce2 more abstract. Split it from the hardware layer. + * @body Remove deboucing code from Bounce2 and make a new Debounce class from that code. Bounce2 should extend Debounce. + */ + + #ifndef Bounce2_h #define Bounce2_h -- 2.54.0 From 6228e0945186079d4535b33354168c38f1baf7cb Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Thu, 21 Nov 2019 22:09:13 -0500 Subject: [PATCH 06/53] Moved literals to header as suggested by MartinNel --- src/Bounce2.cpp | 4 +--- src/Bounce2.h | 4 ++++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/Bounce2.cpp b/src/Bounce2.cpp index 1400123..6509e94 100644 --- a/src/Bounce2.cpp +++ b/src/Bounce2.cpp @@ -3,9 +3,7 @@ #include "Bounce2.h" -static const uint8_t DEBOUNCED_STATE = 0b00000001; -static const uint8_t UNSTABLE_STATE = 0b00000010; -static const uint8_t CHANGED_STATE = 0b00000100; + Bounce::Bounce() diff --git a/src/Bounce2.h b/src/Bounce2.h index d2ce620..e9d05c7 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -69,6 +69,10 @@ Example of two instances of the Bounce class that switches the debug LED when either one of the two buttons is pressed. */ +static const uint8_t DEBOUNCED_STATE = 0b00000001; +static const uint8_t UNSTABLE_STATE = 0b00000010; +static const uint8_t CHANGED_STATE = 0b00000100; + /** The Bounce class. */ -- 2.54.0 From 26e216c98d084e6a7f5d2c2bf703cf4463ec07af Mon Sep 17 00:00:00 2001 From: Damian Wrobel Date: Fri, 22 Nov 2019 17:40:10 +0100 Subject: [PATCH 07/53] Fix compilation error libraries/Bounce2/src/Bounce2.h:209:10: error: extra qualification 'Bounce::' on member 'changed' [-fpermissive] 209 | bool Bounce::changed( ) { return getStateFlag(CHANGED_STATE); } | ^~~~~~ Regression introduced in 01e6fc9398d3a59544c20d6d8000117d6dcd0246 Signed-off-by: Damian Wrobel --- src/Bounce2.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Bounce2.h b/src/Bounce2.h index e9d05c7..6f165b3 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -206,7 +206,7 @@ class Bounce inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);} public: - bool Bounce::changed( ) { return getStateFlag(CHANGED_STATE); } + bool changed( ) { return getStateFlag(CHANGED_STATE); } }; -- 2.54.0 From 14f9c5c4a6bb04187d38d92559f07da6b02d9d7f Mon Sep 17 00:00:00 2001 From: Frederic Pillon Date: Fri, 14 Feb 2020 08:05:43 +0100 Subject: [PATCH 08/53] Generic Arduino_STM32 support When BluePill support have been introduced, it was not enough generic https://github.com/thomasfredericks/Bounce2/pull/35 Board specific definition have been used instead of the generic core one: `ARDUINO_ARCH_STM32F1` --- src/Bounce2.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Bounce2.h b/src/Bounce2.h index 6f165b3..d634890 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -191,7 +191,7 @@ class Bounce unsigned long durationOfPreviousState; virtual bool readCurrentState() { return digitalRead(pin); } virtual void setPinMode(int pin, int mode) { -#if defined(ARDUINO_STM_NUCLEO_F103RB) || defined(ARDUINO_GENERIC_STM32F103C) +#if defined(ARDUINO_ARCH_STM32F1) pinMode(pin, (WiringPinMode)mode); #else pinMode(pin, mode); -- 2.54.0 From a57ba4c66a08c34297722b45aceee188c9c4dd8d Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Wed, 26 Feb 2020 14:41:36 -0500 Subject: [PATCH 09/53] Update library.properties --- library.properties | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/library.properties b/library.properties index 98bea98..b3b9e39 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ name=Bounce2 -version=2.52 +version=2.53 author=Thomas O Fredericks with contributions from Eric Lowry, Jim Schimpf, Tom Harkaway, Joachim Krüger and MrGradgrind. maintainer=Thomas O Fredericks sentence=Debouncing library for Arduino and Wiring. -paragraph=Deboucing switches and toggles is important. +paragraph=Debouncing switches and toggles is important. category=Signal Input/Output url=https://github.com/thomasfredericks/Bounce2 architectures=* -- 2.54.0 From cf32eda85e39ba02be2dc1d8394c58d0e6d8ddc7 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Wed, 26 Feb 2020 14:42:35 -0500 Subject: [PATCH 10/53] v2.53 --- library.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.json b/library.json index 845cd0a..0fc225e 100644 --- a/library.json +++ b/library.json @@ -6,7 +6,7 @@ "type": "git", "url": "https://github.com/thomasfredericks/Bounce2.git" }, - "version": "2.52", + "version": "2.53", "exclude": [ "*.png", "*.zip" -- 2.54.0 From 1af864b0bd6b167a8b63380408ae85540fb117b3 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Tue, 19 May 2020 14:06:37 -0400 Subject: [PATCH 11/53] Added a Button class --- .../bounceMore.ino} | 0 .../bounceTwo.ino} | 0 examples/buttonClass/buttonClass.ino | 61 +++++++++++++++++++ keywords.txt | 6 +- src/Bounce2.h | 48 +++++++++++++++ 5 files changed, 114 insertions(+), 1 deletion(-) rename examples/{bounce_multiple/bounce_multiple.ino => bounceMore/bounceMore.ino} (100%) rename examples/{bounce2buttons/bounce2buttons.ino => bounceTwo/bounceTwo.ino} (100%) create mode 100644 examples/buttonClass/buttonClass.ino diff --git a/examples/bounce_multiple/bounce_multiple.ino b/examples/bounceMore/bounceMore.ino similarity index 100% rename from examples/bounce_multiple/bounce_multiple.ino rename to examples/bounceMore/bounceMore.ino diff --git a/examples/bounce2buttons/bounce2buttons.ino b/examples/bounceTwo/bounceTwo.ino similarity index 100% rename from examples/bounce2buttons/bounce2buttons.ino rename to examples/bounceTwo/bounceTwo.ino diff --git a/examples/buttonClass/buttonClass.ino b/examples/buttonClass/buttonClass.ino new file mode 100644 index 0000000..56d5a57 --- /dev/null +++ b/examples/buttonClass/buttonClass.ino @@ -0,0 +1,61 @@ + + + +/* + DESCRIPTION + ==================== + Simple example of the Button class from the Bounce library. + The Button class matches an electrical state to a physical action. + that switches the debug LED when + either of 2 buttons are pressed. + */ + +// Include the Bounce2 library found here : +// https://github.com/thomasfredericks/Bounce2 +#include + +#define BUTTON_PIN_A 2 +#define BUTTON_PIN_B 3 + + +#define LED_PIN 13 + +// Instantiate a Button object +Button buttonA = Button(); + +// Instantiate another Button object +Button buttonB = Button(); + +void setup() { + + // SETUP BUTTON A + buttonA.attach( BUTTON_PIN_A , INPUT_PULLUP ); + buttonA.interval(5); // interval in ms + buttonA.setPressedState(LOW); // INDICATE THAT THE LOW STATE CORRESPONDS TO PHYSICALLY PRESSING THE BUTTON + + // SETUP BUTTON B + buttonB.attach( BUTTON_PIN_B , INPUT_PULLUP ); + buttonB.interval(5); // interval in ms + buttonB.setPressedState(LOW); // INDICATE THAT THE LOW STATE CORRESPONDS TO PHYSICALLY PRESSING THE BUTTON + + + // SETUP LED + pinMode(LED_PIN,OUTPUT); + +} + +void loop() { + // UPDATE THE BUTTONS + buttonA.update(); + buttonB.update(); + + + // TURN ON LED IF EITHER BUTTON IS PRESSED + if ( buttonA.pressed() || buttonB.pressed() ) { + digitalWrite(LED_PIN, HIGH ); + } + else { + digitalWrite(LED_PIN, LOW ); + } + +} diff --git a/keywords.txt b/keywords.txt index 3269e8f..8f2c4de 100644 --- a/keywords.txt +++ b/keywords.txt @@ -7,7 +7,8 @@ ####################################### Bounce KEYWORD1 -Bounce2 KEYWORD1 +Bounce2 KEYWORD1 +Button KEYWORD1 ####################################### # Methods and Functions (KEYWORD2) @@ -20,6 +21,9 @@ attach KEYWORD2 rose KEYWORD2 fell KEYWORD2 duration KEYWORD2 +pressed KEYWORD2 +released KEYWORD2 +setPressedState KEYWORD2 ####################################### # Instances (KEYWORD2) diff --git a/src/Bounce2.h b/src/Bounce2.h index d634890..c264b21 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -208,6 +208,54 @@ class Bounce public: bool changed( ) { return getStateFlag(CHANGED_STATE); } +}; + +/** + The Button class. + */ +class Button : public Bounce{ +protected: + bool stateForPressed = 0; +public: + /*! + @brief Create an instance of the Button class. + + @code + + // Create an instance of the Button class. + Button() button; + + @endcode +*/ + Button(){ } + + /*! + @brief Set the electrical state (HIGH/LOW) that corresponds to a physical press. + + @param state + The electrical state (HIGH/LOW) that corresponds to a physical press. + +*/ + void setPressedState(bool state){ + stateForPressed = state; + } + + /*! + @brief Returns true if the button was physically pressed +*/ + bool pressed() { + return changed() && (read() == stateForPressed); + }; + + /*! + @brief Returns true if the button was physically released +*/ + bool released() { + return changed() && (read() != stateForPressed); + }; + + + }; #endif -- 2.54.0 From 6147a340581546a4abc62aaaa3e5050dbd8a0ca9 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Thu, 21 May 2020 15:45:52 -0400 Subject: [PATCH 12/53] Changed the default stateForPressed and fixed example --- examples/buttonClass/buttonClass.ino | 10 ++++------ src/Bounce2.h | 6 +++--- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/examples/buttonClass/buttonClass.ino b/examples/buttonClass/buttonClass.ino index 56d5a57..c08bb59 100644 --- a/examples/buttonClass/buttonClass.ino +++ b/examples/buttonClass/buttonClass.ino @@ -18,7 +18,7 @@ #define BUTTON_PIN_B 3 -#define LED_PIN 13 +#define LED_PIN LED_BUILTIN // Instantiate a Button object Button buttonA = Button(); @@ -50,12 +50,10 @@ void loop() { buttonB.update(); - // TURN ON LED IF EITHER BUTTON IS PRESSED + // TOGGLE THE LED IF EITHER BUTTON IS PRESSED if ( buttonA.pressed() || buttonB.pressed() ) { - digitalWrite(LED_PIN, HIGH ); + digitalWrite(LED_PIN, !digitalRead(LED_PIN) ); } - else { - digitalWrite(LED_PIN, LOW ); - } + } diff --git a/src/Bounce2.h b/src/Bounce2.h index c264b21..f266cb2 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -215,10 +215,10 @@ class Bounce */ class Button : public Bounce{ protected: - bool stateForPressed = 0; + bool stateForPressed = 1; // public: /*! - @brief Create an instance of the Button class. + @brief Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical level. @code @@ -230,7 +230,7 @@ public: Button(){ } /*! - @brief Set the electrical state (HIGH/LOW) that corresponds to a physical press. + @brief Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level. @param state The electrical state (HIGH/LOW) that corresponds to a physical press. -- 2.54.0 From 2b6be81dc1c5a86ddf1177f5e9c250dd89adc630 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Thu, 21 May 2020 16:03:08 -0400 Subject: [PATCH 13/53] Updated docs and version number --- docs/files/_bounce2_8h_source.html | 30 ++- docs/files/annotated.html | 1 + docs/files/bounce2buttons_8ino-example.html | 2 +- docs/files/bounce_8ino-example.html | 1 + docs/files/bounce_multiple_8ino-example.html | 2 +- docs/files/class_bounce-members.html | 21 +- docs/files/class_bounce.html | 40 ++- docs/files/class_bounce.png | Bin 0 -> 338 bytes docs/files/class_button-members.html | 103 ++++++++ docs/files/class_button.html | 256 +++++++++++++++++++ docs/files/class_button.png | Bin 0 -> 336 bytes docs/files/classes.html | 6 +- docs/files/functions.html | 15 ++ docs/files/functions_func.html | 15 ++ docs/files/hierarchy.html | 79 ++++++ docs/files/index.html | 2 +- docs/files/menudata.js | 1 + docs/files/search/all_1.js | 1 + docs/files/search/all_5.js | 5 +- docs/files/search/all_6.js | 5 +- docs/files/search/all_7.html | 26 ++ docs/files/search/all_7.js | 4 + docs/files/search/all_8.html | 26 ++ docs/files/search/all_8.js | 4 + docs/files/search/classes_0.js | 3 +- docs/files/search/functions_1.js | 3 +- docs/files/search/functions_5.js | 5 +- docs/files/search/functions_6.js | 5 +- docs/files/search/functions_7.html | 26 ++ docs/files/search/functions_7.js | 4 + docs/files/search/functions_8.html | 26 ++ docs/files/search/functions_8.js | 4 + docs/files/search/searchdata.js | 4 +- docs/files/tabs.css | 2 +- library.json | 2 +- library.properties | 2 +- 36 files changed, 688 insertions(+), 43 deletions(-) create mode 100644 docs/files/class_bounce.png create mode 100644 docs/files/class_button-members.html create mode 100644 docs/files/class_button.html create mode 100644 docs/files/class_button.png create mode 100644 docs/files/hierarchy.html create mode 100644 docs/files/search/all_7.html create mode 100644 docs/files/search/all_7.js create mode 100644 docs/files/search/all_8.html create mode 100644 docs/files/search/all_8.js create mode 100644 docs/files/search/functions_7.html create mode 100644 docs/files/search/functions_7.js create mode 100644 docs/files/search/functions_8.html create mode 100644 docs/files/search/functions_8.js diff --git a/docs/files/_bounce2_8h_source.html b/docs/files/_bounce2_8h_source.html index c8928ec..247b63f 100644 --- a/docs/files/_bounce2_8h_source.html +++ b/docs/files/_bounce2_8h_source.html @@ -66,18 +66,24 @@ $(function() {
Bounce2.h
-
1 /*
2  The MIT License (MIT)
3 
4  Copyright (c) 2013 thomasfredericks
5 
6  Permission is hereby granted, free of charge, to any person obtaining a copy of
7  this software and associated documentation files (the "Software"), to deal in
8  the Software without restriction, including without limitation the rights to
9  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
10  the Software, and to permit persons to whom the Software is furnished to do so,
11  subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in all
14  copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 */
23 
24 /* * * * * * * * * * * * * * * * * * * * * * * * * * * *
25  Main code by Thomas O Fredericks (tof@t-o-f.info)
26  Previous contributions by Eric Lowry, Jim Schimpf and Tom Harkaway
27  * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
28 
29 #ifndef Bounce2_h
30 #define Bounce2_h
31 
32 #if defined(ARDUINO) && ARDUINO >= 100
33 #include "Arduino.h"
34 #else
35 #include "WProgram.h"
36 #endif
37 
38 // Uncomment the following line for "LOCK-OUT" debounce method
39 //#define BOUNCE_LOCK_OUT
40 
41 // Uncomment the following line for "BOUNCE_WITH_PROMPT_DETECTION" debounce method
42 //#define BOUNCE_WITH_PROMPT_DETECTION
43 
44 #include <inttypes.h>
45 
69 class Bounce
70 {
71  public:
72 
83  Bounce();
84 
85 
95  void attach(int pin, int mode);
96 
100  void attach(int pin);
101 
102 
110  void interval(uint16_t interval_millis);
111 
112 
121  bool update();
122 
128  bool read();
129 
133  bool fell();
134 
138  bool rose();
139 
140 
144  bool risingEdge() { return rose(); }
148  bool fallingEdge() { return fell(); }
152  Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
153  attach(pin);
154  interval(interval_millis);
155  }
156 
165  unsigned long duration();
166 
167 
168  // WIP HELD : unsigned long held(); // Returns the duration the previous state was held
169 
170  protected:
171  unsigned long previous_millis;
172  uint16_t interval_millis;
173  uint8_t state;
174  uint8_t pin;
175  unsigned long stateChangeLastTime;
176  // WIP HELD : unsigned long durationOfPreviousState;
177  virtual bool readCurrentState() { return digitalRead(pin); }
178  virtual void setPinMode(int pin, int mode) {
179 #if defined(ARDUINO_STM_NUCLEO_F103RB) || defined(ARDUINO_GENERIC_STM32F103C)
180  pinMode(pin, (WiringPinMode)mode);
181 #else
182  pinMode(pin, mode);
183 #endif
184  }
185 
186  private:
187  inline void changeState();
188  inline void setStateFlag(const uint8_t flag) {state |= flag;}
189  inline void unsetStateFlag(const uint8_t flag) {state &= ~flag;}
190  inline void toggleStateFlag(const uint8_t flag) {state ^= flag;}
191  inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);}
192 };
193 
194 #endif
Bounce
Definition: Bounce2.h:69
-
Bounce::read
bool read()
Returns the pin&#39;s state (HIGH or LOW).
Definition: Bounce2.cpp:127
-
Bounce::interval
void interval(uint16_t interval_millis)
Sets the debounce interval in milliseconds.
Definition: Bounce2.cpp:36
-
Bounce::fallingEdge
bool fallingEdge()
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:148
-
Bounce::attach
void attach(int pin, int mode)
Attach to a pin and sets that pin&#39;s mode (INPUT, INPUT_PULLUP or OUTPUT).
Definition: Bounce2.cpp:31
-
Bounce::fell
bool fell()
Returns true if pin signal transitions from high to low.
Definition: Bounce2.cpp:137
-
Bounce::update
bool update()
Updates the pin&#39;s state.
Definition: Bounce2.cpp:41
-
Bounce::risingEdge
bool risingEdge()
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:144
-
Bounce::duration
unsigned long duration()
Returns the duration in milliseconds of the current state.
Definition: Bounce2.cpp:116
-
Bounce::Bounce
Bounce(uint8_t pin, unsigned long interval_millis)
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:152
-
Bounce::Bounce
Bounce()
Create an instance of the Bounce class.
Definition: Bounce2.cpp:11
-
Bounce::rose
bool rose()
Returns true if pin signal transitions from low to high.
Definition: Bounce2.cpp:132
+
1 /*
2  The MIT License (MIT)
3 
4  Copyright (c) 2013 thomasfredericks
5 
6  Permission is hereby granted, free of charge, to any person obtaining a copy of
7  this software and associated documentation files (the "Software"), to deal in
8  the Software without restriction, including without limitation the rights to
9  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
10  the Software, and to permit persons to whom the Software is furnished to do so,
11  subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in all
14  copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 */
23 
24 /* * * * * * * * * * * * * * * * * * * * * * * * * * * *
25  Main code by Thomas O Fredericks (tof@t-o-f.info)
26  Previous contributions by Eric Lowry, Jim Schimpf and Tom Harkaway
27  * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
28 
35 #ifndef Bounce2_h
36 #define Bounce2_h
37 
38 #if defined(ARDUINO) && ARDUINO >= 100
39 #include "Arduino.h"
40 #else
41 #include "WProgram.h"
42 #endif
43 
44 // Uncomment the following line for "LOCK-OUT" debounce method
45 //#define BOUNCE_LOCK_OUT
46 
47 // Uncomment the following line for "BOUNCE_WITH_PROMPT_DETECTION" debounce method
48 //#define BOUNCE_WITH_PROMPT_DETECTION
49 
50 #include <inttypes.h>
51 
72 static const uint8_t DEBOUNCED_STATE = 0b00000001;
73 static const uint8_t UNSTABLE_STATE = 0b00000010;
74 static const uint8_t CHANGED_STATE = 0b00000100;
75 
79 class Bounce
80 {
81  public:
82 
93  Bounce();
94 
95 
104  void attach(int pin, int mode);
105 
109  void attach(int pin);
110 
111 
119  void interval(uint16_t interval_millis);
120 
121 
130  bool update();
131 
137  bool read();
138 
142  bool fell();
143 
147  bool rose();
148 
149 
153  bool risingEdge() { return rose(); }
157  bool fallingEdge() { return fell(); }
161  Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
162  attach(pin);
163  interval(interval_millis);
164  }
165 
174  unsigned long duration();
175 
183  unsigned long previousDuration();
184 
185  protected:
186  unsigned long previous_millis;
187  uint16_t interval_millis;
188  uint8_t state;
189  uint8_t pin;
190  unsigned long stateChangeLastTime;
191  unsigned long durationOfPreviousState;
192  virtual bool readCurrentState() { return digitalRead(pin); }
193  virtual void setPinMode(int pin, int mode) {
194 #if defined(ARDUINO_ARCH_STM32F1)
195  pinMode(pin, (WiringPinMode)mode);
196 #else
197  pinMode(pin, mode);
198 #endif
199  }
200 
201  private:
202  inline void changeState();
203  inline void setStateFlag(const uint8_t flag) {state |= flag;}
204  inline void unsetStateFlag(const uint8_t flag) {state &= ~flag;}
205  inline void toggleStateFlag(const uint8_t flag) {state ^= flag;}
206  inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);}
207 
208  public:
209  bool changed( ) { return getStateFlag(CHANGED_STATE); }
210 
211 };
212 
216 class Button : public Bounce{
217 protected:
218  bool stateForPressed = 1; //
219 public:
230  Button(){ }
231 
239  void setPressedState(bool state){
240  stateForPressed = state;
241  }
242 
246  bool pressed() {
247  return changed() && (read() == stateForPressed);
248  };
249 
253  bool released() {
254  return changed() && (read() != stateForPressed);
255  };
256 
257 
258 
259 };
260 
261 #endif
Button::pressed
bool pressed()
Returns true if the button was physically pressed.
Definition: Bounce2.h:246
+
Bounce
Definition: Bounce2.h:79
+
Bounce::read
bool read()
Returns the pin&#39;s state (HIGH or LOW).
Definition: Bounce2.cpp:125
+
Bounce::interval
void interval(uint16_t interval_millis)
Sets the debounce interval in milliseconds.
Definition: Bounce2.cpp:34
+
Button::released
bool released()
Returns true if the button was physically released.
Definition: Bounce2.h:253
+
Bounce::previousDuration
unsigned long previousDuration()
Returns the duration in milliseconds of the previous state.
Definition: Bounce2.cpp:110
+
Bounce::fallingEdge
bool fallingEdge()
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:157
+
Bounce::attach
void attach(int pin, int mode)
Attach to a pin and sets that pin&#39;s mode (INPUT, INPUT_PULLUP or OUTPUT).
Definition: Bounce2.cpp:29
+
Bounce::fell
bool fell()
Returns true if pin signal transitions from high to low.
Definition: Bounce2.cpp:135
+
Bounce::update
bool update()
Updates the pin&#39;s state.
Definition: Bounce2.cpp:39
+
Bounce::risingEdge
bool risingEdge()
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:153
+
Button::setPressedState
void setPressedState(bool state)
Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level.
Definition: Bounce2.h:239
+
Bounce::duration
unsigned long duration()
Returns the duration in milliseconds of the current state.
Definition: Bounce2.cpp:114
+
Bounce::Bounce
Bounce(uint8_t pin, unsigned long interval_millis)
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:161
+
Button
Definition: Bounce2.h:216
+
Bounce::Bounce
Bounce()
Create an instance of the Bounce class.
Definition: Bounce2.cpp:9
+
Bounce::rose
bool rose()
Returns true if pin signal transitions from low to high.
Definition: Bounce2.cpp:130
+
Button::Button
Button()
Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical...
Definition: Bounce2.h:230
diff --git a/docs/files/annotated.html b/docs/files/annotated.html index 0d4b415..09c0f48 100644 --- a/docs/files/annotated.html +++ b/docs/files/annotated.html @@ -65,6 +65,7 @@ $(function() {
Here are the classes, structs, unions and interfaces with brief descriptions:
+
 CBounce
 CButton
diff --git a/docs/files/bounce2buttons_8ino-example.html b/docs/files/bounce2buttons_8ino-example.html index 1f7591d..7199c94 100644 --- a/docs/files/bounce2buttons_8ino-example.html +++ b/docs/files/bounce2buttons_8ino-example.html @@ -63,7 +63,7 @@ $(function() {

Example of two instances of the Bounce class that switches the debug LED when either one of the two buttons is pressed.

-
/*
DESCRIPTION
====================
Simple example of the Bounce library that switches the debug LED when
either of 2 buttons are pressed.
*/
// Include the Bounce2 library found here :
// https://github.com/thomasfredericks/Bounce2
#include <Bounce2.h>
#define BUTTON_PIN_1 2
#define BUTTON_PIN_2 3
#define LED_PIN 13
// Instantiate a Bounce object
Bounce debouncer1 = Bounce();
// Instantiate another Bounce object
Bounce debouncer2 = Bounce();
void setup() {
// Setup the first button with an internal pull-up :
pinMode(BUTTON_PIN_1,INPUT_PULLUP);
// After setting up the button, setup the Bounce instance :
debouncer1.attach(BUTTON_PIN_1);
debouncer1.interval(5); // interval in ms
// Setup the second button with an internal pull-up :
pinMode(BUTTON_PIN_2,INPUT_PULLUP);
// After setting up the button, setup the Bounce instance :
debouncer2.attach(BUTTON_PIN_2);
debouncer2.interval(5); // interval in ms
//Setup the LED :
pinMode(LED_PIN,OUTPUT);
}
void loop() {
// Update the Bounce instances :
debouncer1.update();
debouncer2.update();
// Get the updated value :
int value1 = debouncer1.read();
int value2 = debouncer2.read();
// Turn on the LED if either button is pressed :
if ( value1 == LOW || value2 == LOW ) {
digitalWrite(LED_PIN, HIGH );
}
else {
digitalWrite(LED_PIN, LOW );
}
}
+
Generated by   diff --git a/docs/files/bounce_8ino-example.html b/docs/files/bounce_8ino-example.html index ea9dc68..a280419 100644 --- a/docs/files/bounce_8ino-example.html +++ b/docs/files/bounce_8ino-example.html @@ -62,6 +62,7 @@ $(function() {
bounce.ino
+
Todo:
Make Bounce2 more abstract. Split it from the hardware layer. Remove deboucing code from Bounce2 and make a new Debounce class from that code. Bounce2 should extend Debounce.

Simple example of the Bounce library that switches the debug LED when a button is pressed.

/*
DESCRIPTION
====================
Simple example of the Bounce library that switches the debug LED when a button is pressed.
*/
// Include the Bounce2 library found here :
// https://github.com/thomasfredericks/Bounce2
#include <Bounce2.h>
#define BUTTON_PIN 2
#define LED_PIN 13
// Instantiate a Bounce object
Bounce debouncer = Bounce();
void setup() {
// Setup the button with an internal pull-up :
pinMode(BUTTON_PIN,INPUT_PULLUP);
// After setting up the button, setup the Bounce instance :
debouncer.attach(BUTTON_PIN);
debouncer.interval(5); // interval in ms
//Setup the LED :
pinMode(LED_PIN,OUTPUT);
}
void loop() {
// Update the Bounce instance :
debouncer.update();
// Get the updated value :
int value = debouncer.read();
// Turn on or off the LED as determined by the state :
if ( value == LOW ) {
digitalWrite(LED_PIN, HIGH );
}
else {
digitalWrite(LED_PIN, LOW );
}
}
diff --git a/docs/files/bounce_multiple_8ino-example.html b/docs/files/bounce_multiple_8ino-example.html index 8a8b2e0..09a464c 100644 --- a/docs/files/bounce_multiple_8ino-example.html +++ b/docs/files/bounce_multiple_8ino-example.html @@ -63,7 +63,7 @@ $(function() {

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

-
// 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
// Include the Bounce2 library found here :
// https://github.com/thomasfredericks/Bounce2
#include <Bounce2.h>
#define LED_PIN 13
#define NUM_BUTTONS 8
const uint8_t BUTTON_PINS[NUM_BUTTONS] = {2, 3, 4, 5, 6, 7, 8, 9};
int ledState = LOW;
Bounce * buttons = new Bounce[NUM_BUTTONS];
void setup() {
for (int i = 0; i < NUM_BUTTONS; i++) {
buttons[i].attach( BUTTON_PINS[i] , INPUT_PULLUP ); //setup the bounce instance for the current button
buttons[i].interval(25); // interval in ms
}
// Setup the LED :
pinMode(LED_PIN, OUTPUT);
digitalWrite(LED_PIN, ledState);
}
void loop() {
bool needToToggleLed = false;
for (int i = 0; i < NUM_BUTTONS; i++) {
// Update the Bounce instance :
buttons[i].update();
// If it fell, flag the need to toggle the LED
if ( buttons[i].fell() ) {
needToToggleLed = true;
}
}
// if a LED toggle has been flagged :
if ( needToToggleLed ) {
// Toggle LED state :
ledState = !ledState;
digitalWrite(LED_PIN, ledState);
}
}
+
Generated by   diff --git a/docs/files/class_bounce-members.html b/docs/files/class_bounce-members.html index f9f958e..5ef7e6b 100644 --- a/docs/files/class_bounce-members.html +++ b/docs/files/class_bounce-members.html @@ -69,21 +69,24 @@ $(function() { attach(int pin)Bounce Bounce()Bounce Bounce(uint8_t pin, unsigned long interval_millis)Bounceinline - duration()Bounce + changed() (defined in Bounce)Bounceinline + duration()Bounce + durationOfPreviousState (defined in Bounce)Bounceprotected fallingEdge()Bounceinline fell()Bounce interval(uint16_t interval_millis)Bounce interval_millis (defined in Bounce)Bounceprotected pin (defined in Bounce)Bounceprotected previous_millis (defined in Bounce)Bounceprotected - read()Bounce - readCurrentState() (defined in Bounce)Bounceinlineprotectedvirtual - risingEdge()Bounceinline - rose()Bounce - setPinMode(int pin, int mode) (defined in Bounce)Bounceinlineprotectedvirtual - state (defined in Bounce)Bounceprotected - stateChangeLastTime (defined in Bounce)Bounceprotected - update()Bounce + previousDuration()Bounce + read()Bounce + readCurrentState() (defined in Bounce)Bounceinlineprotectedvirtual + risingEdge()Bounceinline + rose()Bounce + setPinMode(int pin, int mode) (defined in Bounce)Bounceinlineprotectedvirtual + state (defined in Bounce)Bounceprotected + stateChangeLastTime (defined in Bounce)Bounceprotected + update()Bounce
diff --git a/docs/files/class_bounce.html b/docs/files/class_bounce.html index 6fa2144..860a0fc 100644 --- a/docs/files/class_bounce.html +++ b/docs/files/class_bounce.html @@ -69,6 +69,15 @@ $(function() {

#include <Bounce2.h>

+
+Inheritance diagram for Bounce:
+
+
+ + +Button + +
@@ -112,6 +121,12 @@ bool  + + + + +

Public Member Functions

unsigned long duration ()
 Returns the duration in milliseconds of the current state. More...
 
unsigned long previousDuration ()
 Returns the duration in milliseconds of the previous state. More...
 
+bool changed ()
 
@@ -139,6 +154,9 @@ uint8_t  + +

Protected Member Functions

pin
unsigned long stateChangeLastTime
 
+unsigned long durationOfPreviousState
 

Detailed Description

The Bounce class.

@@ -197,7 +215,6 @@ unsigned long stateChangeL -
Returns
True if the event read was successful, otherwise false.
@@ -265,6 +282,27 @@ unsigned long stateChangeL + + + +

◆ previousDuration()

+ +
+
+ + + + + + + +
unsigned long Bounce::previousDuration ()
+
+ +

Returns the duration in milliseconds of the previous state.

+

Takes the values of duration() once the pin changes state.

+
Returns
The duration in milliseconds (unsigned long) of the previous state.
+
diff --git a/docs/files/class_bounce.png b/docs/files/class_bounce.png new file mode 100644 index 0000000000000000000000000000000000000000..6b25225acc77ba1a65cf50a89b02857df8aea48e GIT binary patch literal 338 zcmeAS@N?(olHy`uVBq!ia0vp^=0F_4!3-q3zQ|4kQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;jpt9tj}_@sqp78tgUq-uRYc-^U)gvU0kB_n%q& z*PQ!)*jsh(*Dt5{PPsedySLuUXO_{=YczNLK3g`Afmw%t!4u|rGjCcj=$bWfs_o64 zEv&vbcD7LZ-tEtK+B9&TX4Z(5b2#~l!Rue^^LO_Wip%pGye}EVKaKoxXWMaQPt~2} zy2WuT#CEse{V08C-+AxzfuG)8{kba6?2yC$>s8M!=HC1K|MvA4_de%TPr7pQlgdh< db-RCC@Xv1MnVt~sED7{1gQu&X%Q~loCIAn}mwx~N literal 0 HcmV?d00001 diff --git a/docs/files/class_button-members.html b/docs/files/class_button-members.html new file mode 100644 index 0000000..fcd5ae4 --- /dev/null +++ b/docs/files/class_button-members.html @@ -0,0 +1,103 @@ + + + + + + + +Bounce2: Member List + + + + + + + + + +
+
+ + + + + + +
+
Bounce2 +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
Button Member List
+
+
+ +

This is the complete list of members for Button, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
attach(int pin, int mode)Bounce
attach(int pin)Bounce
Bounce()Bounce
Bounce(uint8_t pin, unsigned long interval_millis)Bounceinline
Button()Buttoninline
changed() (defined in Bounce)Bounceinline
duration()Bounce
durationOfPreviousState (defined in Bounce)Bounceprotected
fallingEdge()Bounceinline
fell()Bounce
interval(uint16_t interval_millis)Bounce
interval_millis (defined in Bounce)Bounceprotected
pin (defined in Bounce)Bounceprotected
pressed()Buttoninline
previous_millis (defined in Bounce)Bounceprotected
previousDuration()Bounce
read()Bounce
readCurrentState() (defined in Bounce)Bounceinlineprotectedvirtual
released()Buttoninline
risingEdge()Bounceinline
rose()Bounce
setPinMode(int pin, int mode) (defined in Bounce)Bounceinlineprotectedvirtual
setPressedState(bool state)Buttoninline
state (defined in Bounce)Bounceprotected
stateChangeLastTime (defined in Bounce)Bounceprotected
stateForPressed (defined in Button)Buttonprotected
update()Bounce
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/docs/files/class_button.html b/docs/files/class_button.html new file mode 100644 index 0000000..279efa9 --- /dev/null +++ b/docs/files/class_button.html @@ -0,0 +1,256 @@ + + + + + + + +Bounce2: Button Class Reference + + + + + + + + + +
+
+ + + + + + +
+
Bounce2 +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
Button Class Reference
+
+
+ +

#include <Bounce2.h>

+
+Inheritance diagram for Button:
+
+
+ + +Bounce + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Button ()
 Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical level. More...
 
void setPressedState (bool state)
 Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level. More...
 
+bool pressed ()
 Returns true if the button was physically pressed.
 
+bool released ()
 Returns true if the button was physically released.
 
- Public Member Functions inherited from Bounce
 Bounce ()
 Create an instance of the Bounce class. More...
 
void attach (int pin, int mode)
 Attach to a pin and sets that pin's mode (INPUT, INPUT_PULLUP or OUTPUT). More...
 
void attach (int pin)
 
void interval (uint16_t interval_millis)
 Sets the debounce interval in milliseconds. More...
 
bool update ()
 Updates the pin's state. More...
 
bool read ()
 Returns the pin's state (HIGH or LOW). More...
 
+bool fell ()
 Returns true if pin signal transitions from high to low.
 
+bool rose ()
 Returns true if pin signal transitions from low to high.
 
+bool risingEdge ()
 Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1.
 
+bool fallingEdge ()
 Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1.
 
+ Bounce (uint8_t pin, unsigned long interval_millis)
 Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1.
 
unsigned long duration ()
 Returns the duration in milliseconds of the current state. More...
 
unsigned long previousDuration ()
 Returns the duration in milliseconds of the previous state. More...
 
+bool changed ()
 
+ + + + + + + + + + + + + + + + +

+Protected Attributes

+bool stateForPressed = 1
 
- Protected Attributes inherited from Bounce
+unsigned long previous_millis
 
+uint16_t interval_millis
 
+uint8_t state
 
+uint8_t pin
 
+unsigned long stateChangeLastTime
 
+unsigned long durationOfPreviousState
 
+ + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from Bounce
+virtual bool readCurrentState ()
 
+virtual void setPinMode (int pin, int mode)
 
+

Detailed Description

+

The Button class.

+

Constructor & Destructor Documentation

+ +

◆ Button()

+ +
+
+ + + + + +
+ + + + + + + +
Button::Button ()
+ 		+inline
+
+ +

Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical level.

+
// Create an instance of the Button class.
Button() button;
+
+
+

Member Function Documentation

+ +

◆ setPressedState()

+ +
+
+ + + + + +
+ + + + + + + + +
void Button::setPressedState (bool state)
+ 		+inline
+
+ +

Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level.

+
Parameters
+ + +
stateThe electrical state (HIGH/LOW) that corresponds to a physical press.
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by   +doxygen + 1.8.13 +
+ + diff --git a/docs/files/class_button.png b/docs/files/class_button.png new file mode 100644 index 0000000000000000000000000000000000000000..9bf3853b54f3155d3495a6b924ba97d9e12853f0 GIT binary patch literal 336 zcmeAS@N?(olHy`uVBq!ia0vp^=0F_4!3-q3zQ|4kQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;^J@9yI8$>~;@?iaceZl>m!)scY~{Tc9#wv~^1i?4tc1!*S3WVFzgsKUU~SgG z;Fy0qDe1!PtrH}^{@XkMH1mrMHVxCBGH%h~U+`4d#&|P>!~qler%T;puf6-f<=Z*M zXR?LyCthBb?E5(*yzc(ObNAM+e;umo^Q3y+^wW}G>h8t=y3_yh()nusgb6@X_8c%a cp8cGAsV`64UhQA^fL>+rboFyt=akR{0Q`fQsQ>@~ literal 0 HcmV?d00001 diff --git a/docs/files/classes.html b/docs/files/classes.html index b92cd05..30d1f43 100644 --- a/docs/files/classes.html +++ b/docs/files/classes.html @@ -65,10 +65,10 @@ $(function() {
b
- - + + +
  b  
-
Bounce   
Button   
Bounce   
b
diff --git a/docs/files/functions.html b/docs/files/functions.html index 9e9dc30..a63fe10 100644 --- a/docs/files/functions.html +++ b/docs/files/functions.html @@ -65,6 +65,9 @@ $(function() {
  • Bounce() : Bounce
    • +
  • Button() +: Button +
  • duration() : Bounce
    • @@ -77,15 +80,27 @@ $(function() {
  • interval() : Bounce
    • +
  • pressed() +: Button +
    • +
  • previousDuration() +: Bounce +
  • read() : Bounce
    • +
  • released() +: Button +
  • risingEdge() : Bounce
  • rose() : Bounce
    • +
  • setPressedState() +: Button +
  • update() : Bounce
    • diff --git a/docs/files/functions_func.html b/docs/files/functions_func.html index 5014d1f..cd80b54 100644 --- a/docs/files/functions_func.html +++ b/docs/files/functions_func.html @@ -65,6 +65,9 @@ $(function() {
  • Bounce() : Bounce
    • +
  • Button() +: Button +
  • duration() : Bounce
    • @@ -77,15 +80,27 @@ $(function() {
  • interval() : Bounce
    • +
  • pressed() +: Button +
    • +
  • previousDuration() +: Bounce +
  • read() : Bounce
    • +
  • released() +: Button +
  • risingEdge() : Bounce
  • rose() : Bounce
    • +
  • setPressedState() +: Button +
  • update() : Bounce
    • diff --git a/docs/files/hierarchy.html b/docs/files/hierarchy.html new file mode 100644 index 0000000..9e5fff8 --- /dev/null +++ b/docs/files/hierarchy.html @@ -0,0 +1,79 @@ + + + + + + + +Bounce2: Class Hierarchy + + + + + + + + + +
    +
    + + + + + + +
    +
    Bounce2 +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    Class Hierarchy
    +
    +
    +
    This inheritance list is sorted roughly, but not completely, alphabetically:
    +
    [detail level 12]
    + + +
     ▼CBounce
     CButton
    +
    +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/files/index.html b/docs/files/index.html index aab90bb..92571cc 100644 --- a/docs/files/index.html +++ b/docs/files/index.html @@ -86,7 +86,7 @@ $(function() {

    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.

    +

    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.
      • diff --git a/docs/files/menudata.js b/docs/files/menudata.js index 5e01a33..ccb591d 100644 --- a/docs/files/menudata.js +++ b/docs/files/menudata.js @@ -3,6 +3,7 @@ var menudata={children:[ {text:"Classes",url:"annotated.html",children:[ {text:"Class List",url:"annotated.html"}, {text:"Class Index",url:"classes.html"}, +{text:"Class Hierarchy",url:"hierarchy.html"}, {text:"Class Members",url:"functions.html",children:[ {text:"All",url:"functions.html"}, {text:"Functions",url:"functions_func.html"}]}]}, diff --git a/docs/files/search/all_1.js b/docs/files/search/all_1.js index 52e20e5..fe8b316 100644 --- a/docs/files/search/all_1.js +++ b/docs/files/search/all_1.js @@ -1,5 +1,6 @@ var searchData= [ ['bounce',['Bounce',['../class_bounce.html',1,'Bounce'],['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce::Bounce()'],['../class_bounce.html#ab34517094faf21d4f38b36da2915132b',1,'Bounce::Bounce(uint8_t pin, unsigned long interval_millis)']]], + ['button',['Button',['../class_button.html',1,'Button'],['../class_button.html#a3b36df1ae23c58aedb9e15a713159459',1,'Button::Button()']]], ['bounce_202',['BOUNCE 2',['../index.html',1,'']]] ]; diff --git a/docs/files/search/all_5.js b/docs/files/search/all_5.js index 81afa51..7f6ad53 100644 --- a/docs/files/search/all_5.js +++ b/docs/files/search/all_5.js @@ -1,6 +1,5 @@ var searchData= [ - ['read',['read',['../class_bounce.html#ae1936fdf44501992707e6cbaee9bbc76',1,'Bounce']]], - ['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], - ['rose',['rose',['../class_bounce.html#a9e4187934576e568cdfa8f94efeff6f2',1,'Bounce']]] + ['pressed',['pressed',['../class_button.html#a8e37fb754907685539ea71183204b033',1,'Button']]], + ['previousduration',['previousDuration',['../class_bounce.html#ad6226be8000f4cec9f2c997a5bc98a9c',1,'Bounce']]] ]; diff --git a/docs/files/search/all_6.js b/docs/files/search/all_6.js index 5223992..8a397ef 100644 --- a/docs/files/search/all_6.js +++ b/docs/files/search/all_6.js @@ -1,4 +1,7 @@ var searchData= [ - ['update',['update',['../class_bounce.html#ab36d7b83bf32e0935a0c2c6a05096441',1,'Bounce']]] + ['read',['read',['../class_bounce.html#ae1936fdf44501992707e6cbaee9bbc76',1,'Bounce']]], + ['released',['released',['../class_button.html#a0b3d2033eb8a6e93141e0b2d8375e9dd',1,'Button']]], + ['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], + ['rose',['rose',['../class_bounce.html#a9e4187934576e568cdfa8f94efeff6f2',1,'Bounce']]] ]; diff --git a/docs/files/search/all_7.html b/docs/files/search/all_7.html new file mode 100644 index 0000000..de19107 --- /dev/null +++ b/docs/files/search/all_7.html @@ -0,0 +1,26 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/files/search/all_7.js b/docs/files/search/all_7.js new file mode 100644 index 0000000..0349e22 --- /dev/null +++ b/docs/files/search/all_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['setpressedstate',['setPressedState',['../class_button.html#aa58da793c244339b781349cf9af544d5',1,'Button']]] +]; diff --git a/docs/files/search/all_8.html b/docs/files/search/all_8.html new file mode 100644 index 0000000..11e27cd --- /dev/null +++ b/docs/files/search/all_8.html @@ -0,0 +1,26 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/files/search/all_8.js b/docs/files/search/all_8.js new file mode 100644 index 0000000..5223992 --- /dev/null +++ b/docs/files/search/all_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['update',['update',['../class_bounce.html#ab36d7b83bf32e0935a0c2c6a05096441',1,'Bounce']]] +]; diff --git a/docs/files/search/classes_0.js b/docs/files/search/classes_0.js index ecd765e..d1d6328 100644 --- a/docs/files/search/classes_0.js +++ b/docs/files/search/classes_0.js @@ -1,4 +1,5 @@ var searchData= [ - ['bounce',['Bounce',['../class_bounce.html',1,'']]] + ['bounce',['Bounce',['../class_bounce.html',1,'']]], + ['button',['Button',['../class_button.html',1,'']]] ]; diff --git a/docs/files/search/functions_1.js b/docs/files/search/functions_1.js index b46f930..56ab44e 100644 --- a/docs/files/search/functions_1.js +++ b/docs/files/search/functions_1.js @@ -1,4 +1,5 @@ var searchData= [ - ['bounce',['Bounce',['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce::Bounce()'],['../class_bounce.html#ab34517094faf21d4f38b36da2915132b',1,'Bounce::Bounce(uint8_t pin, unsigned long interval_millis)']]] + ['bounce',['Bounce',['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce::Bounce()'],['../class_bounce.html#ab34517094faf21d4f38b36da2915132b',1,'Bounce::Bounce(uint8_t pin, unsigned long interval_millis)']]], + ['button',['Button',['../class_button.html#a3b36df1ae23c58aedb9e15a713159459',1,'Button']]] ]; diff --git a/docs/files/search/functions_5.js b/docs/files/search/functions_5.js index 81afa51..7f6ad53 100644 --- a/docs/files/search/functions_5.js +++ b/docs/files/search/functions_5.js @@ -1,6 +1,5 @@ var searchData= [ - ['read',['read',['../class_bounce.html#ae1936fdf44501992707e6cbaee9bbc76',1,'Bounce']]], - ['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], - ['rose',['rose',['../class_bounce.html#a9e4187934576e568cdfa8f94efeff6f2',1,'Bounce']]] + ['pressed',['pressed',['../class_button.html#a8e37fb754907685539ea71183204b033',1,'Button']]], + ['previousduration',['previousDuration',['../class_bounce.html#ad6226be8000f4cec9f2c997a5bc98a9c',1,'Bounce']]] ]; diff --git a/docs/files/search/functions_6.js b/docs/files/search/functions_6.js index 5223992..8a397ef 100644 --- a/docs/files/search/functions_6.js +++ b/docs/files/search/functions_6.js @@ -1,4 +1,7 @@ var searchData= [ - ['update',['update',['../class_bounce.html#ab36d7b83bf32e0935a0c2c6a05096441',1,'Bounce']]] + ['read',['read',['../class_bounce.html#ae1936fdf44501992707e6cbaee9bbc76',1,'Bounce']]], + ['released',['released',['../class_button.html#a0b3d2033eb8a6e93141e0b2d8375e9dd',1,'Button']]], + ['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], + ['rose',['rose',['../class_bounce.html#a9e4187934576e568cdfa8f94efeff6f2',1,'Bounce']]] ]; diff --git a/docs/files/search/functions_7.html b/docs/files/search/functions_7.html new file mode 100644 index 0000000..83a7b84 --- /dev/null +++ b/docs/files/search/functions_7.html @@ -0,0 +1,26 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/files/search/functions_7.js b/docs/files/search/functions_7.js new file mode 100644 index 0000000..0349e22 --- /dev/null +++ b/docs/files/search/functions_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['setpressedstate',['setPressedState',['../class_button.html#aa58da793c244339b781349cf9af544d5',1,'Button']]] +]; diff --git a/docs/files/search/functions_8.html b/docs/files/search/functions_8.html new file mode 100644 index 0000000..b55f0e6 --- /dev/null +++ b/docs/files/search/functions_8.html @@ -0,0 +1,26 @@ + + + + + + + + + +
      +
      Loading...
      +
      + +
      Searching...
      +
      No Matches
      + +
      + + diff --git a/docs/files/search/functions_8.js b/docs/files/search/functions_8.js new file mode 100644 index 0000000..5223992 --- /dev/null +++ b/docs/files/search/functions_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['update',['update',['../class_bounce.html#ab36d7b83bf32e0935a0c2c6a05096441',1,'Bounce']]] +]; diff --git a/docs/files/search/searchdata.js b/docs/files/search/searchdata.js index 62b8bee..2e0e516 100644 --- a/docs/files/search/searchdata.js +++ b/docs/files/search/searchdata.js @@ -1,8 +1,8 @@ var indexSectionsWithContent = { - 0: "abdfiru", + 0: "abdfiprsu", 1: "b", - 2: "abdfiru", + 2: "abdfiprsu", 3: "b" }; diff --git a/docs/files/tabs.css b/docs/files/tabs.css index a28614b..bbde11e 100644 --- a/docs/files/tabs.css +++ b/docs/files/tabs.css @@ -1 +1 @@ -.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}#doc-content{overflow:auto;display:block;padding:0;margin:0;-webkit-overflow-scrolling:touch}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace!important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0!important;-webkit-border-radius:0;border-radius:0!important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px!important;-webkit-border-radius:5px;border-radius:5px!important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0!important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px!important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file +.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:transparent}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0px/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0px 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0px 1px 1px rgba(255,255,255,0.9);color:#283A5D;outline:none}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox a.current{color:#D23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media (min-width: 768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283A5D transparent transparent transparent;background:transparent;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0px 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox a:hover span.sub-arrow{border-color:#fff transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;border-radius:5px !important;box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:#fff;text-shadow:0px 1px 1px #000}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent #fff}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #D23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#D23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} diff --git a/library.json b/library.json index 0fc225e..7a688f8 100644 --- a/library.json +++ b/library.json @@ -6,7 +6,7 @@ "type": "git", "url": "https://github.com/thomasfredericks/Bounce2.git" }, - "version": "2.53", + "version": "2.54", "exclude": [ "*.png", "*.zip" diff --git a/library.properties b/library.properties index b3b9e39..421b2da 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=Bounce2 -version=2.53 +version=2.54 author=Thomas O Fredericks with contributions from Eric Lowry, Jim Schimpf, Tom Harkaway, Joachim Krüger and MrGradgrind. maintainer=Thomas O Fredericks sentence=Debouncing library for Arduino and Wiring. -- 2.54.0 From 1a6552ffe539378f8c8756529606081f8b3da251 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Thu, 6 Aug 2020 13:34:56 -0400 Subject: [PATCH 14/53] New Debouncer class split from the hardware layer --- src/Bounce2.cpp | 73 +++++++++------ src/Bounce2.h | 240 ++++++++++++++++++++++++++++-------------------- 2 files changed, 183 insertions(+), 130 deletions(-) diff --git a/src/Bounce2.cpp b/src/Bounce2.cpp index 6509e94..18225c3 100644 --- a/src/Bounce2.cpp +++ b/src/Bounce2.cpp @@ -3,40 +3,33 @@ #include "Bounce2.h" +////////////// +// DEBOUNCE // +////////////// - - -Bounce::Bounce() - : previous_millis(0) +Debouncer::Debouncer():previous_millis(0) , interval_millis(10) - , state(0) - , pin(0) -{} + , state(0) {} -void Bounce::attach(int pin) { - this->pin = pin; - state = 0; +void Debouncer::interval(uint16_t interval_millis) +{ + this->interval_millis = interval_millis; +} + +void Debouncer::begin() { + state = 0; if (readCurrentState()) { setStateFlag(DEBOUNCED_STATE | UNSTABLE_STATE); } -#ifdef BOUNCE_LOCK_OUT + + #ifdef BOUNCE_LOCK_OUT previous_millis = 0; #else previous_millis = millis(); #endif } -void Bounce::attach(int pin, int mode){ - setPinMode(pin, mode); - this->attach(pin); -} - -void Bounce::interval(uint16_t interval_millis) -{ - this->interval_millis = interval_millis; -} - -bool Bounce::update() +bool Debouncer::update() { unsetStateFlag(CHANGED_STATE); @@ -107,32 +100,56 @@ bool Bounce::update() } // WIP HELD -unsigned long Bounce::previousDuration() { +unsigned long Debouncer::previousDuration() { return durationOfPreviousState; } -unsigned long Bounce::duration() { +unsigned long Debouncer::duration() { return (millis() - stateChangeLastTime); } -inline void Bounce::changeState() { +inline void Debouncer::changeState() { toggleStateFlag(DEBOUNCED_STATE); setStateFlag(CHANGED_STATE) ; durationOfPreviousState = millis() - stateChangeLastTime; stateChangeLastTime = millis(); } -bool Bounce::read() +bool Debouncer::read() { return getStateFlag(DEBOUNCED_STATE); } -bool Bounce::rose() +bool Debouncer::rose() { return getStateFlag(DEBOUNCED_STATE) && getStateFlag(CHANGED_STATE); } -bool Bounce::fell() +bool Debouncer::fell() { return !getStateFlag(DEBOUNCED_STATE) && getStateFlag(CHANGED_STATE); } + +//////////// +// BOUNCE // +//////////// + + +Bounce::Bounce() + : pin(0) +{} + +void Bounce::attach(int pin) { + this->pin = pin; + + // SET INITIAL STATE + begin(); +} + +void Bounce::attach(int pin, int mode){ + setPinMode(pin, mode); + this->attach(pin); +} + + + diff --git a/src/Bounce2.h b/src/Bounce2.h index f266cb2..52d001d 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -69,16 +69,114 @@ Example of two instances of the Bounce class that switches the debug LED when either one of the two buttons is pressed. */ -static const uint8_t DEBOUNCED_STATE = 0b00000001; -static const uint8_t UNSTABLE_STATE = 0b00000010; -static const uint8_t CHANGED_STATE = 0b00000100; + /** - The Bounce class. - */ -class Bounce + The Debouce class. Just the deboucing code separated from all harware. +*/ +class Debouncer { - public: + // Note : this is private as it migh change in the futur +private: + static const uint8_t DEBOUNCED_STATE = 0b00000001; + static const uint8_t UNSTABLE_STATE = 0b00000010; + static const uint8_t CHANGED_STATE = 0b00000100; + +private: + inline void changeState(); + inline void setStateFlag(const uint8_t flag) {state |= flag;} + inline void unsetStateFlag(const uint8_t flag) {state &= ~flag;} + inline void toggleStateFlag(const uint8_t flag) {state ^= flag;} + inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);} + +public: + /*! + @brief Create an instance of the Debounce class. + + @endcode +*/ + Debouncer(); + + /** + @brief Sets the debounce interval in milliseconds. + + @param interval_millis + The interval time in milliseconds. + + */ + void interval(uint16_t interval_millis); + + /*! + @brief Updates the pin's state. + + Because Bounce does not use interrupts, you have to "update" the object before reading its value and it has to be done as often as possible (that means to include it in your loop()). Only call update() once per loop(). + + @return True if the pin changed state. +*/ + + bool update(); + + /** + @brief Returns the pin's state (HIGH or LOW). + + @return HIGH or LOW. + */ + bool read(); + + /** + @brief Returns true if pin signal transitions from high to low. + */ + bool fell(); + + /** + @brief Returns true if pin signal transitions from low to high. + */ + bool rose(); + + + +public: + bool changed( ) { return getStateFlag(CHANGED_STATE); } + + /** + @brief Returns the duration in milliseconds of the current state. + + Is reset to 0 once the pin rises ( rose() ) or falls ( fell() ). + + @return The duration in milliseconds (unsigned long) of the current state. + */ + + unsigned long duration(); + + /** + @brief Returns the duration in milliseconds of the previous state. + + Takes the values of duration() once the pin changes state. + + @return The duration in milliseconds (unsigned long) of the previous state. + */ + unsigned long previousDuration(); + +protected: + void begin(); + virtual bool readCurrentState() =0; + unsigned long previous_millis; + uint16_t interval_millis; + uint8_t state; + unsigned long stateChangeLastTime; + unsigned long durationOfPreviousState; + +}; + + +/** + The Bounce class. Links the Deboucing class to a hardware pin. + */ +class Bounce : public Debouncer +{ + + +public: /*! @brief Create an instance of the Bounce class. @@ -90,7 +188,7 @@ class Bounce @endcode */ - Bounce(); + Bounce(); /*! @@ -101,112 +199,50 @@ class Bounce @param mode A valid Arduino pin mode (INPUT, INPUT_PULLUP or OUTPUT). */ - void attach(int pin, int mode); + void attach(int pin, int mode); /** Attach to a pin for advanced users. Only attach the pin this way once you have previously set it up. Otherwise use attach(int pin, int mode). */ - void attach(int pin); - + void attach(int pin); - /** - @brief Sets the debounce interval in milliseconds. - - @param interval_millis - The interval time in milliseconds. - - */ - void interval(uint16_t interval_millis); + Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() { + attach(pin); + interval(interval_millis); + } + //////////////// + // Deprecated // + //////////////// -/*! - @brief Updates the pin's state. - - Because Bounce does not use interrupts, you have to "update" the object before reading its value and it has to be done as often as possible (that means to include it in your loop()). Only call update() once per loop(). - - @return True if the pin changed state. -*/ - - bool update(); - - /** - @brief Returns the pin's state (HIGH or LOW). - - @return HIGH or LOW. - */ - bool read(); - - /** - @brief Returns true if pin signal transitions from high to low. - */ - bool fell(); - - /** - @brief Returns true if pin signal transitions from low to high. - */ - bool rose(); - - /** @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1 */ - bool risingEdge() { return rose(); } + bool risingEdge() { return rose(); } /** @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1 */ - bool fallingEdge() { return fell(); } + bool fallingEdge() { return fell(); } /** @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1 */ - Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() { - attach(pin); - interval(interval_millis); - } - - /** - @brief Returns the duration in milliseconds of the current state. - Is reset to 0 once the pin rises ( rose() ) or falls ( fell() ). - - @return The duration in milliseconds (unsigned long) of the current state. - */ - unsigned long duration(); +protected: - /** - @brief Returns the duration in milliseconds of the previous state. - Takes the values of duration() once the pin changes state. - - @return The duration in milliseconds (unsigned long) of the previous state. - */ - unsigned long previousDuration(); + uint8_t pin; - protected: - unsigned long previous_millis; - uint16_t interval_millis; - uint8_t state; - uint8_t pin; - unsigned long stateChangeLastTime; - unsigned long durationOfPreviousState; - virtual bool readCurrentState() { return digitalRead(pin); } - virtual void setPinMode(int pin, int mode) { + virtual bool readCurrentState() { return digitalRead(pin); } + virtual void setPinMode(int pin, int mode) { #if defined(ARDUINO_ARCH_STM32F1) - pinMode(pin, (WiringPinMode)mode); + pinMode(pin, (WiringPinMode)mode); #else - pinMode(pin, mode); + pinMode(pin, mode); #endif - } + } + - private: - inline void changeState(); - inline void setStateFlag(const uint8_t flag) {state |= flag;} - inline void unsetStateFlag(const uint8_t flag) {state &= ~flag;} - inline void toggleStateFlag(const uint8_t flag) {state ^= flag;} - inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);} - - public: - bool changed( ) { return getStateFlag(CHANGED_STATE); } }; @@ -216,7 +252,7 @@ class Bounce class Button : public Bounce{ protected: bool stateForPressed = 1; // -public: + public: /*! @brief Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical level. @@ -227,8 +263,8 @@ public: @endcode */ - Button(){ } - + Button(){ } + /*! @brief Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level. @@ -236,25 +272,25 @@ public: The electrical state (HIGH/LOW) that corresponds to a physical press. */ - void setPressedState(bool state){ - stateForPressed = state; - } + void setPressedState(bool state){ + stateForPressed = state; + } /*! @brief Returns true if the button was physically pressed */ - bool pressed() { - return changed() && (read() == stateForPressed); - }; + bool pressed() { + return changed() && (read() == stateForPressed); + }; /*! @brief Returns true if the button was physically released */ - bool released() { - return changed() && (read() != stateForPressed); - }; + bool released() { + return changed() && (read() != stateForPressed); + }; + - }; -- 2.54.0 From f51b22b708a537ec01cc6b3a62ad433691ce8f11 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Thu, 6 Aug 2020 17:37:25 -0400 Subject: [PATCH 15/53] Updated documentation --- README.md | 212 +++++++++---- docs/files/_bounce2_8h_source.html | 37 +-- docs/files/annotated.html | 5 +- docs/files/bounce2buttons_8ino-example.html | 2 +- docs/files/bounce_8ino-example.html | 2 +- docs/files/class_bounce-members.html | 34 ++- docs/files/class_bounce.html | 228 ++++---------- docs/files/class_bounce.png | Bin 338 -> 522 bytes docs/files/class_button-members.html | 36 +-- docs/files/class_button.html | 121 ++++---- docs/files/class_button.png | Bin 336 -> 520 bytes docs/files/class_debouncer-members.html | 92 ++++++ docs/files/class_debouncer.html | 317 ++++++++++++++++++++ docs/files/class_debouncer.png | Bin 0 -> 528 bytes docs/files/classes.html | 10 +- docs/files/functions.html | 23 +- docs/files/functions_func.html | 20 +- docs/files/functions_vars.html | 74 +++++ docs/files/hierarchy.html | 7 +- docs/files/index.html | 36 ++- docs/files/menudata.js | 3 +- docs/files/search/all_1.js | 2 +- docs/files/search/all_2.js | 2 +- docs/files/search/all_3.js | 4 +- docs/files/search/all_4.js | 3 +- docs/files/search/all_5.js | 3 +- docs/files/search/all_6.js | 7 +- docs/files/search/all_7.js | 5 +- docs/files/search/all_8.js | 2 +- docs/files/search/all_9.html | 26 ++ docs/files/search/all_9.js | 4 + docs/files/search/classes_1.html | 26 ++ docs/files/search/classes_1.js | 4 + docs/files/search/functions_1.js | 2 +- docs/files/search/functions_2.js | 2 +- docs/files/search/functions_3.js | 4 +- docs/files/search/functions_4.js | 3 +- docs/files/search/functions_5.js | 3 +- docs/files/search/functions_6.js | 6 +- docs/files/search/functions_7.js | 5 +- docs/files/search/functions_8.js | 2 +- docs/files/search/functions_9.html | 26 ++ docs/files/search/functions_9.js | 4 + docs/files/search/searchdata.js | 15 +- docs/files/search/variables_0.html | 26 ++ docs/files/search/variables_0.js | 4 + library.json | 2 +- library.properties | 2 +- src/Bounce2.h | 12 +- 49 files changed, 1069 insertions(+), 396 deletions(-) create mode 100644 docs/files/class_debouncer-members.html create mode 100644 docs/files/class_debouncer.html create mode 100644 docs/files/class_debouncer.png create mode 100644 docs/files/functions_vars.html create mode 100644 docs/files/search/all_9.html create mode 100644 docs/files/search/all_9.js create mode 100644 docs/files/search/classes_1.html create mode 100644 docs/files/search/classes_1.js create mode 100644 docs/files/search/functions_9.html create mode 100644 docs/files/search/functions_9.js create mode 100644 docs/files/search/variables_0.html create mode 100644 docs/files/search/variables_0.js diff --git a/README.md b/README.md index c9546f4..0031bb9 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,175 @@ 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 +Basically, the mechanical part of buttons and switches vibrate slightly when closed or opened causing multiple undesired false states (similar to noise). This library filters out these undesired state changes. 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. -## 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). +The library is composed of three classes: +* Debouncer : The code that does the actual debouncing. Only advanced users should play with this class. +* Bounce : This is the general use library. It links the Debouncer to a hardware pin on your board. +* Button : A special version of Bounce for buttons that are pressed. # INSTALLATION & DOWNLOAD Install through your software's Library Manager or download the latest version [here](https://github.com/thomasfredericks/Bounce2/archive/master.zip) 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. +Please note that the original version of this library (Bounce 1) is included in the "extras" folder of the download but not supported anymore. + +## BASIC USE + +### INSTANTIATE + +```cpp +#include +Bounce b = Bounce(); // Instantiate a Bounce object +``` + +### SETUP + +```cpp +b.attach ( , ); +b.interval( ); +``` +### LOOP + +```cpp +b.update(); +if ( b.changed() ) { + // THE STATE OF THE INPUT CHANGED + int deboucedValue = b.read(); + // DO SOMETHING WITH THE VALUE +} +``` -# DEBOUNCE ALGORITHMS (FOR ADVANCED USERS) +## BOUNCE EXAMPLE + +```cpp +// This example toggles the debug LED (pin 13) on or off when a button on pin 2 is pressed. + +// Include the Bounce2 library found here : +// https://github.com/thomasfredericks/Bounce2 +#include + +#define BUTTON_PIN 2 +#define LED_PIN 13 + +int ledState = LOW; + + +Bounce b = Bounce(); // Instantiate a Bounce object + +void setup() { + + b.attach(BUTTON_PIN,INPUT_PULLUP); // Attach the debouncer to a pin with INPUT_PULLUP mode + b.interval(25); // Use a debounce interval of 25 milliseconds + + + pinMode(LED_PIN,OUTPUT); // Setup the LED + digitalWrite(LED_PIN,ledState); // Turn off the LED + +} + +void loop() { + + b.update(); // Update the Bounce instance + + if ( b.fell() ) { // Call code if button transitions from HIGH to LOW + ledState = !ledState; // Toggle LED state + digitalWrite(LED_PIN,ledState); // Apply new LED state + } +} +``` + +## BUTTON EXAMPLE + +```cpp +/* + DESCRIPTION + ==================== + Pressing a physical button switches a LED on or off. + Simple example of the Button class from the Bounce library. + The Button class matches an electrical state to a physical action + with
    diff --git a/docs/files/functions_vars.html b/docs/files/functions_vars.html new file mode 100644 index 0000000..011d43b --- /dev/null +++ b/docs/files/functions_vars.html @@ -0,0 +1,74 @@ + + + + + + + +Bounce2: Class Members - Variables + + + + + + + + + +
    +
    + + + + + + +
    +
    Bounce2 +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +  +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/files/hierarchy.html b/docs/files/hierarchy.html index 9e5fff8..f4199a0 100644 --- a/docs/files/hierarchy.html +++ b/docs/files/hierarchy.html @@ -63,9 +63,10 @@ $(function() {
    This inheritance list is sorted roughly, but not completely, alphabetically:
    -
    [detail level 12]
    - - +
    [detail level 123]
     ▼CBounce
     CButton
    + + +
     ▼CDebouncerThe Debouce class. Just the deboucing code separated from all harware
     ▼CBounceThe Debouncer:Bounce class. Links the Deboucing class to a hardware pin
     CButtonThe Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action
    diff --git a/docs/files/index.html b/docs/files/index.html index 92571cc..4d9b43b 100644 --- a/docs/files/index.html +++ b/docs/files/index.html @@ -63,20 +63,31 @@ $(function() {

    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

    +

    Basically, the mechanical part of buttons and switches vibrate slightly when closed or opened causing multiple undesired false states (similar to noise). This library filters out these undesired state changes. 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.

    -

    GITHUB PAGE

    -

    https://github.com/thomasfredericks/Bounce2

    -

    DOCUMENTATION

    -

    The complete class documentation can be found in the "docs" folder or online here.

    -

    HAVE A QUESTION?

    -

    Please post your questions here.

    +

    The library is composed of three classes:

      +
    • Debouncer : The code that does the actual debouncing. Only advanced users should play with this class.
      • +
    • Bounce : This is the general use library. It links the Debouncer to a hardware pin on your board.
      • +
    • Button : A special version of Bounce for buttons that are pressed.
      • +

    INSTALLATION & DOWNLOAD

    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.

    -

    DEBOUNCE ALGORITHMS (FOR ADVANCED USERS)

    +

    Please note that the original version of this library (Bounce 1) is included in the "extras" folder of the download but not supported anymore.

    +

    BASIC USE

    +

    INSTANTIATE

    +
    #include <Bounce2.h>
    Bounce b = Bounce(); // Instantiate a Bounce object

    SETUP

    +
    b.attach ( <PIN> , <PIN MODE> );
    b.interval( <INTERVAL IN MS> );

    LOOP

    +
    b.update();
    if ( b.changed() ) {
    // THE STATE OF THE INPUT CHANGED
    int deboucedValue = b.read();
    // DO SOMETHING WITH THE VALUE
    }

    BOUNCE EXAMPLE

    +
    // This example toggles the debug LED (pin 13) on or off when a button on pin 2 is pressed.
    // Include the Bounce2 library found here :
    // https://github.com/thomasfredericks/Bounce2
    #include <Bounce2.h>
    #define BUTTON_PIN 2
    #define LED_PIN 13
    int ledState = LOW;
    Bounce b = Bounce(); // Instantiate a Bounce object
    void setup() {
    b.attach(BUTTON_PIN,INPUT_PULLUP); // Attach the debouncer to a pin with INPUT_PULLUP mode
    b.interval(25); // Use a debounce interval of 25 milliseconds
    pinMode(LED_PIN,OUTPUT); // Setup the LED
    digitalWrite(LED_PIN,ledState); // Turn off the LED
    }
    void loop() {
    b.update(); // Update the Bounce instance
    if ( b.fell() ) { // Call code if button transitions from HIGH to LOW
    ledState = !ledState; // Toggle LED state
    digitalWrite(LED_PIN,ledState); // Apply new LED state
    }
    }

    BUTTON EXAMPLE

    +
    /*
    DESCRIPTION
    ====================
    Pressing a physical button switches a LED on or off.
    Simple example of the Button class from the Bounce library.
    The Button class matches an electrical state to a physical action
    with <Button>.setPressedState(LOW or HIGH).
    Set BUTTON_PIN to the pin attached to the button.
    Set LED_PIN to the pin attached to a LED.
    */
    // Include the Bounce2 library found here :
    // https://github.com/thomasfredericks/Bounce2
    #include <Bounce2.h>
    // INSTANTIATE A Button OBJECT
    Button button = Button();
    // WE WILL attach() THE BUTTON TO THE FOLLOWING PIN IN setup()
    #define BUTTON_PIN 39
    // DEFINE THE PIN FOR THE LED :
    // 1) SOME BOARDS HAVE A DEFAULT LED (LED_BUILTIN)
    //#define LED_PIN LED_BUILTIN
    // 2) OTHERWISE SET YOUR OWN PIN
    #define LED_PIN 13
    // SET A VARIABLE TO STORE THE LED STATE
    bool ledState = LOW;
    void setup() {
    // BUTTON SETUP
    // SELECT ONE OF THE FOLLOWING :
    // 1) IF YOUR BUTTON HAS AN INTERNAL PULL-UP
    // button.attach( BUTTON_PIN , INPUT_PULLUP ); // USE INTERNAL PULL-UP
    // 2) IF YOUR BUTTON USES AN EXTERNAL PULL-UP
    button.attach( BUTTON_PIN, INPUT ); // USE EXTERNAL PULL-UP
    // DEBOUNCE INTERVAL IN MILLISECONDS
    button.interval(5);
    // INDICATE THAT THE LOW STATE CORRESPONDS TO PHYSICALLY PRESSING THE BUTTON
    button.setPressedState(LOW);
    // LED SETUP
    pinMode(LED_PIN,OUTPUT);
    digitalWrite(LED_PIN,ledState);
    }
    void loop() {
    // UPDATE THE BUTTON
    // YOU MUST CALL THIS EVERY LOOP
    button.update();
    if ( button.pressed() ) {
    // TOGGLE THE LED STATE :
    ledState = !ledState; // SET ledState TO THE OPPOSITE OF ledState
    digitalWrite(LED_PIN,ledState);
    }
    }

    DOCUMENTATION

    +

    The complete class documentation can be found in the "docs" folder or online here.

    +

    GITHUB PAGE (SOURCE CODE)

    +

    https://github.com/thomasfredericks/Bounce2

    +

    HAVE A QUESTION?

    +

    Please post your questions here.

    +

    ALTERNATE DEBOUNCE ALGORITHMS FOR ADVANCED USERS AND SPECIFIC CASES

    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.

    +

    By default, the Bounce library uses a stable interval to process the debouncing. This is simpler to understand and can cancel unwanted noise.

    @@ -86,13 +97,12 @@ $(function() {

    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.

    +

    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

    BASIC EXAMPLE

    -
    // This example toggles the debug LED (pin 13) on or off
    // when a button on pin 2 is pressed.
    // Include the Bounce2 library found here :
    // https://github.com/thomasfredericks/Bounce2
    #include <Bounce2.h>
    #define BUTTON_PIN 2
    #define LED_PIN 13
    int ledState = LOW;
    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(25); // Use a debounce interval of 25 milliseconds
    pinMode(LED_PIN,OUTPUT); // Setup the LED
    digitalWrite(LED_PIN,ledState);
    }
    void loop() {
    debouncer.update(); // Update the Bounce instance
    if ( debouncer.fell() ) { // Call code if button transitions from HIGH to LOW
    ledState = !ledState; // Toggle LED state
    digitalWrite(LED_PIN,ledState); // Apply new LED state
    }
    }
    +
    #define BOUNCE_WITH_PROMPT_DETECTION
    Generated by   diff --git a/docs/files/menudata.js b/docs/files/menudata.js index ccb591d..7d83fe0 100644 --- a/docs/files/menudata.js +++ b/docs/files/menudata.js @@ -6,7 +6,8 @@ var menudata={children:[ {text:"Class Hierarchy",url:"hierarchy.html"}, {text:"Class Members",url:"functions.html",children:[ {text:"All",url:"functions.html"}, -{text:"Functions",url:"functions_func.html"}]}]}, +{text:"Functions",url:"functions_func.html"}, +{text:"Variables",url:"functions_vars.html"}]}]}, {text:"Files",url:"files.html",children:[ {text:"File List",url:"files.html"}]}, {text:"Examples",url:"examples.html"}]} diff --git a/docs/files/search/all_1.js b/docs/files/search/all_1.js index fe8b316..12d8b07 100644 --- a/docs/files/search/all_1.js +++ b/docs/files/search/all_1.js @@ -1,6 +1,6 @@ var searchData= [ - ['bounce',['Bounce',['../class_bounce.html',1,'Bounce'],['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce::Bounce()'],['../class_bounce.html#ab34517094faf21d4f38b36da2915132b',1,'Bounce::Bounce(uint8_t pin, unsigned long interval_millis)']]], + ['bounce',['Bounce',['../class_bounce.html',1,'Bounce'],['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce::Bounce()']]], ['button',['Button',['../class_button.html',1,'Button'],['../class_button.html#a3b36df1ae23c58aedb9e15a713159459',1,'Button::Button()']]], ['bounce_202',['BOUNCE 2',['../index.html',1,'']]] ]; diff --git a/docs/files/search/all_2.js b/docs/files/search/all_2.js index ab5b99b..999a7d5 100644 --- a/docs/files/search/all_2.js +++ b/docs/files/search/all_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['duration',['duration',['../class_bounce.html#a62412d814d36102ab3d285e801d5d29a',1,'Bounce']]] + ['changed',['changed',['../class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_3.js b/docs/files/search/all_3.js index c61b06c..e07adff 100644 --- a/docs/files/search/all_3.js +++ b/docs/files/search/all_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['fallingedge',['fallingEdge',['../class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f',1,'Bounce']]], - ['fell',['fell',['../class_bounce.html#abfbb0910f5b1ec4e25315cff26dd6289',1,'Bounce']]] + ['debouncer',['Debouncer',['../class_debouncer.html',1,'Debouncer'],['../class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6',1,'Debouncer::Debouncer()']]], + ['duration',['duration',['../class_debouncer.html#a462994f1f9a20876b2ee239eeee97448',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_4.js b/docs/files/search/all_4.js index a9bd026..6d31609 100644 --- a/docs/files/search/all_4.js +++ b/docs/files/search/all_4.js @@ -1,4 +1,5 @@ var searchData= [ - ['interval',['interval',['../class_bounce.html#a2c6e68bf749497c597a9437b488b3d7c',1,'Bounce']]] + ['fallingedge',['fallingEdge',['../class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f',1,'Bounce']]], + ['fell',['fell',['../class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_5.js b/docs/files/search/all_5.js index 7f6ad53..c4479c1 100644 --- a/docs/files/search/all_5.js +++ b/docs/files/search/all_5.js @@ -1,5 +1,4 @@ var searchData= [ - ['pressed',['pressed',['../class_button.html#a8e37fb754907685539ea71183204b033',1,'Button']]], - ['previousduration',['previousDuration',['../class_bounce.html#ad6226be8000f4cec9f2c997a5bc98a9c',1,'Bounce']]] + ['interval',['interval',['../class_debouncer.html#a930bf3945e698d77b889f6309079857d',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_6.js b/docs/files/search/all_6.js index 8a397ef..d253924 100644 --- a/docs/files/search/all_6.js +++ b/docs/files/search/all_6.js @@ -1,7 +1,6 @@ var searchData= [ - ['read',['read',['../class_bounce.html#ae1936fdf44501992707e6cbaee9bbc76',1,'Bounce']]], - ['released',['released',['../class_button.html#a0b3d2033eb8a6e93141e0b2d8375e9dd',1,'Button']]], - ['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], - ['rose',['rose',['../class_bounce.html#a9e4187934576e568cdfa8f94efeff6f2',1,'Bounce']]] + ['pin',['pin',['../class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a',1,'Bounce']]], + ['pressed',['pressed',['../class_button.html#a8e37fb754907685539ea71183204b033',1,'Button']]], + ['previousduration',['previousDuration',['../class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_7.js b/docs/files/search/all_7.js index 0349e22..18754f8 100644 --- a/docs/files/search/all_7.js +++ b/docs/files/search/all_7.js @@ -1,4 +1,7 @@ var searchData= [ - ['setpressedstate',['setPressedState',['../class_button.html#aa58da793c244339b781349cf9af544d5',1,'Button']]] + ['read',['read',['../class_debouncer.html#a2cae68910c19c778507f257842fc41bf',1,'Debouncer']]], + ['released',['released',['../class_button.html#a0b3d2033eb8a6e93141e0b2d8375e9dd',1,'Button']]], + ['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], + ['rose',['rose',['../class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_8.js b/docs/files/search/all_8.js index 5223992..0349e22 100644 --- a/docs/files/search/all_8.js +++ b/docs/files/search/all_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['update',['update',['../class_bounce.html#ab36d7b83bf32e0935a0c2c6a05096441',1,'Bounce']]] + ['setpressedstate',['setPressedState',['../class_button.html#aa58da793c244339b781349cf9af544d5',1,'Button']]] ]; diff --git a/docs/files/search/all_9.html b/docs/files/search/all_9.html new file mode 100644 index 0000000..f8abbbe --- /dev/null +++ b/docs/files/search/all_9.html @@ -0,0 +1,26 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/files/search/all_9.js b/docs/files/search/all_9.js new file mode 100644 index 0000000..005b6d0 --- /dev/null +++ b/docs/files/search/all_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['update',['update',['../class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06',1,'Debouncer']]] +]; diff --git a/docs/files/search/classes_1.html b/docs/files/search/classes_1.html new file mode 100644 index 0000000..a8e7069 --- /dev/null +++ b/docs/files/search/classes_1.html @@ -0,0 +1,26 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/files/search/classes_1.js b/docs/files/search/classes_1.js new file mode 100644 index 0000000..845f889 --- /dev/null +++ b/docs/files/search/classes_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['debouncer',['Debouncer',['../class_debouncer.html',1,'']]] +]; diff --git a/docs/files/search/functions_1.js b/docs/files/search/functions_1.js index 56ab44e..8facc5d 100644 --- a/docs/files/search/functions_1.js +++ b/docs/files/search/functions_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['bounce',['Bounce',['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce::Bounce()'],['../class_bounce.html#ab34517094faf21d4f38b36da2915132b',1,'Bounce::Bounce(uint8_t pin, unsigned long interval_millis)']]], + ['bounce',['Bounce',['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce']]], ['button',['Button',['../class_button.html#a3b36df1ae23c58aedb9e15a713159459',1,'Button']]] ]; diff --git a/docs/files/search/functions_2.js b/docs/files/search/functions_2.js index ab5b99b..999a7d5 100644 --- a/docs/files/search/functions_2.js +++ b/docs/files/search/functions_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['duration',['duration',['../class_bounce.html#a62412d814d36102ab3d285e801d5d29a',1,'Bounce']]] + ['changed',['changed',['../class_debouncer.html#a47c83f13a03920d21fbfafd8469ec06b',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_3.js b/docs/files/search/functions_3.js index c61b06c..42c9ab3 100644 --- a/docs/files/search/functions_3.js +++ b/docs/files/search/functions_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['fallingedge',['fallingEdge',['../class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f',1,'Bounce']]], - ['fell',['fell',['../class_bounce.html#abfbb0910f5b1ec4e25315cff26dd6289',1,'Bounce']]] + ['debouncer',['Debouncer',['../class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6',1,'Debouncer']]], + ['duration',['duration',['../class_debouncer.html#a462994f1f9a20876b2ee239eeee97448',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_4.js b/docs/files/search/functions_4.js index a9bd026..6d31609 100644 --- a/docs/files/search/functions_4.js +++ b/docs/files/search/functions_4.js @@ -1,4 +1,5 @@ var searchData= [ - ['interval',['interval',['../class_bounce.html#a2c6e68bf749497c597a9437b488b3d7c',1,'Bounce']]] + ['fallingedge',['fallingEdge',['../class_bounce.html#ac756559419bfa1c5060e5e4a4ad6406f',1,'Bounce']]], + ['fell',['fell',['../class_debouncer.html#a1ef5a04b4ebe97352ff3bb227476035c',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_5.js b/docs/files/search/functions_5.js index 7f6ad53..c4479c1 100644 --- a/docs/files/search/functions_5.js +++ b/docs/files/search/functions_5.js @@ -1,5 +1,4 @@ var searchData= [ - ['pressed',['pressed',['../class_button.html#a8e37fb754907685539ea71183204b033',1,'Button']]], - ['previousduration',['previousDuration',['../class_bounce.html#ad6226be8000f4cec9f2c997a5bc98a9c',1,'Bounce']]] + ['interval',['interval',['../class_debouncer.html#a930bf3945e698d77b889f6309079857d',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_6.js b/docs/files/search/functions_6.js index 8a397ef..9c30ae2 100644 --- a/docs/files/search/functions_6.js +++ b/docs/files/search/functions_6.js @@ -1,7 +1,5 @@ var searchData= [ - ['read',['read',['../class_bounce.html#ae1936fdf44501992707e6cbaee9bbc76',1,'Bounce']]], - ['released',['released',['../class_button.html#a0b3d2033eb8a6e93141e0b2d8375e9dd',1,'Button']]], - ['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], - ['rose',['rose',['../class_bounce.html#a9e4187934576e568cdfa8f94efeff6f2',1,'Bounce']]] + ['pressed',['pressed',['../class_button.html#a8e37fb754907685539ea71183204b033',1,'Button']]], + ['previousduration',['previousDuration',['../class_debouncer.html#a89ab95e7ac24874bb8cb684dc36a98b9',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_7.js b/docs/files/search/functions_7.js index 0349e22..18754f8 100644 --- a/docs/files/search/functions_7.js +++ b/docs/files/search/functions_7.js @@ -1,4 +1,7 @@ var searchData= [ - ['setpressedstate',['setPressedState',['../class_button.html#aa58da793c244339b781349cf9af544d5',1,'Button']]] + ['read',['read',['../class_debouncer.html#a2cae68910c19c778507f257842fc41bf',1,'Debouncer']]], + ['released',['released',['../class_button.html#a0b3d2033eb8a6e93141e0b2d8375e9dd',1,'Button']]], + ['risingedge',['risingEdge',['../class_bounce.html#a3417beb80eb6593d768c2e9884c57aa0',1,'Bounce']]], + ['rose',['rose',['../class_debouncer.html#a9990de6fa7256842c35c246d7dea8dbb',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_8.js b/docs/files/search/functions_8.js index 5223992..0349e22 100644 --- a/docs/files/search/functions_8.js +++ b/docs/files/search/functions_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['update',['update',['../class_bounce.html#ab36d7b83bf32e0935a0c2c6a05096441',1,'Bounce']]] + ['setpressedstate',['setPressedState',['../class_button.html#aa58da793c244339b781349cf9af544d5',1,'Button']]] ]; diff --git a/docs/files/search/functions_9.html b/docs/files/search/functions_9.html new file mode 100644 index 0000000..c73f07b --- /dev/null +++ b/docs/files/search/functions_9.html @@ -0,0 +1,26 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/files/search/functions_9.js b/docs/files/search/functions_9.js new file mode 100644 index 0000000..005b6d0 --- /dev/null +++ b/docs/files/search/functions_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['update',['update',['../class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06',1,'Debouncer']]] +]; diff --git a/docs/files/search/searchdata.js b/docs/files/search/searchdata.js index 2e0e516..15b2557 100644 --- a/docs/files/search/searchdata.js +++ b/docs/files/search/searchdata.js @@ -1,9 +1,10 @@ var indexSectionsWithContent = { - 0: "abdfiprsu", - 1: "b", - 2: "abdfiprsu", - 3: "b" + 0: "abcdfiprsu", + 1: "bd", + 2: "abcdfiprsu", + 3: "p", + 4: "b" }; var indexSectionNames = @@ -11,7 +12,8 @@ var indexSectionNames = 0: "all", 1: "classes", 2: "functions", - 3: "pages" + 3: "variables", + 4: "pages" }; var indexSectionLabels = @@ -19,6 +21,7 @@ var indexSectionLabels = 0: "All", 1: "Classes", 2: "Functions", - 3: "Pages" + 3: "Variables", + 4: "Pages" }; diff --git a/docs/files/search/variables_0.html b/docs/files/search/variables_0.html new file mode 100644 index 0000000..74ce807 --- /dev/null +++ b/docs/files/search/variables_0.html @@ -0,0 +1,26 @@ + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/docs/files/search/variables_0.js b/docs/files/search/variables_0.js new file mode 100644 index 0000000..48381dc --- /dev/null +++ b/docs/files/search/variables_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['pin',['pin',['../class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a',1,'Bounce']]] +]; diff --git a/library.json b/library.json index 7a688f8..434462f 100644 --- a/library.json +++ b/library.json @@ -6,7 +6,7 @@ "type": "git", "url": "https://github.com/thomasfredericks/Bounce2.git" }, - "version": "2.54", + "version": "2.55", "exclude": [ "*.png", "*.zip" diff --git a/library.properties b/library.properties index 421b2da..a8ee7a2 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=Bounce2 -version=2.54 +version=2.55 author=Thomas O Fredericks with contributions from Eric Lowry, Jim Schimpf, Tom Harkaway, Joachim Krüger and MrGradgrind. maintainer=Thomas O Fredericks sentence=Debouncing library for Arduino and Wiring. diff --git a/src/Bounce2.h b/src/Bounce2.h index 52d001d..46af884 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -72,7 +72,7 @@ /** - The Debouce class. Just the deboucing code separated from all harware. + @brief The Debouce class. Just the deboucing code separated from all harware. */ class Debouncer { @@ -136,6 +136,11 @@ public: public: + /** + @brief Returns true if the state changed on last update. + + @return True if the state changed on last update. Otherwise, returns false. +*/ bool changed( ) { return getStateFlag(CHANGED_STATE); } /** @@ -170,7 +175,8 @@ protected: /** - The Bounce class. Links the Deboucing class to a hardware pin. +@brief The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. + */ class Bounce : public Debouncer { @@ -247,7 +253,7 @@ protected: }; /** - The Button class. + @brief The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action. */ class Button : public Bounce{ protected: -- 2.54.0 From 3ddefb4ba4eef14c306caf406f78879d2f4bb76b Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Sat, 8 Aug 2020 10:21:57 -0400 Subject: [PATCH 16/53] Updated documentation --- Doxyfile | 2 +- docs/files/_bounce2_8h_source.html | 24 +++--- docs/files/bounce_basic_8ino-example.html | 75 +++++++++++++++++++ docs/files/button_basic_8ino-example.html | 74 ++++++++++++++++++ docs/files/examples.html | 8 +- examples/bounce/bounce.ino | 48 ------------ examples/bounce_basic/bounce_basic.ino | 70 +++++++++++++++++ examples/bounce_button/bounce_button.ino | 72 ++++++++++++++++++ examples/buttonClass/buttonClass.ino | 59 --------------- examples/{ => more}/bounceMore/bounceMore.ino | 0 examples/{ => more}/bounceTwo/bounceTwo.ino | 0 examples/{ => more}/change/change.ino | 0 examples/{ => more}/duration/duration.ino | 0 examples/{ => more}/retrigger/retrigger.ino | 0 src/Bounce2.h | 18 +---- 15 files changed, 310 insertions(+), 140 deletions(-) create mode 100644 docs/files/bounce_basic_8ino-example.html create mode 100644 docs/files/button_basic_8ino-example.html delete mode 100644 examples/bounce/bounce.ino create mode 100644 examples/bounce_basic/bounce_basic.ino create mode 100644 examples/bounce_button/bounce_button.ino delete mode 100644 examples/buttonClass/buttonClass.ino rename examples/{ => more}/bounceMore/bounceMore.ino (100%) rename examples/{ => more}/bounceTwo/bounceTwo.ino (100%) rename examples/{ => more}/change/change.ino (100%) rename examples/{ => more}/duration/duration.ino (100%) rename examples/{ => more}/retrigger/retrigger.ino (100%) diff --git a/Doxyfile b/Doxyfile index 14ed479..934333f 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 examples/change/change.ino examples/bounce_multiple/bounce_multiple.ino examples/bounce2buttons/bounce2buttons.ino +EXAMPLE_PATH = examples/bounce_basic/bounce_basic.ino examples/change/button_basic.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/docs/files/_bounce2_8h_source.html b/docs/files/_bounce2_8h_source.html index 9eab5da..ef1291b 100644 --- a/docs/files/_bounce2_8h_source.html +++ b/docs/files/_bounce2_8h_source.html @@ -66,25 +66,25 @@ $(function() {
    Bounce2.h
    -
    1 /*
    2  The MIT License (MIT)
    3 
    4  Copyright (c) 2013 thomasfredericks
    5 
    6  Permission is hereby granted, free of charge, to any person obtaining a copy of
    7  this software and associated documentation files (the "Software"), to deal in
    8  the Software without restriction, including without limitation the rights to
    9  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
    10  the Software, and to permit persons to whom the Software is furnished to do so,
    11  subject to the following conditions:
    12 
    13  The above copyright notice and this permission notice shall be included in all
    14  copies or substantial portions of the Software.
    15 
    16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
    18  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
    19  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
    20  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
    21  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    22 */
    23 
    24 /* * * * * * * * * * * * * * * * * * * * * * * * * * * *
    25  Main code by Thomas O Fredericks (tof@t-o-f.info)
    26  Previous contributions by Eric Lowry, Jim Schimpf and Tom Harkaway
    27  * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
    28 
    35 #ifndef Bounce2_h
    36 #define Bounce2_h
    37 
    38 #if defined(ARDUINO) && ARDUINO >= 100
    39 #include "Arduino.h"
    40 #else
    41 #include "WProgram.h"
    42 #endif
    43 
    44 // Uncomment the following line for "LOCK-OUT" debounce method
    45 //#define BOUNCE_LOCK_OUT
    46 
    47 // Uncomment the following line for "BOUNCE_WITH_PROMPT_DETECTION" debounce method
    48 //#define BOUNCE_WITH_PROMPT_DETECTION
    49 
    50 #include <inttypes.h>
    51 
    77 class Debouncer
    78 {
    79  // Note : this is private as it migh change in the futur
    80 private:
    81  static const uint8_t DEBOUNCED_STATE = 0b00000001;
    82  static const uint8_t UNSTABLE_STATE = 0b00000010;
    83  static const uint8_t CHANGED_STATE = 0b00000100;
    84 
    85 private:
    86  inline void changeState();
    87  inline void setStateFlag(const uint8_t flag) {state |= flag;}
    88  inline void unsetStateFlag(const uint8_t flag) {state &= ~flag;}
    89  inline void toggleStateFlag(const uint8_t flag) {state ^= flag;}
    90  inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);}
    91 
    92 public:
    98  Debouncer();
    99 
    107  void interval(uint16_t interval_millis);
    108 
    117  bool update();
    118 
    124  bool read();
    125 
    129  bool fell();
    130 
    134  bool rose();
    135 
    136 
    137 
    138 public:
    144  bool changed( ) { return getStateFlag(CHANGED_STATE); }
    145 
    154  unsigned long duration();
    155 
    163  unsigned long previousDuration();
    164 
    165 protected:
    166  void begin();
    167  virtual bool readCurrentState() =0;
    168  unsigned long previous_millis;
    169  uint16_t interval_millis;
    170  uint8_t state;
    171  unsigned long stateChangeLastTime;
    172  unsigned long durationOfPreviousState;
    173 
    174 };
    175 
    176 
    181 class Bounce : public Debouncer
    182 {
    183 
    184 
    185 public:
    186 
    197  Bounce();
    198 
    199 
    208  void attach(int pin, int mode);
    209 
    213  void attach(int pin);
    214 
    215  Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
    216  attach(pin);
    217  interval(interval_millis);
    218  }
    219 
    221  // Deprecated //
    223 
    227  bool risingEdge() { return rose(); }
    231  bool fallingEdge() { return fell(); }
    237 protected:
    238 
    239 
    240  uint8_t pin;
    241 
    242  virtual bool readCurrentState() { return digitalRead(pin); }
    243  virtual void setPinMode(int pin, int mode) {
    244 #if defined(ARDUINO_ARCH_STM32F1)
    245  pinMode(pin, (WiringPinMode)mode);
    246 #else
    247  pinMode(pin, mode);
    248 #endif
    249  }
    250 
    251 
    252 
    253 };
    254 
    258 class Button : public Bounce{
    259 protected:
    260  bool stateForPressed = 1; //
    261  public:
    272  Button(){ }
    273 
    281  void setPressedState(bool state){
    282  stateForPressed = state;
    283  }
    284 
    288  bool pressed() {
    289  return changed() && (read() == stateForPressed);
    290  };
    291 
    295  bool released() {
    296  return changed() && (read() != stateForPressed);
    297  };
    298 
    299 
    300 
    301 };
    302 
    303 #endif
    Debouncer::previousDuration
    unsigned long previousDuration()
    Returns the duration in milliseconds of the previous state.
    Definition: Bounce2.cpp:103
    -
    Button::pressed
    bool pressed()
    Returns true if the button was physically pressed.
    Definition: Bounce2.h:288
    -
    Bounce
    The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.
    Definition: Bounce2.h:181
    +
    1 /*
    2  The MIT License (MIT)
    3 
    4  Copyright (c) 2013 thomasfredericks
    5 
    6  Permission is hereby granted, free of charge, to any person obtaining a copy of
    7  this software and associated documentation files (the "Software"), to deal in
    8  the Software without restriction, including without limitation the rights to
    9  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
    10  the Software, and to permit persons to whom the Software is furnished to do so,
    11  subject to the following conditions:
    12 
    13  The above copyright notice and this permission notice shall be included in all
    14  copies or substantial portions of the Software.
    15 
    16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
    18  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
    19  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
    20  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
    21  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    22 */
    23 
    24 /* * * * * * * * * * * * * * * * * * * * * * * * * * * *
    25  Main code by Thomas O Fredericks (tof@t-o-f.info)
    26  Previous contributions by Eric Lowry, Jim Schimpf and Tom Harkaway
    27  * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
    28 
    35 #ifndef Bounce2_h
    36 #define Bounce2_h
    37 
    38 #if defined(ARDUINO) && ARDUINO >= 100
    39 #include "Arduino.h"
    40 #else
    41 #include "WProgram.h"
    42 #endif
    43 
    44 // Uncomment the following line for "LOCK-OUT" debounce method
    45 //#define BOUNCE_LOCK_OUT
    46 
    47 // Uncomment the following line for "BOUNCE_WITH_PROMPT_DETECTION" debounce method
    48 //#define BOUNCE_WITH_PROMPT_DETECTION
    49 
    50 #include <inttypes.h>
    51 
    67 class Debouncer
    68 {
    69  // Note : this is private as it migh change in the futur
    70 private:
    71  static const uint8_t DEBOUNCED_STATE = 0b00000001;
    72  static const uint8_t UNSTABLE_STATE = 0b00000010;
    73  static const uint8_t CHANGED_STATE = 0b00000100;
    74 
    75 private:
    76  inline void changeState();
    77  inline void setStateFlag(const uint8_t flag) {state |= flag;}
    78  inline void unsetStateFlag(const uint8_t flag) {state &= ~flag;}
    79  inline void toggleStateFlag(const uint8_t flag) {state ^= flag;}
    80  inline bool getStateFlag(const uint8_t flag) {return((state & flag) != 0);}
    81 
    82 public:
    88  Debouncer();
    89 
    97  void interval(uint16_t interval_millis);
    98 
    107  bool update();
    108 
    114  bool read();
    115 
    119  bool fell();
    120 
    124  bool rose();
    125 
    126 
    127 
    128 public:
    134  bool changed( ) { return getStateFlag(CHANGED_STATE); }
    135 
    144  unsigned long duration();
    145 
    153  unsigned long previousDuration();
    154 
    155 protected:
    156  void begin();
    157  virtual bool readCurrentState() =0;
    158  unsigned long previous_millis;
    159  uint16_t interval_millis;
    160  uint8_t state;
    161  unsigned long stateChangeLastTime;
    162  unsigned long durationOfPreviousState;
    163 
    164 };
    165 
    166 
    171 class Bounce : public Debouncer
    172 {
    173 
    174 
    175 public:
    176 
    187  Bounce();
    188 
    189 
    198  void attach(int pin, int mode);
    199 
    203  void attach(int pin);
    204 
    205  Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
    206  attach(pin);
    207  interval(interval_millis);
    208  }
    209 
    211  // Deprecated //
    213 
    217  bool risingEdge() { return rose(); }
    221  bool fallingEdge() { return fell(); }
    227 protected:
    228 
    229 
    230  uint8_t pin;
    231 
    232  virtual bool readCurrentState() { return digitalRead(pin); }
    233  virtual void setPinMode(int pin, int mode) {
    234 #if defined(ARDUINO_ARCH_STM32F1)
    235  pinMode(pin, (WiringPinMode)mode);
    236 #else
    237  pinMode(pin, mode);
    238 #endif
    239  }
    240 
    241 
    242 
    243 };
    244 
    248 class Button : public Bounce{
    249 protected:
    250  bool stateForPressed = 1; //
    251  public:
    262  Button(){ }
    263 
    271  void setPressedState(bool state){
    272  stateForPressed = state;
    273  }
    274 
    278  bool pressed() {
    279  return changed() && (read() == stateForPressed);
    280  };
    281 
    285  bool released() {
    286  return changed() && (read() != stateForPressed);
    287  };
    288 
    289 
    290 
    291 };
    292 
    293 #endif
    Debouncer::previousDuration
    unsigned long previousDuration()
    Returns the duration in milliseconds of the previous state.
    Definition: Bounce2.cpp:103
    +
    Button::pressed
    bool pressed()
    Returns true if the button was physically pressed.
    Definition: Bounce2.h:278
    +
    Bounce
    The Debouncer:Bounce class. Links the Deboucing class to a hardware pin.
    Definition: Bounce2.h:171
    Debouncer::interval
    void interval(uint16_t interval_millis)
    Sets the debounce interval in milliseconds.
    Definition: Bounce2.cpp:14
    Debouncer::fell
    bool fell()
    Returns true if pin signal transitions from high to low.
    Definition: Bounce2.cpp:128
    Debouncer::read
    bool read()
    Returns the pin&#39;s state (HIGH or LOW).
    Definition: Bounce2.cpp:118
    -
    Button::released
    bool released()
    Returns true if the button was physically released.
    Definition: Bounce2.h:295
    -
    Debouncer
    The Debouce class. Just the deboucing code separated from all harware.
    Definition: Bounce2.h:77
    +
    Button::released
    bool released()
    Returns true if the button was physically released.
    Definition: Bounce2.h:285
    +
    Debouncer
    The Debouce class. Just the deboucing code separated from all harware.
    Definition: Bounce2.h:67
    Debouncer::Debouncer
    Debouncer()
    Create an instance of the Debounce class.
    Definition: Bounce2.cpp:10
    -
    Bounce::fallingEdge
    bool fallingEdge()
    Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
    Definition: Bounce2.h:231
    -
    Bounce::pin
    uint8_t pin
    Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
    Definition: Bounce2.h:240
    +
    Bounce::fallingEdge
    bool fallingEdge()
    Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
    Definition: Bounce2.h:221
    +
    Bounce::pin
    uint8_t pin
    Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
    Definition: Bounce2.h:230
    Debouncer::duration
    unsigned long duration()
    Returns the duration in milliseconds of the current state.
    Definition: Bounce2.cpp:107
    -
    Debouncer::changed
    bool changed()
    Returns true if the state changed on last update.
    Definition: Bounce2.h:144
    +
    Debouncer::changed
    bool changed()
    Returns true if the state changed on last update.
    Definition: Bounce2.h:134
    Debouncer::rose
    bool rose()
    Returns true if pin signal transitions from low to high.
    Definition: Bounce2.cpp:123
    -
    Bounce::risingEdge
    bool risingEdge()
    Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
    Definition: Bounce2.h:227
    -
    Button::setPressedState
    void setPressedState(bool state)
    Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level.
    Definition: Bounce2.h:281
    -
    Button
    The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action...
    Definition: Bounce2.h:258
    +
    Bounce::risingEdge
    bool risingEdge()
    Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
    Definition: Bounce2.h:217
    +
    Button::setPressedState
    void setPressedState(bool state)
    Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default, the pressed state is matched to a HIGH electrical level.
    Definition: Bounce2.h:271
    +
    Button
    The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action...
    Definition: Bounce2.h:248
    Debouncer::update
    bool update()
    Updates the pin&#39;s state.
    Definition: Bounce2.cpp:32
    -
    Button::Button
    Button()
    Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical...
    Definition: Bounce2.h:272
    +
    Button::Button
    Button()
    Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical...
    Definition: Bounce2.h:262
    diff --git a/docs/files/bounce_basic_8ino-example.html b/docs/files/bounce_basic_8ino-example.html new file mode 100644 index 0000000..08e4a34 --- /dev/null +++ b/docs/files/bounce_basic_8ino-example.html @@ -0,0 +1,75 @@ + + + + + + + +Bounce2: bounce_basic.ino + + + + + + + + + +
    +
    + + + + + + +
    +
    Bounce2 +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    bounce_basic.ino
    +
    +
    +
    Todo:
    Make Bounce2 more abstract. Split it from the hardware layer. Remove deboucing code from Bounce2 and make a new Debounce class from that code. Bounce2 should extend Debounce.
    +

    Basic example of the Bounce class.

    +
    /*
    DESCRIPTION
    ====================
    Simple example of the Bounce library that switches a LED when
    a state change (from HIGH to LOW) is triggered (for example when a button is pressed).
    Set BOUNCE_PIN to the pin attached to the input (a button for example).
    Set LED_PIN to the pin attached to a LED.
    */
    // WE WILL attach() THE Bounce INSTANCE TO THE FOLLOWING PIN IN setup()
    #define BOUNCE_PIN 2
    // DEFINE THE PIN FOR THE LED :
    // 1) SOME BOARDS HAVE A DEFAULT LED (LED_BUILTIN)
    #define LED_PIN LED_BUILTIN
    // 2) OTHERWISE SET YOUR OWN PIN
    // #define LED_PIN 13
    // Include the Bounce2 library found here :
    // https://github.com/thomasfredericks/Bounce2
    #include <Bounce2.h>
    // INSTANTIATE A Bounce OBJECT
    Bounce bounce = Bounce();
    // SET A VARIABLE TO STORE THE LED STATE
    bool ledState = LOW;
    void setup() {
    // BOUNCE SETUP
    // SELECT ONE OF THE FOLLOWING :
    // 1) IF YOUR INPUT HAS AN INTERNAL PULL-UP
    // bounce.attach( BOUNCE_PIN , INPUT_PULLUP ); // USE INTERNAL PULL-UP
    // 2) IF YOUR INPUT USES AN EXTERNAL PULL-UP
    bounce.attach( BOUNCE_PIN, INPUT ); // USE EXTERNAL PULL-UP
    // DEBOUNCE INTERVAL IN MILLISECONDS
    bounce.interval(5); // interval in ms
    // LED SETUP
    pinMode(LED_PIN, OUTPUT);
    digitalWrite(LED_PIN, ledState);
    }
    void loop() {
    // Update the Bounce instance (YOU MUST DO THIS EVERY LOOP)
    bounce.update();
    // <Bounce>.changed() RETURNS true IF THE STATE CHANGED (FROM HIGH TO LOW OR LOW TO HIGH)
    if ( bounce.changed() ) {
    // THE STATE OF THE INPUT CHANGED
    // GET THE STATE
    int deboucedInput = bounce.read();
    // IF THE CHANGED VALUE IS LOW
    if ( deboucedInput == LOW ) {
    ledState = !ledState; // SET ledState TO THE OPPOSITE OF ledState
    digitalWrite(LED_PIN,ledState); // WRITE THE NEW ledState
    }
    }
    }
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/files/button_basic_8ino-example.html b/docs/files/button_basic_8ino-example.html new file mode 100644 index 0000000..f3e4a88 --- /dev/null +++ b/docs/files/button_basic_8ino-example.html @@ -0,0 +1,74 @@ + + + + + + + +Bounce2: button_basic.ino + + + + + + + + + +
    +
    + + + + + + +
    +
    Bounce2 +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    +
    button_basic.ino
    +
    +
    +

    Basic example of the Button class.

    +
    + +
    +Generated by   +doxygen + 1.8.13 +
    + + diff --git a/docs/files/examples.html b/docs/files/examples.html index 76342e5..8d94c2d 100644 --- a/docs/files/examples.html +++ b/docs/files/examples.html @@ -63,13 +63,9 @@ $(function() {
    Here is a list of all examples:
    diff --git a/examples/bounce/bounce.ino b/examples/bounce/bounce.ino deleted file mode 100644 index 2c75bda..0000000 --- a/examples/bounce/bounce.ino +++ /dev/null @@ -1,48 +0,0 @@ - -/* - DESCRIPTION - ==================== - Simple example of the Bounce library that switches the debug LED when a button is pressed. - */ -// Include the Bounce2 library found here : -// https://github.com/thomasfredericks/Bounce2 -#include - -#define BUTTON_PIN 2 -#define LED_PIN 13 - -// Instantiate a Bounce object -Bounce debouncer = Bounce(); - -void setup() { - - // Setup the button with an internal pull-up : - pinMode(BUTTON_PIN,INPUT_PULLUP); - - // After setting up the button, setup the Bounce instance : - debouncer.attach(BUTTON_PIN); - debouncer.interval(5); // interval in ms - - //Setup the LED : - pinMode(LED_PIN,OUTPUT); - -} - -void loop() { - // Update the Bounce instance : - debouncer.update(); - - // Get the updated value : - int value = debouncer.read(); - - // Turn on or off the LED as determined by the state : - if ( value == LOW ) { - digitalWrite(LED_PIN, HIGH ); - } - else { - digitalWrite(LED_PIN, LOW ); - } - -} - - diff --git a/examples/bounce_basic/bounce_basic.ino b/examples/bounce_basic/bounce_basic.ino new file mode 100644 index 0000000..8bf1b3f --- /dev/null +++ b/examples/bounce_basic/bounce_basic.ino @@ -0,0 +1,70 @@ + +/* + DESCRIPTION + ==================== + Simple example of the Bounce library that switches a LED when + a state change (from HIGH to LOW) is triggered (for example when a button is pressed). + + Set BOUNCE_PIN to the pin attached to the input (a button for example). + Set LED_PIN to the pin attached to a LED. + +*/ + +// WE WILL attach() THE Bounce INSTANCE TO THE FOLLOWING PIN IN setup() +#define BOUNCE_PIN 2 + +// DEFINE THE PIN FOR THE LED : +// 1) SOME BOARDS HAVE A DEFAULT LED (LED_BUILTIN) +#define LED_PIN LED_BUILTIN +// 2) OTHERWISE SET YOUR OWN PIN +// #define LED_PIN 13 + +// Include the Bounce2 library found here : +// https://github.com/thomasfredericks/Bounce2 +#include + + +// INSTANTIATE A Bounce OBJECT +Bounce bounce = Bounce(); + +// SET A VARIABLE TO STORE THE LED STATE +bool ledState = LOW; + +void setup() { + + // BOUNCE SETUP + + // SELECT ONE OF THE FOLLOWING : + // 1) IF YOUR INPUT HAS AN INTERNAL PULL-UP + // bounce.attach( BOUNCE_PIN , INPUT_PULLUP ); // USE INTERNAL PULL-UP + // 2) IF YOUR INPUT USES AN EXTERNAL PULL-UP + bounce.attach( BOUNCE_PIN, INPUT ); // USE EXTERNAL PULL-UP + + // DEBOUNCE INTERVAL IN MILLISECONDS + bounce.interval(5); // interval in ms + + // LED SETUP + pinMode(LED_PIN, OUTPUT); + digitalWrite(LED_PIN, ledState); + +} + +void loop() { + // Update the Bounce instance (YOU MUST DO THIS EVERY LOOP) + bounce.update(); + + // .changed() RETURNS true IF THE STATE CHANGED (FROM HIGH TO LOW OR LOW TO HIGH) + if ( bounce.changed() ) { + // THE STATE OF THE INPUT CHANGED + // GET THE STATE + int deboucedInput = bounce.read(); + // IF THE CHANGED VALUE IS LOW + if ( deboucedInput == LOW ) { + ledState = !ledState; // SET ledState TO THE OPPOSITE OF ledState + digitalWrite(LED_PIN,ledState); // WRITE THE NEW ledState + } + } + + + +} diff --git a/examples/bounce_button/bounce_button.ino b/examples/bounce_button/bounce_button.ino new file mode 100644 index 0000000..a17a68c --- /dev/null +++ b/examples/bounce_button/bounce_button.ino @@ -0,0 +1,72 @@ + +/* + DESCRIPTION + ==================== + Pressing a physical button switches a LED on or off. + Simple example of the Button class from the Bounce library. + The Button class matches an electrical state to a physical action + with