PETCTL/GyverEncoder.h at github · mvbasov/PETCTL · GitHub

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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
#ifndef GyverEncoder_h
#define GyverEncoder_h
#include <Arduino.h>

/*
	GyverEncoder - библиотека для отработки энкодера.
	Документация: https://alexgyver.ru/encoder/
	Возможности:
	- Отработка поворота энкодера
	- Отработка "нажатого поворота"
	- Отработка "быстрого поворота"
	- Несколько алгоритмов опроса энкодера
	- Выбор подтяжки подключения энкодера
	- Работа с двумя типами экнодеров
	- Работа с внешним энкодером (через расширитель пинов и т.п.)
	- Отработка нажатия/удержания кнопки с антидребезгом

	Версии:
	- 3.6 от 16.09.2019	- Возвращены дефайны настроек
	- 4.0 от 13.11.2019
		- Оптимизирован код
		- Исправлены баги
		- Добавлены другие алгоритмы опроса
		- Добавлена возможность полностью убрать кнопку (экономия памяти)
		- Добавлена возможность подключения внешнего энкодера
		- Добавлена настройка подтяжки пинов

	- 4.1: Исправлено изменение подтяжек

	- 4.2
		- Добавлена поддержка TYPE1 для алгоритма PRECISE_ALGORITHM
		- Добавлена отработка двойного клика: isSingle / isDouble

	- 4.3: Исправлено ложное isSingle
	- 4.4: Добавлен метод resetStates, сбрасывает все is-флаги и счётчики
	- 4.5: Улучшен алгоритм BINARY_ALGORITHM (спасибо Ярославу Курусу)
	- 4.6: BINARY_ALGORITHM пофикшен для TYPE1, добавлена isReleaseHold
	- 4.7: Исправлен случайный нажатый поворот в BINARY_ALGORITHM
	- 4.8: увеличена производительность для AVR Arduino
	- 4.9: быстрый поворот отключен если кнопка удерживается
*/
// ========= КОНСТАНТЫ ==========
#define ENC_NO_BUTTON -1	// константа для работы без пина
#define TYPE1 0			// полушаговый энкодер
#define TYPE2 1			// полношаговый
#define NORM 0			// направление вращения обычное
#define REVERSE 1		// обратное
#define MANUAL 0		// нужно вызывать функцию tick() вручную
#define AUTO 1			// tick() входит во все остальные функции и опрашивается сама!
#define HIGH_PULL 0		// внутренняя подтяжка к питанию (pinMode INPUT_PULLUP)
#define LOW_PULL 1		// внешняя подтяжка к GND (pinMode INPUT)

// =========== НАСТРОЙКИ ===========
// закомментируй строку, чтобы полностью убрать отработку кнопки из кода
#define ENC_WITH_BUTTON

// тип подключения энкодера по умолчанию (LOW_PULL или HIGH_PULL)
//#define DEFAULT_ENC_PULL LOW_PULL
#define DEFAULT_ENC_PULL HIGH_PULL

// тип подключения кнопки энкодера по умолчанию (LOW_PULL или HIGH_PULL)
//#define DEFAULT_BTN_PULL LOW_PULL
#define DEFAULT_BTN_PULL HIGH_PULL

// алгоритмы опроса энкодера (раскомментировать нужный)
//#define FAST_ALGORITHM		// тик 10 мкс, быстрый, не справляется с люфтами
#define BINARY_ALGORITHM	// тик 14 мкс, лучше справляется с люфтами
//#define PRECISE_ALGORITHM	// тик 16 мкс, работает даже с убитым энкодером (по мотивам https://github.com/mathertel/RotaryEncoder)

// настройка антидребезга энкодера, кнопки, таймаута удержания и таймаута двойного клика
#define ENC_DEBOUNCE_TURN 0
#define ENC_DEBOUNCE_BUTTON 80
#define ENC_HOLD_TIMEOUT 700
#define ENC_DOUBLE_TIMEOUT 300

#if defined(__AVR__)
#define _readCLK() bool(*_pin_reg_CLK & _bit_mask_CLK)
#define _readDT() bool(*_pin_reg_DT & _bit_mask_DT)
#define _readSW() bool(*_pin_reg_SW & _bit_mask_SW)
#else
#define _readCLK() digitalRead(_CLK)
#define _readDT() digitalRead(_DT)
#define _readSW() digitalRead(_SW)
#endif

#pragma pack(push,1)
typedef struct
{
	bool hold_flag: 1;
	bool butt_flag: 1;
	bool turn_flag: 1;
	bool isTurn_f: 1;
	bool isPress_f: 1;
	bool isRelease_f: 1;
	bool isReleaseHold_f: 1;
	bool isHolded_f: 1;
	bool isFastR_f: 1;
	bool isFastL_f: 1;
	bool enc_tick_mode: 1;
	bool enc_type: 1;
	bool use_button : 1;
	bool extCLK : 1;
	bool extDT : 1;
	bool extSW : 1;
	bool invBtn : 1;
	bool isSingle_f : 1;
	bool isDouble_f : 1;
	bool countFlag : 1;
	bool doubleFlag : 1;
	bool doubleAllow : 1;
	bool rst_flag : 1;
} GyverEncoderFlags;
#pragma pack(pop)

// Варианты инициализации:
// Encoder enc;									// не привязан к пину
// Encoder enc(пин CLK, пин DT);				// энкодер без кнопки (ускоренный опрос)
// Encoder enc(пин CLK, пин DT, пин SW);		// энкодер с кнопкой
// Encoder enc(пин CLK, пин DT, пин SW, тип);	// энкодер с кнопкой и указанием типа
// Encoder enc(пин CLK, пин DT, ENC_NO_BUTTON, тип);	// энкодер без кнопкой и с указанием типа

class Encoder {
public:
	Encoder();								// для непривязанного к пинам энкодера
	Encoder(uint8_t clk, uint8_t dt, int8_t sw = -1, bool type = false); // CLK, DT, SW, тип (TYPE1 / TYPE2) TYPE1 одношаговый, TYPE2 двухшаговый. Если ваш энкодер работает странно, смените тип

	void tick();							// опрос энкодера, нужно вызывать постоянно или в прерывании
	void tick(bool clk, bool dt, bool sw = 0);	// опрос "внешнего" энкодера
	void setType(bool type);				// TYPE1 / TYPE2 - тип энкодера TYPE1 одношаговый, TYPE2 двухшаговый. Если ваш энкодер работает странно, смените тип
	void setPinMode(bool mode);				// тип подключения энкодера, подтяжка HIGH_PULL (внутренняя) или LOW_PULL (внешняя на GND)
	void setBtnPinMode(bool mode);			// тип подключения кнопки, подтяжка HIGH_PULL (внутренняя) или LOW_PULL (внешняя на GND)
	void setTickMode(bool tickMode); 		// MANUAL / AUTO - ручной или автоматический опрос энкодера функцией tick(). (по умолчанию ручной)
	void setDirection(bool direction);		// NORM / REVERSE - направление вращения энкодера
	void setFastTimeout(uint16_t timeout);	// установка таймаута быстрого поворота

	boolean isTurn();						// возвращает true при любом повороте, сама сбрасывается в false
	boolean isRight();						// возвращает true при повороте направо, сама сбрасывается в false
	boolean isLeft();						// возвращает true при повороте налево, сама сбрасывается в false
	boolean isRightH();						// возвращает true при удержании кнопки и повороте направо, сама сбрасывается в false
	boolean isLeftH();						// возвращает true при удержании кнопки и повороте налево, сама сбрасывается в false
	boolean isFastR();						// возвращает true при быстром повороте
	boolean isFastL();						// возвращает true при быстром повороте

	boolean isPress();						// возвращает true при нажатии кнопки, сама сбрасывается в false
	boolean isRelease();					// возвращает true при отпускании кнопки, сама сбрасывается в false
	boolean isReleaseHold();				// возвращает true при отпускании кнопки после удержания, сама сбрасывается в false
	boolean isClick();						// возвращает true при нажатии и отпускании кнопки, сама сбрасывается в false
	boolean isHolded();						// возвращает true при удержании кнопки, сама сбрасывается в false
	boolean isHold();						// возвращает true при удержании кнопки, НЕ СБРАСЫВАЕТСЯ
	boolean isSingle();						// возвращает true при одиночном клике (после таймаута), сама сбрасывается в false
	boolean isDouble();						// возвращает true при двойном клике, сама сбрасывается в false

	void resetStates();						// сбрасывает все is-флаги и счётчики

private:
	GyverEncoderFlags flags;
	uint8_t _fast_timeout = 50;				// таймаут быстрого поворота
	uint8_t prevState = 0;
	uint8_t encState = 0;	// 0 не крутился, 1 лево, 2 право, 3 лево нажат, 4 право нажат
	uint32_t debounce_timer = 0, fast_timer = 0;
	uint8_t _CLK = 0, _DT = 0, _SW = 0;
	bool turnFlag = false, extTick = false, SW_state = false;
#if defined(__AVR__)
	volatile uint8_t *_pin_reg_CLK;
	volatile uint8_t _bit_mask_CLK;
	volatile uint8_t *_pin_reg_DT;
	volatile uint8_t _bit_mask_DT;
	volatile uint8_t *_pin_reg_SW;
	volatile uint8_t _bit_mask_SW;
#endif
};
#endif