AceButton  1.4.2
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 
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 
114  protected:
120  virtual uint8_t getVirtualPin() const;
121 
122  private:
123  // Disable copy-constructor and assignment operator
124  EncodedButtonConfig(const EncodedButtonConfig&) = delete;
125  EncodedButtonConfig& operator=(const EncodedButtonConfig&) = delete;
126 
127  private:
128  // Arranged for efficient packing on 32-bit processors
129  uint8_t const mNumPins;
130  uint8_t const mNumButtons;
131  uint8_t const mPressedState;
132  const uint8_t* const mPins;
133  AceButton* const* const mButtons;
134 };
135 
136 }
137 
138 #endif
int readButton(uint8_t pin) override
Return state of the encoded 'pin' number, corresponding to the pull-down states of the actual pins...
void checkButtons() const
Read the pins once, obtain the virtual pin number, then call each button's checkState() method to tri...
A ButtonConfig that handles an N-to-M binary encoder where N = 2^M.
EncodedButtonConfig(uint8_t numPins, const uint8_t pins[], uint8_t numButtons, AceButton *const buttons[], uint8_t defaultReleasedState=HIGH)
Constructor.
Class that defines the timing parameters and event handler of an AceButton or a group of AceButton in...
Definition: ButtonConfig.h:56
virtual uint8_t getVirtualPin() const
Return the virtual pin number corresponding to the combinatorial states of the actual pins...
An Adjustable Compact Event-driven (ACE) Button library that debounces and dispatches button events t...
Definition: AceButton.h:50