diff --git a/docs/files/_bounce2_8h_source.html b/docs/files/_bounce2_8h_source.html index c1decaf..bd592c8 100644 --- a/docs/files/_bounce2_8h_source.html +++ b/docs/files/_bounce2_8h_source.html @@ -2,8 +2,8 @@
- - + +| + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
Basic example of the Bounce class.
+Basic example of the Bounce class.
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
Basic example of the Button class.
+Basic example of the Button class.
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
This is the complete list of members for Bounce, including all inherited members.
| attach(int pin, int mode) | Bounce | |
| attach(int pin) | Bounce | |
| attach(int pin) | Bounce | |
| begin() (defined in Debouncer) | Debouncer | protected |
| Bounce() | Bounce | |
| Bounce() | Bounce | |
| Bounce(uint8_t pin, unsigned long interval_millis) (defined in Bounce) | Bounce | inline |
| changed() const | Debouncer | inline |
| changed() const | Debouncer | inline |
| currentDuration() const | Debouncer | |
| Debouncer() | Debouncer | |
| durationOfPreviousState (defined in Debouncer) | Debouncer | protected |
| fallingEdge() const | Bounce | inline |
| fell() const | Debouncer | |
| getPin() const | Bounce | inline |
| interval(uint16_t interval_millis) | Debouncer | |
| interval_millis (defined in Debouncer) | Debouncer | protected |
| pin | Bounce | protected |
| previous_millis (defined in Debouncer) | Debouncer | protected |
| previousDuration() const | Debouncer | |
| read() const | Debouncer | |
| readCurrentState() (defined in Bounce) | Bounce | inlineprotectedvirtual |
| risingEdge() const | Bounce | inline |
| rose() const | Debouncer | |
| setPinMode(int pin, int mode) (defined in Bounce) | Bounce | inlineprotectedvirtual |
| state (defined in Debouncer) | Debouncer | protected |
| stateChangeLastTime (defined in Debouncer) | Debouncer | protected |
| update() | Debouncer | |
| Debouncer() | Debouncer | |
| duration() const | Debouncer | |
| durationOfPreviousState (defined in Debouncer) | Debouncer | protected |
| fallingEdge() const | Bounce | inline |
| fell() const | Debouncer | |
| getPin() const | Bounce | inline |
| interval(uint16_t interval_millis) | Debouncer | |
| interval_millis (defined in Debouncer) | Debouncer | protected |
| pin | Bounce | protected |
| previous_millis (defined in Debouncer) | Debouncer | protected |
| previousDuration() const | Debouncer | |
| read() const | Debouncer | |
| readCurrentState() (defined in Bounce) | Bounce | inlineprotectedvirtual |
| risingEdge() const | Bounce | inline |
| rose() const | Debouncer | |
| setPinMode(int pin, int mode) (defined in Bounce) | Bounce | inlineprotectedvirtual |
| state (defined in Debouncer) | Debouncer | protected |
| stateChangeLastTime (defined in Debouncer) | Debouncer | protected |
| update() | Debouncer |
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
+Public Member Functions | Bounce () | | |||||
| void | attach (int pin) | ||||||
| + | |||||||
| Bounce (uint8_t pin, unsigned long interval_millis) | |||||||
| int | getPin () const | ||||||
| Return pin that this Bounce is attached to. More... | |||||||
| -bool | risingEdge () const | ||||||
| +bool | risingEdge () const | ||||||
| Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1. | |||||||
| -bool | fallingEdge () const | ||||||
| +bool | fallingEdge () const | ||||||
| Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1. | |||||||
Public Member Functions inherited from Debouncer | bool | read () const | |||||
| Returns the pin's state (HIGH or LOW). More... | |||||||
| -bool | fell () const | ||||||
| +bool | fell () const | ||||||
| Returns true if pin signal transitions from high to low. | |||||||
| -bool | rose () const | ||||||
| +bool | rose () const | ||||||
| Returns true if pin signal transitions from low to high. | |||||||
| bool | changed () const | unsigned long | currentDuration () const | ||||
| Returns the duration in milliseconds of the current state. More... | |||||||
| unsigned long | duration () const | ||||||
| Returns the duration in milliseconds of the current state. More... | |||||||
| unsigned long | previousDuration () const | ||||||
| Returns the duration in milliseconds of the previous state. More... | |||||||
+Protected Member Functions
-virtual bool | readCurrentState () | | Protected Member Functions inherited from Debouncer |
+virtual bool | readCurrentState ()=0 | | virtual bool | readCurrentState () | + | virtual void | setPinMode (int pin, int mode) | + | void | begin () | |||||||||||
+Protected Attributes
-uint8_t | pin | Protected Attributes inherited from Debouncer | | | | | +uint8_t | pin | Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1. | + | unsigned long | previous_millis | + | uint16_t | interval_millis | + | uint8_t | state | + | unsigned long | stateChangeLastTime | + | unsigned long | durationOfPreviousState | ||||||||||||||
The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. This class is odly named, but it will be kept that so it stays compatible with previous code.
+The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. This class is odly named, but it will be kept that so it stays compatible with previous code.
Create an instance of the Bounce class.
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).
+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).
Return pin that this Bounce is attached to.
+
|
+ +inlineprotectedvirtual | +
Implements Debouncer.
+
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
This is the complete list of members for Bounce2::Button, including all inherited members.
| attach(int pin, int mode) | Bounce | |
| attach(int pin) | Bounce | |
| attach(int pin) | Bounce | |
| begin() (defined in Debouncer) | Debouncer | protected |
| Bounce() | Bounce | |
| Bounce() | Bounce | |
| Bounce(uint8_t pin, unsigned long interval_millis) (defined in Bounce) | Bounce | inline |
| Button() | Bounce2::Button | inline |
| Button() | Bounce2::Button | inline |
| changed() const | Debouncer | inline |
| currentDuration() const | Debouncer | |
| currentDuration() const | Debouncer | |
| Debouncer() | Debouncer | |
| durationOfPreviousState (defined in Debouncer) | Debouncer | protected |
| fallingEdge() const | Bounce | inline |
| fell() const | Debouncer | |
| getPin() const | Bounce | inline |
| getPressedState() const | Bounce2::Button | inline |
| interval(uint16_t interval_millis) | Debouncer | |
| interval_millis (defined in Debouncer) | Debouncer | protected |
| isPressed() const | Bounce2::Button | inline |
| pin | Bounce | protected |
| pressed() const | Bounce2::Button | inline |
| previous_millis (defined in Debouncer) | Debouncer | protected |
| previousDuration() const | Debouncer | |
| read() const | Debouncer | |
| readCurrentState() (defined in Bounce) | Bounce | inlineprotectedvirtual |
| released() const | Bounce2::Button | inline |
| risingEdge() const | Bounce | inline |
| rose() const | Debouncer | |
| setPinMode(int pin, int mode) (defined in Bounce) | Bounce | inlineprotectedvirtual |
| setPressedState(bool state) | Bounce2::Button | inline |
| state (defined in Debouncer) | Debouncer | protected |
| stateChangeLastTime (defined in Debouncer) | Debouncer | protected |
| stateForPressed (defined in Bounce2::Button) | Bounce2::Button | protected |
| update() | Debouncer | |
| duration() const | Debouncer | |
| durationOfPreviousState (defined in Debouncer) | Debouncer | protected |
| fallingEdge() const | Bounce | inline |
| fell() const | Debouncer | |
| getPin() const | Bounce | inline |
| getPressedState() const | Bounce2::Button | inline |
| interval(uint16_t interval_millis) | Debouncer | |
| interval_millis (defined in Debouncer) | Debouncer | protected |
| isPressed() const | Bounce2::Button | inline |
| pin | Bounce | protected |
| pressed() const | Bounce2::Button | inline |
| previous_millis (defined in Debouncer) | Debouncer | protected |
| previousDuration() const | Debouncer | |
| read() const | Debouncer | |
| readCurrentState() (defined in Bounce) | Bounce | inlineprotectedvirtual |
| released() const | Bounce2::Button | inline |
| risingEdge() const | Bounce | inline |
| rose() const | Debouncer | |
| setPinMode(int pin, int mode) (defined in Bounce) | Bounce | inlineprotectedvirtual |
| setPressedState(bool state) | Bounce2::Button | inline |
| state (defined in Debouncer) | Debouncer | protected |
| stateChangeLastTime (defined in Debouncer) | Debouncer | protected |
| stateForPressed (defined in Bounce2::Button) | Bounce2::Button | protected |
| update() | Debouncer |
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
+Public Member Functions | Button () | | |||||
| 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 | getPressedState () const | ||||||
| +bool | getPressedState () const | ||||||
| Get the electrical state (HIGH/LOW) that corresponds to a physical press. | |||||||
| -bool | isPressed () const | ||||||
| +bool | isPressed () const | ||||||
| Returns true if the button is currently physically pressed. | |||||||
| -bool | pressed () const | ||||||
| +bool | pressed () const | ||||||
| Returns true if the button was physically pressed | |||||||
| -bool | released () const | ||||||
| +bool | released () const | ||||||
| Returns true if the button was physically released | |||||||
| void | attach (int pin) | ||||||
| + | |||||||
| Bounce (uint8_t pin, unsigned long interval_millis) | |||||||
| int | getPin () const | ||||||
| Return pin that this Bounce is attached to. More... | |||||||
| -bool | risingEdge () const | ||||||
| +bool | risingEdge () const | ||||||
| Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1. | |||||||
| -bool | fallingEdge () const | ||||||
| +bool | fallingEdge () const | ||||||
| Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1. | |||||||
Public Member Functions inherited from Debouncer | bool | read () const | |||||
| Returns the pin's state (HIGH or LOW). More... | |||||||
| -bool | fell () const | ||||||
| +bool | fell () const | ||||||
| Returns true if pin signal transitions from high to low. | |||||||
| -bool | rose () const | ||||||
| +bool | rose () const | ||||||
| Returns true if pin signal transitions from low to high. | |||||||
| bool | changed () const | unsigned long | currentDuration () const | ||||
| Returns the duration in milliseconds of the current state. More... | |||||||
| unsigned long | duration () const | ||||||
| Returns the duration in milliseconds of the current state. More... | |||||||
| unsigned long | previousDuration () const | ||||||
| Returns the duration in milliseconds of the previous state. More... | |||||||
+Protected Attributes Protected Attributes inherited from Bounce
-uint8_t | pin | Protected Attributes inherited from Debouncer | | | | | + | bool | stateForPressed = 1 | +uint8_t | pin | Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1. | + | unsigned long | previous_millis | + | uint16_t | interval_millis | + | uint8_t | state | + | unsigned long | stateChangeLastTime | + | unsigned long | durationOfPreviousState | ||||||||||||||||||
+Additional Inherited Membersvirtual bool | readCurrentState () |
+ |
virtual void | setPinMode (int pin, int mode) | |
+ |
void | begin () | | | |||||||||||||||||
Protected Member Functions inherited from Bounce
Protected Member Functions inherited from Debouncer
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
This is the complete list of members for Debouncer, including all inherited members.
| begin() (defined in Debouncer) | Debouncer | protected |
| changed() const | Debouncer | inline |
| changed() const | Debouncer | inline |
| currentDuration() const | Debouncer | |
| Debouncer() | Debouncer | |
| durationOfPreviousState (defined in Debouncer) | Debouncer | protected |
| fell() const | Debouncer | |
| interval(uint16_t interval_millis) | Debouncer | |
| interval_millis (defined in Debouncer) | Debouncer | protected |
| previous_millis (defined in Debouncer) | Debouncer | protected |
| previousDuration() const | Debouncer | |
| read() const | Debouncer | |
| readCurrentState()=0 (defined in Debouncer) | Debouncer | protectedpure virtual |
| rose() const | Debouncer | |
| state (defined in Debouncer) | Debouncer | protected |
| stateChangeLastTime (defined in Debouncer) | Debouncer | protected |
| update() | Debouncer | |
| Debouncer() | Debouncer | |
| duration() const | Debouncer | |
| durationOfPreviousState (defined in Debouncer) | Debouncer | protected |
| fell() const | Debouncer | |
| interval(uint16_t interval_millis) | Debouncer | |
| interval_millis (defined in Debouncer) | Debouncer | protected |
| previous_millis (defined in Debouncer) | Debouncer | protected |
| previousDuration() const | Debouncer | |
| read() const | Debouncer | |
| readCurrentState()=0 (defined in Debouncer) | Debouncer | protectedpure virtual |
| rose() const | Debouncer | |
| state (defined in Debouncer) | Debouncer | protected |
| stateChangeLastTime (defined in Debouncer) | Debouncer | protected |
| update() | Debouncer |
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
+Public Member Functions | Debouncer () | | |||||
| bool | read () const | ||||||
| Returns the pin's state (HIGH or LOW). More... | |||||||
| -bool | fell () const | ||||||
| +bool | fell () const | ||||||
| Returns true if pin signal transitions from high to low. | |||||||
| -bool | rose () const | ||||||
| +bool | rose () const | ||||||
| Returns true if pin signal transitions from low to high. | |||||||
| bool | changed () const | unsigned long | currentDuration () const | ||||
| Returns the duration in milliseconds of the current state. More... | |||||||
| unsigned long | duration () const | ||||||
| Returns the duration in milliseconds of the current state. More... | |||||||
| unsigned long | previousDuration () const | ||||||
| Returns the duration in milliseconds of the previous state. More... | |||||||
+Protected Member Functions | | + | void | begin () | + | virtual bool | readCurrentState ()=0 | ||||||
+Protected Attributes | | | | | + | unsigned long | previous_millis | + | uint16_t | interval_millis | + | uint8_t | state | + | unsigned long | stateChangeLastTime | + | unsigned long | durationOfPreviousState | |||||||||
The Debouce class. Just the deboucing code separated from all harware.
+The Debouce class. Just the deboucing code separated from all harware.
Returns the duration in milliseconds of the current state.
-Is reset to 0 once the pin rises ( rose() ) or falls ( fell() ).
+Is reset to 0 once the pin rises ( rose() ) or falls ( fell() ).
| unsigned long Debouncer::duration | +( | +) | +const | +
Returns the duration in milliseconds of the current state.
+Is reset to 0 once the pin rises ( rose() ) or falls ( fell() ).
+This function is deprecated in favor of currentDuration() and may be removed in future versions.
+Returns the duration in milliseconds of the previous state.
-Takes the values of duration() once the pin changes state.
+Takes the values of duration() once the pin changes state.
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().
+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().
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
+Files | |
| file | Bounce2.h [code] |
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
- 1.8.17
+Generated by | + |
|
Bounce2
|
@@ -29,21 +29,22 @@
Debouncing library for Arduino and Wiring by Thomas Ouellet Fredericks with many contributions from the community : https://github.com/thomasfredericks/Bounce2/graphs/contributors
-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:
Debouncing library for Arduino and Wiring by Thomas Ouellet Fredericks with many contributions from the community : https://github.com/thomasfredericks/Bounce2/graphs/contributors
+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:
See the bottom of this page for a basic usage example and the "examples" folder for more.
-The library is composed of three classes:
See the bottom of this page for a basic usage example and the "examples" folder for more.
+The library is composed of three classes:
Install through your software's Library Manager or download the latest version here and put the "Bounce2" folder in your "libraries" folder.
-Please note that the original version of this library (Bounce 1) is included in the "extras" folder of the download but not supported anymore.
+Install through your software's Library Manager or download the latest version here and put the "Bounce2" folder in your "libraries" folder.
+Please note that the original version of this library (Bounce 1) is included in the "extras" folder of the download but not supported anymore.
The complete class documentation can be found in the "docs" folder or online here.
+The complete class documentation can be found in the "docs" folder or online here.
https://github.com/thomasfredericks/Bounce2
+https://github.com/thomasfredericks/Bounce2
Please post your questions here.
+Please post your questions here.
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.
+
By defining "#define BOUNCE_LOCK_OUT" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. This method is a lot more responsive, but does not cancel noise.
+By defining "#define BOUNCE_LOCK_OUT" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. This method is a lot more responsive, but does not cancel noise.


By defining "#define BOUNCE_WITH_PROMPT_DETECTION" in "Bounce.h" (or in your code before including "Bounce.h") you can activate an alternative debouncing method. Button state changes are available immediately so long as the previous state has been stable for the timeout period. Otherwise the state will be updated as soon as the timeout period allows.
+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.
- 1.8.17
+Generated by The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action. More...
+Classesclass | Button | | | ||||
The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action.
+
- 1.8.17
+Generated by