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

Encoded4To2ButtonConfig.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_4TO2_BUTTON_CONFIG_H
26 #define ACE_BUTTON_ENCODED_4TO2_BUTTON_CONFIG_H
27
28 #include "ButtonConfig.h"
29
30 namespace ace_button {
31
47 class Encoded4To2ButtonConfig : public ButtonConfig {
48 public:
49
60 Encoded4To2ButtonConfig(uint8_t pin0, uint8_t pin1,
61 uint8_t defaultReleasedState = HIGH):
62 mPin0(pin0),
63 mPin1(pin1),
64 mPressedState(defaultReleasedState ^ 0x1) {}
65
71 int readButton(uint8_t pin) override {
72 int s0 = digitalRead(mPin0);
73 int s1 = digitalRead(mPin1);
74
75 // Convert the actual pins states into a binary number which becomes
76 // the encoded virtual pin numbers of the buttons.
77 uint8_t virtualPin = (s0 == mPressedState) | ((s1 == mPressedState) << 1);
78 return (virtualPin == pin) ? mPressedState : (mPressedState ^ 0x1);
79 }
80
81 private:
82 const uint8_t mPin0;
83 const uint8_t mPin1;
84 const uint8_t mPressedState;
85 };
86
87 }
88
89 #endif
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::Encoded4To2ButtonConfig
A ButtonConfig that handles an 4-to-2 binary encoder which converts 4 inputs into 2 outputs.
Definition: Encoded4To2ButtonConfig.h:47
ace_button::Encoded4To2ButtonConfig::readButton
int readButton(uint8_t pin) override
Return state of the encoded 'pin' number, corresponding to the pull-down states of the actual pins.
Definition: Encoded4To2ButtonConfig.h:71
ace_button::Encoded4To2ButtonConfig::Encoded4To2ButtonConfig
Encoded4To2ButtonConfig(uint8_t pin0, uint8_t pin1, uint8_t defaultReleasedState=HIGH)
Definition: Encoded4To2ButtonConfig.h:60