AceButton 1.10.0 An adjustable, compact, event-driven button library for Arduino.

EncodedButtonConfig.h
1 /*
2 MIT License
3
4 Copyright (c) 2020 Brian T. Park
5
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, 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,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24
25 #ifndef ACE_BUTTON_ENCODED_BUTTON_CONFIG_H
26 #define ACE_BUTTON_ENCODED_BUTTON_CONFIG_H
27
28 #include "ButtonConfig.h"
29
30 namespace ace_button {
31
32 class AceButton;
33
71 class EncodedButtonConfig : public ButtonConfig {
72 public:
73
92 EncodedButtonConfig(uint8_t numPins, const uint8_t pins[],
93 uint8_t numButtons, AceButton* const buttons[],
94 uint8_t defaultReleasedState = HIGH);
95
104 int readButton(uint8_t pin) override;
105
112 void checkButtons() const;
113
115 uint8_t getNoButtonPin() const {
116 return 0;
117 }
118
119 protected:
125 virtual uint8_t getVirtualPin() const;
126
127 private:
128 // Disable copy-constructor and assignment operator
129 EncodedButtonConfig(const EncodedButtonConfig&) = delete;
130 EncodedButtonConfig& operator=(const EncodedButtonConfig&) = delete;
131
132 private:
133 // Arranged for efficient packing on 32-bit processors
134 uint8_t const mNumPins;
135 uint8_t const mNumButtons;
136 uint8_t const mPressedState;
137 const uint8_t* const mPins;
138 AceButton* const* const mButtons;
139 };
140
141 }
142
143 #endif
ace_button::AceButton
An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...
Definition: AceButton.h:54
ace_button::ButtonConfig
Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...
Definition: ButtonConfig.h:66
ace_button::EncodedButtonConfig
A ButtonConfig that handles an N-to-M binary encoder where N = 2^M.
Definition: EncodedButtonConfig.h:71
ace_button::EncodedButtonConfig::readButton
int readButton(uint8_t pin) override
Return state of the virtual (i.e.
Definition: EncodedButtonConfig.cpp:44
ace_button::EncodedButtonConfig::EncodedButtonConfig
EncodedButtonConfig(uint8_t numPins, const uint8_t pins[], uint8_t numButtons, AceButton *const buttons[], uint8_t defaultReleasedState=HIGH)
Constructor.
Definition: EncodedButtonConfig.cpp:30
ace_button::EncodedButtonConfig::checkButtons
void checkButtons() const
Read the pins once, obtain the virtual pin number, then call each button's checkState() method to tri...
Definition: EncodedButtonConfig.cpp:49
ace_button::EncodedButtonConfig::getNoButtonPin
uint8_t getNoButtonPin() const
The virtual button pin number corresponding to "no button" pressed.
Definition: EncodedButtonConfig.h:115
ace_button::EncodedButtonConfig::getVirtualPin
virtual uint8_t getVirtualPin() const
Return the virtual pin number corresponding to the combinatorial states of the actual pins.
Definition: EncodedButtonConfig.cpp:64