General pushbutton class that handles debouncing. More...
#include <Pushbutton.h>
Public Member Functions | |
| void | waitForPress () |
| Waits until the button is pressed and takes care of debouncing. More... | |
| void | waitForRelease () |
| Waits until the button is released and takes care of debouncing. More... | |
| void | waitForButton () |
| Waits until the button is pressed and then waits until the button is released, taking care of debouncing. More... | |
| bool | getSingleDebouncedPress () |
| Uses a state machine to return true once after each time it detects the button moving from the released state to the pressed state. More... | |
| bool | getSingleDebouncedRelease () |
| Uses a state machine to return true once after each time it detects the button moving from the pressed state to the released state. More... | |
| virtual bool | isPressed ()=0 |
| indicates whether button is currently pressed without any debouncing. More... | |
Detailed Description
General pushbutton class that handles debouncing.
/*! This is an abstract class used for interfacing with pushbuttons. It knows about debouncing, but it knows nothing about how to read the current state of the button. The functions in this class get the current state of the button by calling isPressed(), a virtual function which must be implemented in a subclass of PushbuttonBase, such as Pushbutton.
Most users of this library do not need to directly use PushbuttonBase or even know that it exists. They can use Pushbutton instead.
Definition at line 70 of file Pushbutton.h.
Member Function Documentation
◆ getSingleDebouncedPress()
| bool PushbuttonBase::getSingleDebouncedPress | ( | ) |
Uses a state machine to return true once after each time it detects the button moving from the released state to the pressed state.
This is a non-blocking function that is meant to be called repeatedly in a loop. Each time it is called, it updates a state machine that monitors the state of the button. When it detects the button changing from the released state to the pressed state, with debouncing, it returns true.
Definition at line 110 of file Pushbutton.cpp.
◆ getSingleDebouncedRelease()
| bool PushbuttonBase::getSingleDebouncedRelease | ( | ) |
Uses a state machine to return true once after each time it detects the button moving from the pressed state to the released state.
This is just like getSingleDebouncedPress() except it has a separate state machine and it watches for when the button goes from the pressed state to the released state.
There is no strict guarantee that every debounced button press event returned by getSingleDebouncedPress() will have a corresponding button release event returned by getSingleDebouncedRelease(); the two functions use independent state machines and sample the button at different times.
Definition at line 115 of file Pushbutton.cpp.
◆ isPressed()
|
pure virtual |
indicates whether button is currently pressed without any debouncing.
- Returns
- 1 if the button is pressed right now, 0 if it is not.
This function must be implemented in a subclass of PushbuttonBase, such as Pushbutton.
Implemented in Pushbutton, AStar32U4ButtonC, and AStar32U4ButtonB.
◆ waitForButton()
| void PushbuttonBase::waitForButton | ( | ) |
Waits until the button is pressed and then waits until the button is released, taking care of debouncing.
This is equivalent to calling waitForPress() and then waitForRelease().
Definition at line 104 of file Pushbutton.cpp.
◆ waitForPress()
| void PushbuttonBase::waitForPress | ( | ) |
Waits until the button is pressed and takes care of debouncing.
This function waits until the button is in the pressed state and then returns. Note that if the button is already pressed when you call this function, it will return quickly (in 10 ms).
Definition at line 84 of file Pushbutton.cpp.
◆ waitForRelease()
| void PushbuttonBase::waitForRelease | ( | ) |
Waits until the button is released and takes care of debouncing.
This function waits until the button is in the released state and then returns. Note that if the button is already released when you call this function, it will return quickly (in 10 ms).
Definition at line 94 of file Pushbutton.cpp.
The documentation for this class was generated from the following files:
