-
Notifications
You must be signed in to change notification settings - Fork 3
/
ButtonKing.h
115 lines (87 loc) · 4.15 KB
/
ButtonKing.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
// -----
// ButtonKing.h - Library for detecting button clicks, doubleclicks, simple long
// press and double Long press pattern on a single button. This class is
// implemented for use with the Arduino environment.
// Copyright (c) by Tanyanat Pichitwong
// -----
// 08.07.2019 created by Tanyanat Pichitwong
// 09.07.2019 transformed into a library
// 23.02.2020 created new algorhythm
// -----
#ifndef ButtonKing_h
#define ButtonKing_h
#include "Arduino.h"
// ----- Callback function types -----
extern "C" {
typedef void (*callbackFunction)(void);
typedef void (*parameterizedCallbackFunction)(void*);
}
class ButtonKing
{
public:
// ----- Constructor -----
ButtonKing();
ButtonKing(int pin, int active, bool pullupActive = true);
// ----- Set runtime parameters -----
// set # millisec after safe click is assumed.
void setTimeDebounce(int ticks);
// set # millisec to ending the button-tickings counter.
void setTimeCount(int ticks);
// attach functions that will be called when button was pressed in the
// specified way.
void setClick(callbackFunction newFunction);
void setClick(parameterizedCallbackFunction newFunction, void* parameter);
void setPress(callbackFunction newFunction);
void setPress(parameterizedCallbackFunction newFunction, void* parameter);
void setRelease(callbackFunction newFunction);
void setRelease(parameterizedCallbackFunction newFunction, void* parameter);
void setDoubleClick(callbackFunction newFunction);
void setDoubleClick(parameterizedCallbackFunction newFunction, void* parameter);
void setDoublePress(callbackFunction newFunction);
void setDoublePress(parameterizedCallbackFunction newFunction, void* parameter);
void setTripleClick(callbackFunction newFunction);
void setTripleClick(parameterizedCallbackFunction newFunction, void* parameter);
void setTriplePress(callbackFunction newFunction);
void setTriplePress(parameterizedCallbackFunction newFunction, void* parameter);
void isClick(void);
void isClick(bool level);
int getPressedTimer(); // using to get how long the button was pressed.
void reset(void); // using to reset the library
private:
int _pin; // hardware pin number.
unsigned int _debounceTime = 10; // time to wait for debouncing.
unsigned int _waitTime = 500; // time to close the counter that counts
// the button pressing.
bool _intButtonStage; // intial stage of the button.
bool _newButtonStage; // new or current stage of the button.
int _debounceState = 0; // debounce function using machine stage.
int _buttonCount = 0; // total button ticks.
bool _buttonFlag = false; // to flag if callout function was run or not.
unsigned long _waitingTimer; // current time to end all of the function.
unsigned long _debounceTimer; // current time to end the debouncing.
unsigned long _pressedTimer; // time that the button start pressing.
unsigned long _stopPressedTimer; // time that the button stop pressing.
// These variables will hold functions acting as event source.
callbackFunction _ClickFunc = NULL;
parameterizedCallbackFunction _paramClickFunc = NULL;
void* _ClickFuncParam = NULL;
callbackFunction _PressFunc = NULL;
parameterizedCallbackFunction _paramPressFunc = NULL;
void* _PressFuncParam = NULL;
callbackFunction _ReleaseFunc = NULL;
parameterizedCallbackFunction _paramReleaseFunc = NULL;
void* _ReleaseFuncParam = NULL;
callbackFunction _DoubleClickFunc = NULL;
parameterizedCallbackFunction _paramDoubleClickFunc = NULL;
void* _DoubleClickFuncParam = NULL;
callbackFunction _DoublePressFunc = NULL;
parameterizedCallbackFunction _paramDoublePressFunc = NULL;
void* _DoublePressFuncParam = NULL;
callbackFunction _TripleClickFunc = NULL;
parameterizedCallbackFunction _paramTripleClickFunc = NULL;
void* _TripleClickFuncParam = NULL;
callbackFunction _TriplePressFunc = NULL;
parameterizedCallbackFunction _paramTriplePressFunc = NULL;
void* _TriplePressFuncParam = NULL;
};
#endif