|
AbleButtons V0.2.0
Lightweight button library for Arduino.
|
|
| |
|
AbleButtons V0.2.0
Lightweight button library for Arduino.
|
|
|
| |
The main include file for the Arduino Button library Extension (ABLE). More...
Go to the source code of this file.
Typedefs | |
| using | AblePulldownButton = able::Button< able::PulldownResistorCircuit, able::DebouncedPin > |
| AblePulldownButton provides basic button is-pressed capability for buttons connected using pulldown resistor circuits. More... | |
| using | AblePulldownCallbackButton = able::CallbackButton< able::Button< able::PulldownResistorCircuit, able::DebouncedPin > > |
| Shorthand for a callback button using a pulldown resistor. More... | |
| using | AblePulldownClickerButton = able::Button< able::PulldownResistorCircuit, able::ClickerPin > |
| AblePulldownClickerButton provides additional button-click capability to the is-pressed capability of a basic button. More... | |
| using | AblePulldownCallbackClickerButton = able::CallbackButton< able::Button< able::PulldownResistorCircuit, able::ClickerPin > > |
| AblePulldownCallbackClickerButton provides callback capability to a clicker button. More... | |
| using | AblePulldownDirectButton = able::Button< able::PulldownResistorCircuit, able::Pin > |
| AblePulldownDirectButton provides basic button is-pressed capability for buttons connected using pulldown resistor circuits. More... | |
| using | AblePulldownDoubleClickerButton = able::Button< able::PulldownResistorCircuit, able::DoubleClickerPin > |
| AblePulldownDoubleClickerButton provides additional double-click capability to the is-clicked capability of a clicker button. More... | |
| using | AblePulldownCallbackDoubleClickerButton = able::CallbackButton< able::Button< able::PulldownResistorCircuit, able::DoubleClickerPin > > |
| AblePulldownCallbackDoubleClickerButton provides additional double-click capability to the is-clicked capability of a clicker button. More... | |
| using | AblePulldownButtonList = able::ButtonList< AblePulldownButton > |
| AblePulldownButtonList allows an array of AblePulldownButton objects to be managed together. More... | |
| using | AblePulldownCallbackButtonList = able::ButtonList< AblePulldownCallbackButton > |
| AblePulldownCallbackButtonList allows an array of AblePulldownCallbackButton objects to be managed together. More... | |
| using | AblePulldownClickerButtonList = able::ButtonList< AblePulldownClickerButton > |
| AblePulldownClickerButtonList allows an array of AblePulldownClickerButton objects to be managed together. More... | |
| using | AblePulldownCallbackClickerButtonList = able::ButtonList< AblePulldownCallbackClickerButton > |
| AblePulldownCallbackClickerButtonList allows an array of AblePulldownCallbackClickerButton objects to be managed together. More... | |
| using | AblePulldownDirectButtonList = able::ButtonList< AblePulldownDirectButton > |
| AblePulldownDirectButtonList allows an array of AblePulldownDirectButton objects to be managed together. More... | |
| using | AblePulldownDoubleClickerButtonList = able::ButtonList< AblePulldownDoubleClickerButton > |
| AblePulldownDoubleClickerButtonList allows an array of AblePulldownDoubleClickerButton objects to be managed together. More... | |
| using | AblePulldownCallbackDoubleClickerButtonList = able::ButtonList< AblePulldownCallbackDoubleClickerButton > |
| AblePulldownCallbackDoubleClickerButtonList allows an array of AblePulldownCallbackDoubleClickerButton objects to be managed together. More... | |
| using | AblePullupButton = able::Button< able::PullupResistorCircuit, able::DebouncedPin > |
| AblePullupButton provides basic button is-pressed capability for buttons connected using pull-up resistor circuits. More... | |
| using | AblePullupCallbackButton = able::CallbackButton< able::Button< able::PullupResistorCircuit, able::DebouncedPin > > |
| Shorthand for a callback button using a pulldown resistor. More... | |
| using | AblePullupClickerButton = able::Button< able::PullupResistorCircuit, able::ClickerPin > |
| AblePullupClickerButton provides additional button-click capability to the is-pressed capability of a basic button. More... | |
| using | AblePullupCallbackClickerButton = able::CallbackButton< able::Button< able::PullupResistorCircuit, able::ClickerPin > > |
| Shorthand for clicker using pulldown resistor circuit. More... | |
| using | AblePullupDirectButton = able::Button< able::PullupResistorCircuit, able::Pin > |
| AblePullupDirectButton provides basic button is-pressed capability for buttons connected using pull-up resistor circuits. More... | |
| using | AblePullupDoubleClickerButton = able::Button< able::PullupResistorCircuit, able::DoubleClickerPin > |
| AblePullupDoubleClickerButton provides additional double-click capability to the is-clicked capability of a clicker button. More... | |
| using | AblePullupCallbackDoubleClickerButton = able::CallbackButton< able::Button< able::PullupResistorCircuit, able::DoubleClickerPin > > |
| AblePullupCallbackDoubleClickerButton provides additional double-click capability to the is-clicked capability of a clicker button. More... | |
| using | AblePullupButtonList = able::ButtonList< AblePullupButton > |
| Handler for list of AblePullupButton objects. More... | |
| using | AblePullupCallbackButtonList = able::ButtonList< AblePullupCallbackButton > |
| AblePullupCallbackButtonList allows an array of AblePullupCallbackButton objects to be managed together. More... | |
| using | AblePullupClickerButtonList = able::ButtonList< AblePullupClickerButton > |
| AblePullupClickerButtonList allows an array of AblePullupClickerButton objects to be managed together. More... | |
| using | AblePullupCallbackClickerButtonList = able::ButtonList< AblePullupCallbackClickerButton > |
| Handler for list of AblePulldownCallbackClicker objects. More... | |
| using | AblePullupDirectButtonList = able::ButtonList< AblePullupDirectButton > |
| AblePullupDirectButtonList allows an array of AblePullupDirectButton objects to be managed together. More... | |
| using | AblePullupDoubleClickerButtonList = able::ButtonList< AblePullupDoubleClickerButton > |
| AblePullupDoubleClickerButtonList allows an array of AblePullupDoubleClickerButton objects to be managed together. More... | |
| using | AblePullupCallbackDoubleClickerButtonList = able::ButtonList< AblePullupCallbackDoubleClickerButton > |
| AblePullupCallbackDoubleClickerButtonList allows an array of AblePullupCallbackDoubleClickerButton objects to be managed together. More... | |
The main include file for the Arduino Button library Extension (ABLE).
Include this file in an Arduino program to access all the available button classes.
It is recommended to then identify which button type is used with code similar to:
#include <AbleButtons.h> ... using Button = AblePullupButton; using ButtonList = AblePullupButtonList; ... Button btn(BUTTON_PIN);
Definition in file AbleButtons.h.
AblePulldownButton provides basic button is-pressed capability for buttons connected using pulldown resistor circuits.
Button presses are debounced to provide a reliable push/released signal.
Definition at line 32 of file AbleButtons.h.
AblePulldownButtonList allows an array of AblePulldownButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 102 of file AbleButtons.h.
| using AblePulldownCallbackButton = able::CallbackButton<able::Button<able::PulldownResistorCircuit, able::DebouncedPin> > |
Shorthand for a callback button using a pulldown resistor.
Definition at line 42 of file AbleButtons.h.
AblePulldownCallbackButtonList allows an array of AblePulldownCallbackButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 119 of file AbleButtons.h.
| using AblePulldownCallbackClickerButton = able::CallbackButton<able::Button<able::PulldownResistorCircuit, able::ClickerPin> > |
AblePulldownCallbackClickerButton provides callback capability to a clicker button.
A button click is a button-press, followed by a button-release. It also extends the button with callbacks on pressed and on released events. When the button is pressed, a user-supplied on-pressed function can be called with the id of the button. The id can be used with the AblePulldownCallbackClickerButtonList class to retrieve a pointer to the clicker button generating the callback. Similarly, when the button is released, a user-supplied on-released function can be called. As with basic button capabilities, button presses are debounced to provide a reliable push/ released signal.
Definition at line 64 of file AbleButtons.h.
AblePulldownCallbackClickerButtonList allows an array of AblePulldownCallbackClickerButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 137 of file AbleButtons.h.
| using AblePulldownCallbackDoubleClickerButton = able::CallbackButton<able::Button<able::PulldownResistorCircuit, able::DoubleClickerPin> > |
AblePulldownCallbackDoubleClickerButton provides additional double-click capability to the is-clicked capability of a clicker button.
A button double- click is a second click (button-press, followed by a button-release) within the double-click time. As with other button capabilities, button presses are debounced to provide a reliable push/released signal.
Definition at line 90 of file AbleButtons.h.
| using AblePulldownCallbackDoubleClickerButtonList = able::ButtonList<AblePulldownCallbackDoubleClickerButton> |
AblePulldownCallbackDoubleClickerButtonList allows an array of AblePulldownCallbackDoubleClickerButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 164 of file AbleButtons.h.
AblePulldownClickerButton provides additional button-click capability to the is-pressed capability of a basic button.
A button click is a button-press, followed by a button-release. As with basic button capabilities, button presses are debounced to provide a reliable push/released signal.
Definition at line 50 of file AbleButtons.h.
AblePulldownClickerButtonList allows an array of AblePulldownClickerButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 128 of file AbleButtons.h.
AblePulldownDirectButton provides basic button is-pressed capability for buttons connected using pulldown resistor circuits.
Button presses are not debounced so provide potentially unreliable push/released signals when pressed or released due to contact bouncing.
Definition at line 72 of file AbleButtons.h.
AblePulldownDirectButtonList allows an array of AblePulldownDirectButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 146 of file AbleButtons.h.
| using AblePulldownDoubleClickerButton = able::Button<able::PulldownResistorCircuit, able::DoubleClickerPin> |
AblePulldownDoubleClickerButton provides additional double-click capability to the is-clicked capability of a clicker button.
A button double-click is a second click (button-press, followed by a button-release) within the double- click time. As with other button capabilities, button presses are debounced to provide a reliable push/released signal.
Definition at line 81 of file AbleButtons.h.
AblePulldownDoubleClickerButtonList allows an array of AblePulldownDoubleClickerButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 155 of file AbleButtons.h.
AblePullupButton provides basic button is-pressed capability for buttons connected using pull-up resistor circuits.
Button presses are debounced to provide a reliable push/released signal.
Definition at line 175 of file AbleButtons.h.
Handler for list of AblePullupButton objects.
Definition at line 245 of file AbleButtons.h.
| using AblePullupCallbackButton = able::CallbackButton<able::Button<able::PullupResistorCircuit, able::DebouncedPin> > |
Shorthand for a callback button using a pulldown resistor.
Definition at line 185 of file AbleButtons.h.
AblePullupCallbackButtonList allows an array of AblePullupCallbackButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 254 of file AbleButtons.h.
| using AblePullupCallbackClickerButton = able::CallbackButton<able::Button<able::PullupResistorCircuit, able::ClickerPin> > |
Shorthand for clicker using pulldown resistor circuit.
Definition at line 207 of file AbleButtons.h.
Handler for list of AblePulldownCallbackClicker objects.
Definition at line 272 of file AbleButtons.h.
| using AblePullupCallbackDoubleClickerButton = able::CallbackButton<able::Button<able::PullupResistorCircuit, able::DoubleClickerPin> > |
AblePullupCallbackDoubleClickerButton provides additional double-click capability to the is-clicked capability of a clicker button.
A button double-click is a second click (button-press, followed by a button-release) within the double- click time. As with other button capabilities, button presses are debounced to provide a reliable push/released signal.
Definition at line 233 of file AbleButtons.h.
| using AblePullupCallbackDoubleClickerButtonList = able::ButtonList<AblePullupCallbackDoubleClickerButton> |
AblePullupCallbackDoubleClickerButtonList allows an array of AblePullupCallbackDoubleClickerButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 298 of file AbleButtons.h.
AblePullupClickerButton provides additional button-click capability to the is-pressed capability of a basic button.
A button click is a button-press, followed by a button-release. As with basic button capabilities, button presses are debounced to provide a reliable push/released signal.
Definition at line 193 of file AbleButtons.h.
AblePullupClickerButtonList allows an array of AblePullupClickerButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 263 of file AbleButtons.h.
AblePullupDirectButton provides basic button is-pressed capability for buttons connected using pull-up resistor circuits.
Button presses are not debounced so provide potentially unreliable push/released signals when pressed or released due to contact bouncing.
Definition at line 215 of file AbleButtons.h.
AblePullupDirectButtonList allows an array of AblePullupDirectButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 280 of file AbleButtons.h.
| using AblePullupDoubleClickerButton = able::Button<able::PullupResistorCircuit, able::DoubleClickerPin> |
AblePullupDoubleClickerButton provides additional double-click capability to the is-clicked capability of a clicker button.
A button double-click is a second click (button-press, followed by a button-release) within the double- click time. As with other button capabilities, button presses are debounced to provide a reliable push/released signal.
Definition at line 224 of file AbleButtons.h.
AblePullupDoubleClickerButtonList allows an array of AblePullupDoubleClickerButton objects to be managed together.
Rather than calling begin() and handle() methods for each button, call the begin() and handle() method of the button list object, which calls the begin() and handle() methods of each button in the list.
Definition at line 289 of file AbleButtons.h.
1.9.5