upd

Author: GyverLibs

README.md

@@ -260,19 +260,22 @@ void setPins(uint8_t mode, uint8_t P1, uint8_t P2, uint8_t P3);     // наст
 - Основная идея работы: "тикнули", а затем вручную через условия опрашиваем нужные действия кнопки/энкодера. Почти все функции опроса имеют механизм "однократного срабатывания", то есть возвращают `true` и автоматически сбрасываются в `false` до наступления следующего события. Таким образом конструкция `if (btn.click())` позволяет выполнить какой-то блок кода однократно по клику. Подробнее разберём ниже.
 
 #### Кнопка
-- `press()` - кнопка была нажата (с антидребезгом). *[однократно вернёт true]*
+- `press()` - кнопка была нажата. *[однократно вернёт true]*
 - `release()` - кнопка была отпущена. *[однократно вернёт true]*
-- `click()` - кнопка была кликнута, т.е. коротко нажата и отпущена (удерживалась больше времени антидребезга, но меньше таймаута удержания). *[однократно вернёт true]*
-- `held()` - кнопка была удержана дольше `setHoldTimeout()` таймаута. *[однократно вернёт true]*
-- `hold()` - кнопка была удержана дольше `setHoldTimeout()` таймаута. *[возвращает true, пока удерживается]*
-- `step()` - режим "импульсного удержания": после удержания кнопки дольше таймаута данная функция *[возвращает true с периодом EB_STEP]*. Удобно использовать для пошагового изменения какой-то величины в программе: `if (btn.step()) val++;`.
-- `step(clicks)` - всё то же самое, но функция принимает количество кликов, сделанных до удержания. Это позволяет очень просто контролировать несколько величин одной кнопкой. См. пример *StepMode*.
-- `releaseStep()` - кнопка была отпущена после импульсного удержания. Может использоваться для изменения знака инкремента переменной: удерживаем - переменная увеличивается, отпустили, удерживаем ещё раз - уменьшается. См. пример *StepMode*. *[однократно вернёт true]*
-- `releaseStep(clicks)` - всё то же самое, но функция принимает количество кликов, сделанных до удержания. См. пример *StepMode*. *[однократно вернёт true]*
+- `click()` - кнопка была кликнута, т.е. нажата и отпущена до таймаута удержания. *[однократно вернёт true]*
+- `held()` - кнопка была удержана дольше таймаута удержания. *[однократно вернёт true]*
+- `held(clicks)` - то же самое, но функция принимает количество кликов, сделанных до удержания. Примечание: held() без аргумента перехватит вызов! См. пример *preClicks*. *[однократно вернёт true]*
+- `hold()` - кнопка была удержана дольше таймаута удержания. *[возвращает true, пока удерживается]*
+- `hold(clicks)` - то же самое, но функция принимает количество кликов, сделанных до удержания. Примечание: hold() без аргумента перехватит вызов! См. пример *preClicks*. *[возвращает true, пока удерживается]*
+- `step()` - режим "импульсного удержания": после удержания кнопки дольше таймаута данная функция *[возвращает true с периодом EB_STEP]*. Удобно использовать для пошагового изменения переменных: `if (btn.step()) val++;`.
+- `step(clicks)` - то же самое, но функция принимает количество кликов, сделанных до удержания. Примечание: step() без аргумента перехватит вызов! См. пример *StepMode* и *preClicks*.
+- `releaseStep()` - кнопка была отпущена после импульсного удержания. Может использоваться для изменения знака инкремента переменной. См. пример *StepMode*. *[однократно вернёт true]*
+- `releaseStep(clicks)` - то же самое, но функция принимает количество кликов, сделанных до удержания. Примечание: releaseStep() без аргумента перехватит вызов! См. пример *StepMode* и *preClicks*. *[однократно вернёт true]*
 - `hasClicks(clicks)` - было сделано указанное количество кликов с периодом менее *EB_CLICK*. *[однократно вернёт true]*
 - `state()` - возвращает теукщее состояние кнопки (сигнал с пина, без антидребезга): `true` - нажата, `false` - не нажата.
 - `hasClicks()` - вернёт количество кликов, сделанных с периодом менее *EB_CLICK*. В противном случае вернёт 0.
 - `uint8_t clicks` - публичная переменная (член класса), хранит количество сделанных кликов с периодом менее *EB_CLICK*. Сбрасывается в 0 после нового клика.
+![diagram](/doc/diagram.png)
 
 #### Энкодер
 - `turn()` - поворот на один щелчок в любую сторону. *[однократно вернёт true]*
@@ -500,6 +503,7 @@ void loop() {
 - v1.15 - добавлен setPins() для EncButton2
 - v1.16 - добавлен режим EB_HALFSTEP_ENC для полушаговых энкодеров
 - v1.17 - добавлен step с предварительными кликами
+- v1.18 - не считаем клики после активации step. held() и hold() тоже могут принимать предварительные клики. Переделан и улучшен дебаунс
 
 <a id="feedback"></a>
 ## Баги и обратная связь

doc/diagram.png

@@ -0,0 +1,33 @@
+// срабатывание функций held/hold/step после предварительных кликов
+
+#include <EncButton.h>
+EncButton<EB_TICK, 3> btn;
+
+void setup() {
+  Serial.begin(9600);
+}
+
+void loop() {
+  btn.tick();
+  if (btn.click()) Serial.println("click");
+
+  // вызов без количества кликов перехватит все остальные вызовы!
+  //if (btn.held()) Serial.println("held any clicks");
+  if (btn.held(0)) Serial.println("held after 0 clicks");
+  if (btn.held(2)) Serial.println("held after 2 clicks");
+
+  // вызов без количества кликов перехватит все остальные вызовы!
+  //if (btn.hold()) Serial.println("hold any clicks");
+  //if (btn.hold(0)) Serial.println("hold after 0 clicks");
+  //if (btn.hold(2)) Serial.println("hold after 2 clicks");
+
+  // вызов без количества кликов перехватит все остальные вызовы!
+  //if (btn.step()) Serial.println("step after any clicks");
+  if (btn.step(0)) Serial.println("step after 0 clicks");
+  if (btn.step(2)) Serial.println("step after 2 clicks");
+
+  // вызов без количества кликов перехватит все остальные вызовы!
+  //if (btn.releaseStep()) Serial.println("release step after any clicks");
+  if (btn.releaseStep(0)) Serial.println("release step after 0 clicks");
+  if (btn.releaseStep(2)) Serial.println("release step after 2 clicks");
+}

examples/preClicks/preClicks.ino

@@ -9,9 +9,9 @@
 //#define EB_CLICK 400   // таймаут накликивания, мс
 
 #include <EncButton.h>
-EncButton<EB_TICK, 2, 3, 4> enc;  // энкодер с кнопкой <A, B, KEY>
+//EncButton<EB_TICK, 2, 3, 4> enc;  // энкодер с кнопкой <A, B, KEY>
 //EncButton<EB_TICK, 2, 3> enc;     // просто энкодер <A, B>
-//EncButton<EB_TICK, 4> enc;        // просто кнопка <KEY>
+EncButton<EB_TICK, 3> enc;        // просто кнопка <KEY>
 // для изменения направления энкодера поменяй A и B при инициализации
 
 // по умолчанию пины настроены в INPUT_PULLUP

examples/tickMode/tickMode.ino

@@ -1,5 +1,5 @@
 name=EncButton
-version=1.17
+version=1.18
 author=AlexGyver <[email protected]>
 maintainer=AlexGyver <[email protected]>
 sentence=Light and fast library for button and encoder operation for Arduino

library.properties

@@ -37,6 +37,7 @@
     v1.15 - добавлен setPins() для EncButton2
     v1.16 - добавлен режим EB_HALFSTEP_ENC для полушаговых энкодеров
     v1.17 - добавлен step с предварительными кликами
+    v1.18 - не считаем клики после активации step. held() и hold() тоже могут принимать предварительные клики. Переделан и улучшен дебаунс
 */
 
 #ifndef _EncButton_h
@@ -246,6 +247,7 @@ class EncButton {
     bool fast() { return _EB_readFlag(1); }     // быстрый поворот
     bool turn() { return checkFlag(0); }        // энкодер повёрнут
     bool turnH() { return checkFlag(9); }       // энкодер повёрнут нажато
+    
     int8_t getDir() { return _dir; }            // направление последнего поворота, 1 или -1
     int16_t counter = 0;                        // счётчик энкодера
 
@@ -254,19 +256,23 @@ class EncButton {
     bool press() { return checkState(8); }      // кнопка нажата
     bool release() { return checkFlag(10); }    // кнопка отпущена
     bool click() { return checkState(5); }      // клик по кнопке
+    
     bool held() { return checkState(6); }       // кнопка удержана
     bool hold() { return _EB_readFlag(4); }     // кнопка удерживается
-    bool step(uint8_t clk = 0) { return (clicks == clk) ? checkState(7) : 0; }  // режим импульсного удержания с предварительным накликиванием
-    bool releaseStep(uint8_t clk = 0) { return (clicks == clk) ? checkFlag(12) : 0; }  // кнопка отпущена после импульсного удержания с предварительным накликиванием
+    bool step() { return checkState(7); }       // режим импульсного удержания
+    bool releaseStep() { checkFlag(12); }       // кнопка отпущена после импульсного удержания
+    
+    bool held(uint8_t clk) { return (clicks == clk) ? checkState(6) : 0; }          // кнопка удержана с предварительным накликиванием
+    bool hold(uint8_t clk) { return (clicks == clk) ? _EB_readFlag(4) : 0; }        // кнопка удерживается с предварительным накликиванием
+    bool step(uint8_t clk) { return (clicks == clk) ? checkState(7) : 0; }          // режим импульсного удержания с предварительным накликиванием
+    bool releaseStep(uint8_t clk) { return (clicks == clk) ? checkFlag(12) : 0; }   // кнопка отпущена после импульсного удержания с предварительным накликиванием
 
     uint8_t clicks = 0;                         // счётчик кликов
-    bool hasClicks(uint8_t num) { return (clicks == num && checkFlag(7)) ? 1 : 0; } // имеются клики
-    uint8_t hasClicks() { return checkFlag(6) ? clicks : 0; }                       // имеются клики
+    bool hasClicks(uint8_t num) { return (clicks == num && checkFlag(7)) ? 1 : 0; }     // имеются клики
+    uint8_t hasClicks() { return checkFlag(6) ? clicks : 0; }                           // имеются клики
 
     // ===================================================================================
     // =================================== DEPRECATED ====================================
-    //bool step() { return checkState(7); }       // режим импульсного удержания
-    //bool releaseStep() { return checkFlag(12); } // кнопка отпущена после импульсного удержания
     bool isStep() { return step(); }
     bool isHold() { return hold(); }
     bool isHolded() { return held(); }
@@ -357,14 +363,20 @@ class EncButton {
         uint32_t debounce = thisMls - _debTimer;
         if (_btnState) {                                                	// кнопка нажата
             if (!_EB_readFlag(3)) {                                         // и не была нажата ранее
-                if (debounce > EB_DEB) {                                   	// и прошел дебаунс
-                    _EB_setFlag(3);                                         // флаг кнопка была нажата
-                    _debTimer = thisMls;                                    // сброс таймаутов
-                    EBState = 8;                                           	// кнопка нажата
-                }
-                if (debounce > EB_CLICK) {									// кнопка нажата после EB_CLICK
-                    clicks = 0;												// сбросить счётчик и флаг кликов
-                    flags &= ~0b0011000011100000;                           // clear 5 6 7 12 13 (клики)
+                if (_EB_readFlag(14)) {                                     // ждём дебаунс
+                    if (debounce > EB_DEB) {                                // прошел дебаунс
+                        _EB_setFlag(3);                                     // флаг кнопка была нажата
+                        EBState = 8;                                        // кнопка нажата
+                        _debTimer = thisMls;                                // сброс таймаутов
+                    }
+                } else {                                                    // первое нажатие
+                    EBState = 0;
+                    _EB_setFlag(14);                                        // запомнили что хотим нажать                    
+                    if (debounce > EB_CLICK || _EB_readFlag(5)) {           // кнопка нажата после EB_CLICK
+                        clicks = 0;											// сбросить счётчик и флаг кликов
+                        flags &= ~0b0011000011100000;                       // clear 5 6 7 12 13 (клики)
+                    }
+                    _debTimer = thisMls;
                 }
             } else {                                                      	// кнопка уже была нажата
                 if (!_EB_readFlag(4)) {                                     // и удержание ещё не зафиксировано
@@ -373,7 +385,7 @@ class EncButton {
                     } else {                                                // прошло больше времени удержания
                         if (!_EB_readFlag(2)) {                             // и энкодер не повёрнут
                             EBState = 6;                                   	// значит это удержание (сигнал)
-                            _EB_setFlag(4);                                 // запомнили что удерживается
+                            flags |= 0b00110000;                            // set 4 5 запомнили что удерживается и отключаем сигнал о кликах
                             _debTimer = thisMls;                            // сброс таймаута
                         }
                     }
@@ -389,15 +401,16 @@ class EncButton {
             if (_EB_readFlag(3)) {                                          // но была нажата
                 if (debounce > EB_DEB) {
                     if (!_EB_readFlag(4) && !_EB_readFlag(2)) {	            // энкодер не трогали и не удерживали - это клик
-                        EBState = 5;
+                        EBState = 5;                                        // click
                         clicks++;
                     }
-                    flags &= ~0b00011100;                                       // clear 2 3 4                    
-                    _debTimer = thisMls;                                        // сброс таймаута
-                    _EB_setFlag(10);                                            // кнопка отпущена
-                    if (checkFlag(13)) _EB_setFlag(12);                         // кнопка отпущена после step
+                    flags &= ~0b00011100;                                   // clear 2 3 4                    
+                    _debTimer = thisMls;                                    // сброс таймаута
+                    _EB_setFlag(10);                                        // кнопка отпущена
+                    if (checkFlag(13)) _EB_setFlag(12);                     // кнопка отпущена после step
                 }
             } else if (clicks > 0 && debounce > EB_CLICK && !_EB_readFlag(5)) flags |= 0b11100000;	 // set 5 6 7 (клики)
+            checkFlag(14);                                                  // сброс ожидания нажатия
         }
     }
 
@@ -450,6 +463,7 @@ class EncButton {
     // 11 - btn level
     // 12 - btn released after step
     // 13 - step flag
+    // 14 - deb flag
 
     // EBState
     // 0 - idle