upd

Author: GyverLibs

README.md

@@ -174,7 +174,8 @@
 |                 | VirtButton | VirtEncButton | Button | EncButton |
 |-----------------|:----------:|:-------------:|:------:|:---------:|
 | read            |            |               |    ✔  |           |
-| readBtn         |            |               |        |     ✔    |
+| readBtn         |            |              |        |     ✔    |
+| tickRaw         |      ✔    |       ✔      |    ✔  |     ✔    |
 | setHoldTimeout  |      ✔    |       ✔      |    ✔  |     ✔    |
 | setStepTimeout  |      ✔    |       ✔      |    ✔  |     ✔    |
 | setClickTimeout |      ✔    |       ✔      |    ✔  |     ✔    |
@@ -211,9 +212,11 @@
 | setEncReverse  |      ✔     |    ✔   |       ✔      |     ✔    |
 | setEncType     |      ✔     |    ✔   |       ✔      |     ✔    |
 | setEncISR      |      ✔     |    ✔   |       ✔      |     ✔    |
+| clear          |      ✔     |    ✔   |       ✔      |     ✔    |
 | turn           |      ✔     |    ✔   |       ✔      |     ✔    |
 | dir            |      ✔     |    ✔   |       ✔      |     ✔    |
 | tickRaw        |      ✔     |    ✔   |       ✔      |     ✔    |
+| pollEnc        |      ✔     |    ✔   |       ✔      |     ✔    |
 | counter        |      ✔     |    ✔   |       ✔      |     ✔    |
 | setFastTimeout |             |         |       ✔      |     ✔    |
 | turnH          |             |         |       ✔      |     ✔    |
@@ -269,6 +272,9 @@ bool tick(VirtButton& b0, VirtButton& b1);
 // кнопка нажата в прерывании кнопки
 void pressISR();
 
+// обработка кнопки без сброса событий и вызова коллбэка
+bool tickRaw(bool s);
+
 // ================== ОПРОС ==================
 // кнопка нажата [событие]
 bool press();
@@ -355,6 +361,9 @@ void initEnc(bool e0, bool e1);
 // инициализация энкодера совмещённым значением
 void initEnc(int8_t v);
 
+// сбросить флаги событий
+void clear();
+
 // ====================== ОПРОС ======================
 // был поворот [событие]
 bool turn();
@@ -375,9 +384,14 @@ int8_t tick(bool e0, bool e1);
 int8_t tick(int8_t state);
 int8_t tick();  // сама обработка в прерывании
 
-// опросить энкодер без установки флагов на поворот (быстрее). Вернёт 1 или -1 при вращении, 0 при остановке
+// опросить энкодер без сброса события поворота. Вернёт 1 или -1 при вращении, 0 при остановке
 int8_t tickRaw(bool e0, bool e1);
 int8_t tickRaw(int8_t state);
+int8_t tickRaw();  // сама обработка в прерывании
+
+// опросить энкодер без установки флагов на поворот (быстрее). Вернёт 1 или -1 при вращении, 0 при остановке
+int8_t pollEnc(bool e0, bool e1);
+int8_t pollEnc(int8_t state);
 ```
 </details>
 <details>
@@ -391,6 +405,9 @@ int8_t tickRaw(int8_t state);
 // установить таймаут быстрого поворота, мс
 void setFastTimeout(uint8_t tout);
 
+// сбросить флаги энкодера и кнопки
+void clear();
+
 // ==================== ОПРОС ====================
 // нажатый поворот энкодера [событие]
 bool turnH();
@@ -419,14 +436,17 @@ uint16_t action();
 // ==================== ОБРАБОТКА ====================
 // обработка в прерывании (только энкодер). Вернёт 0 в покое, 1 или -1 при повороте
 int8_t tickISR(bool e0, bool e1);
-
-// обработка в прерывании (только энкодер). Вернёт 0 в покое, 1 или -1 при повороте
 int8_t tickISR(int8_t e01);
 
 // обработка энкодера и кнопки
 bool tick(bool e0, bool e1, bool btn);
 bool tick(int8_t e01, bool btn);
 bool tick(bool btn);  // энкодер в прерывании
+
+// обработка энкодера и кнопки без сброса флагов и вызова коллбэка
+bool tickRaw(bool e0, bool e1, bool btn);
+bool tickRaw(int8_t e01, bool btn);
+bool tickRaw(bool btn);  // энкодер в прерывании
 ```
 </details>
 <details>
@@ -450,6 +470,9 @@ bool read();
 
 // функция обработки, вызывать в loop
 bool tick();
+
+// обработка кнопки без сброса событий и вызова коллбэка
+bool tickRaw();
 ```
 </details>
 <details>
@@ -631,18 +654,93 @@ void loop() {
 }
 ```
 
+Если библиотека используется с подключенным обработчиком событий `attach()` (см. ниже), то можно вызывать `tick()` где угодно и сколько угодно раз, события будут обработаны в обработчике:
+```cpp
+void cb() {
+  switch (btn.action()) {
+    // ...
+  }
+}
+
+void setup() {
+  btn.attach(cb);
+}
+
+void loop() {
+  btn.tick();
+  // ...
+  btn.tick();
+  // ...
+  btn.tick();
+}
+```
+
 #### "Загруженная" программа
 Библиотека EncButton - **асинхронная**: она не ждёт, пока закончится обработка кнопки, а позволяет программе выполняться дальше. Это означает, что для корректной работы библиотеки основной цикл программы должен выполняться как можно быстрее и не содержать задержек и других "глухих" циклов внутри себя. Для обеспечения правильной обработки кнопки не рекомендуется иметь в основном цикле задержки длительностью более 50-100 мс. Несколько советов:
-- Новичкам: изучите цикл уроков [Как написать скетч](https://alexgyver.ru/lessons/how-to-sketch/)
-  - Пишите асинхронный код в `loop()`
+- Новичкам: изучить цикл уроков [как написать скетч](https://alexgyver.ru/lessons/how-to-sketch/)
+  - Писать асинхронный код в `loop()`
   - Любую синхронную конструкцию на `delay()` можно сделать асинхронной при помощи `millis()`
-  - Если в вашей программе *каждая* итерация главного цикла выполняется дольше 50-100мс - в большинстве случаев программа написана неправильно, за исключением каких-то особых случаев
-- Подключите кнопку на аппаратное прерывание (см. ниже)
-- Избегайте выполнения "тяжёлых" участков кода, пока идёт обработка кнопки, например поместив их в условие `if (!button.busy()) { тяжёлый код }`
-- Если оптимизировать основной цикл невозможно - вызывайте обработчик в другом "потоке":
+  - Если в программе *каждая* итерация главного цикла выполняется дольше 50-100мс - в большинстве случаев программа написана неправильно, за исключением каких-то особых случаев
+- Подключить кнопку на аппаратное прерывание (см. ниже)
+- Избегать выполнения "тяжёлых" участков кода, пока идёт обработка кнопки, например поместив их в условие `if (!button.busy()) { тяжёлый код }`
+- Если оптимизировать основной цикл невозможно - вызывать тикер в другом "потоке" и использовать функцию-обработчик:
   - В прерывании таймера с периодом ~50мс или чаще
   - На другом ядре (например ESP32)
   - В другом таске FreeRTOS
+  - Внутри `yield()` (внутри `delay()`)
+
+#### Раздельная обработка
+> Имеет смысл только при ручном опросе событий! При подключенной функции-обработчике достаточно вызывать обычный `tick()` между тяжёлыми участками программы
+
+Также в загруженной программе можно разделить обработку и сброс событий: вместо `tick()` использовать `tickRaw()` между тяжёлыми участками кода и ручной сброс `clear()`. Порядок следующий:
+- Опросить действия (click, press, turn...)
+- Вызвать `clear()`
+- Вызывать `tickRaw()` между тяжёлыми участками кода
+
+```cpp
+void loop() {
+  if (btn.click()) ...
+  if (btn.press()) ...
+  if (btn.step()) ...
+
+  btn.clear();
+
+  // ...
+  btn.tickRaw();
+  // ...
+  btn.tickRaw();
+  // ...
+  btn.tickRaw();
+  // ...
+}
+```
+Это позволит опрашивать кнопку/энкодер в не очень хорошо написанной программе, где основной цикл завален тяжёлым кодом. Внутри `tickRaw()` накапливаются события, которые раз в цикл разбираются, а затем вручную сбрасываются.
+
+> В этом сценарии буферизация энкодера в прерывании не работает и не обрабатываются все события `releaseXxx`
+
+#### Обработка внутри delay
+Если сложно избавиться от `delay()` внутри главного цикла программы, то на некоторых платформах можно поместить свой код внутри него. Таким образом можно получить даже обработку энкодера в цикле с дилеями без использования прерываний:
+```cpp
+// вставка кода в delay
+void yield() {
+  eb.tickRaw();
+}
+
+void loop() {
+  if (eb.click()) ...
+  if (btn.turn()) ...
+
+  eb.clear();
+
+  // ...
+  delay(10);
+  // ...
+  delay(50);
+  // ...
+}
+```
+
+> В этом сценарии буферизация энкодера в прерывании не работает и не обрабатываются все события `releaseXxx`
 
 #### Обработка кнопки
 Библиотека обрабатывает кнопку следующим образом:
@@ -1411,6 +1509,9 @@ void loop() {
   - Сильно оптимизирована скорость работы action() (общий обработчик)
   - Добавлено подключение внешней функции-обработчика событий
   - Добавлена обработка кнопки в прерывании - pressISR()
+- v3.2
+  - Добавлены функции tickRaw() и clear() для всех классов. Позволяет проводить раздельную обработку (см. доку)
+  - Улучшена обработка кнопки с использованием прерываний
     
 <a id="feedback"></a>
 ## Баги и обратная связь

keywords.txt

@@ -49,7 +49,6 @@ waiting	KEYWORD2
 busy	KEYWORD2
 action	KEYWORD2
 attach	KEYWORD2
-
 pressISR	KEYWORD2
 
 setEncReverse	KEYWORD2
@@ -68,6 +67,7 @@ encHolding	KEYWORD2
 dir	KEYWORD2
 fast	KEYWORD2
 
+pollEnc	KEYWORD2
 init	KEYWORD2
 tickRaw	KEYWORD2
 tickISR	KEYWORD2

library.properties

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

src/core/Button.h

@@ -28,6 +28,11 @@ class Button : public VirtButton {
         return VirtButton::tick(EBread(pin));
     }
 
+    // обработка кнопки без сброса событий и вызова коллбэка
+    bool tickRaw() {
+        return VirtButton::tickRaw(EBread(pin));
+    }
+
    private:
     uint8_t pin;
 };
@@ -56,5 +61,10 @@ class ButtonT : public VirtButton {
         return VirtButton::tick(EBread(PIN));
     }
 
+    // обработка кнопки без сброса событий и вызова коллбэка
+    bool tickRaw() {
+        return VirtButton::tickRaw(EBread(PIN));
+    }
+
    private:
 };

src/core/EncButton.h

@@ -31,11 +31,17 @@ class EncButton : public VirtEncButton {
     }
 
     // функция обработки, вызывать в loop
-    int8_t tick() {
+    bool tick() {
         if (read_ef(EB_EISR)) return VirtEncButton::tick(EBread(b));
         else return VirtEncButton::tick(readEnc(), EBread(b));
     }
 
+    // функция обработки без сброса событий
+    bool tickRaw() {
+        if (read_ef(EB_EISR)) return VirtEncButton::tickRaw(EBread(b));
+        else return VirtEncButton::tickRaw(readEnc(), EBread(b));
+    }
+
     // ====================== READ ======================
     // прочитать значение кнопки
     bool readBtn() {
@@ -77,11 +83,17 @@ class EncButtonT : public VirtEncButton {
     }
 
     // функция обработки, вызывать в loop
-    int8_t tick() {
+    bool tick() {
         if (read_ef(EB_EISR)) return VirtEncButton::tick(EBread(BTN));
         else return VirtEncButton::tick(readEnc(), EBread(BTN));
     }
 
+    // функция обработки без сброса событий
+    bool tickRaw() {
+        if (read_ef(EB_EISR)) return VirtEncButton::tickRaw(EBread(BTN));
+        else return VirtEncButton::tickRaw(readEnc(), EBread(BTN));
+    }
+
     // ====================== READ ======================
     // прочитать значение кнопки
     bool readBtn() {

src/core/Encoder.h

@@ -32,6 +32,12 @@ class Encoder : public VirtEncoder {
         else return VirtEncoder::tick(readEnc());
     }
 
+    // обработка без сброса события поворота
+    int8_t tickRaw() {
+        if (read_ef(EB_EISR)) return VirtEncoder::tickRaw();
+        else return VirtEncoder::tickRaw(readEnc());
+    }
+
    private:
     uint8_t e0, e1;
 
@@ -56,7 +62,7 @@ class EncoderT : public VirtEncoder {
         pinMode(ENCB, mode);
         initEnc(readEnc());
     }
-    
+
     // функция обработки для вызова в прерывании энкодера
     int8_t tickISR() {
         return VirtEncoder::tickISR(readEnc());
@@ -68,6 +74,12 @@ class EncoderT : public VirtEncoder {
         else return VirtEncoder::tick(readEnc());
     }
 
+    // обработка без сброса события поворота
+    int8_t tickRaw() {
+        if (read_ef(EB_EISR)) return VirtEncoder::tickRaw();
+        else return VirtEncoder::tickRaw(readEnc());
+    }
+
     // прочитать значение энкодера
     int8_t readEnc() {
         return EBread(ENCA) | (EBread(ENCB) << 1);