Update

Updated examples
New Wokwi examples
Updated timer functions

Author: Dlloydev

README.md

@@ -5,7 +5,7 @@ Arduino button debounce library for various switch types, port expanders and oth
 ## Features
 
 - Fast, robust and symetrical [debouncing](https://github.com/Dlloydev/Toggle/wiki/Debounce-Algorithm) of both press and release button transitions
-- Works with various [switch types](https://github.com/Dlloydev/Toggle/wiki/Switch-Connections)
+- Works with various [switch types and connections](https://github.com/Dlloydev/Toggle/wiki/Switch-Connections).
 - Identifies 7 unique transitions for 3-position switches
 - Use momentary button as toggle switch (configurable)
 - Return up to 225 codes from one button

examples/Press_Code/Press_Code.ino

@@ -4,6 +4,8 @@
   A simple example that demonstrates how fast-clicks, short presses and
   long presses can be automatically detected and combined into a byte code.
   In debug mode, the serial monitor shows timing results and code.
+  Try on Wokwi UNO: https://wokwi.com/projects/334284248581145170
+          ESP32-S2: https://wokwi.com/projects/334320246564323924
   ***********************************************************************/
 
 #include <Toggle.h>

examples/Pressed_For/Pressed_For.ino

@@ -0,0 +1,24 @@
+/*****************************************************************
+  PRESSED FOR EXAMPLE:
+  While a button is pressed, returns true after elapsed ms
+  Try on Wokwi UNO: https://wokwi.com/projects/334457647787934292
+          ESP32-S2: https://wokwi.com/projects/334454109412262483
+  ****************************************************************/
+
+#include <Toggle.h>
+
+const byte buttonPin = 2;
+const byte ledPin = LED_BUILTIN;
+const unsigned int ms = 1000;
+
+Toggle sw1(buttonPin);
+
+void setup() {
+  pinMode(ledPin, OUTPUT);
+  sw1.begin(buttonPin);
+}
+
+void loop() {
+  sw1.poll();
+  digitalWrite(ledPin, sw1.pressedFor(ms));
+}

examples/Released_For/Released_For.ino

@@ -0,0 +1,24 @@
+/*****************************************************************
+  RELEASED FOR EXAMPLE:
+  While a button is released, returns true after elapsed ms
+  Try on Wokwi UNO: https://wokwi.com/projects/334458460245590611
+          ESP32-S2: https://wokwi.com/projects/334458628485415508
+  ****************************************************************/
+
+#include <Toggle.h>
+
+const byte buttonPin = 2;
+const byte ledPin = LED_BUILTIN;
+const unsigned int ms = 1000;
+
+Toggle sw1(buttonPin);
+
+void setup() {
+  pinMode(ledPin, OUTPUT);
+  sw1.begin(buttonPin);
+}
+
+void loop() {
+  sw1.poll();
+  digitalWrite(ledPin, sw1.releasedFor(ms));
+}

…etrigger_On_Press/Retrigger_On_Press.ino …hile_Pressed/Retrigger_While_Pressed.inoexamples/Retrigger_On_Press/Retrigger_On_Press.ino renamed to examples/Retrigger_While_Pressed/Retrigger_While_Pressed.ino examples/Retrigger_On_Press/Retrigger_On_Press.ino renamed to examples/Retrigger_While_Pressed/Retrigger_While_Pressed.ino

@@ -1,16 +1,18 @@
 /**************************************************************************
-  Retrigger On Press Example:
-  ===========================
+  Retrigger While Pressed Example:
+  ================================
   An example that shows how to retrigger an event while a button is pressed.
   The retrigger period (ms) determines the rate. Each expired time period is
   counted and displayed on the serial monitor. The built in LED toggles on
   each trigger event.
+  Try on Wokwi UNO: https://wokwi.com/projects/334458963671122515
+          ESP32-S2: https://wokwi.com/projects/334459280465855059
   *************************************************************************/
 
 #include <Toggle.h>
 
 const byte buttonPin = 2;
-const word retriggerMs = 200;
+const word retriggerMs = 1000;
 const byte ledPin = LED_BUILTIN;
 bool ledState = false;
 byte trigCount = 0;

examples/Toggle_Basic/Toggle_Basic.ino

@@ -1,15 +1,17 @@
-/**********************************************************
+/****************************************************************
   TOGGLE BASIC EXAMPLE:
   This example blinks the built in LED as configured below.
   INPUT_PULLUP and debouncing are pre-configured.
-  *********************************************************/
+  Try on Wokwi UNO: https://wokwi.com/projects/334443631893021266
+          ESP32-S2: https://wokwi.com/projects/334453650605736531
+  ***************************************************************/
 
 #include <Toggle.h>
 
 const byte buttonPin = 2;
 const byte ledPin = LED_BUILTIN;
 
-const byte blinkMs = 100; // blink duration (ms)
+const unsigned int blinkMs = 100; // blink duration (ms)
 const byte blinkMode = 1; // 0: on change, 1: on press (default), 2: on release
 
 Toggle button(buttonPin);

examples/Use_Button_As_Toggle/Use_Button_As_Toggle.ino

@@ -1,9 +1,11 @@
-/***********************************************
+/***************************************************************
   USE A MOMENTARY PUSHBUTTON AS A TOGGLE SWITCH:
   The button is connected from input pin to GND.
   INPUT_PULLUP and debouncing are pre-configured.
   The built in LED changes state as configured.
-  **********************************************/
+  Try on Wokwi UNO: https://wokwi.com/projects/334321940028195411
+          ESP32-S2: https://wokwi.com/projects/334322217034711635
+ ****************************************************************/
 
 #include <Toggle.h>
 

library.json

@@ -1,6 +1,6 @@
 {
   "name": "Toggle",
-  "version": "3.1.6",
+  "version": "3.1.7",
   "description": "Arduino button debounce library for various switch types, port expanders and other 8-bit data sources. Fast and robust debounce algorithm.",
   "keywords": "debounce, toggle, button, switch, data, deglitch",
   "repository":

library.properties

@@ -1,5 +1,5 @@
 name=Toggle
-version=3.1.6
+version=3.1.7
 author=David Lloyd
 maintainer=David Lloyd <dlloydev@testcor.ca>
 sentence=AArduino button debounce library for various switch types, port expanders and other 8-bit data sources.

src/Toggle.cpp

@@ -1,5 +1,5 @@
 /************************************************
-   Toggle Library for Arduino - Version 3.1.6
+   Toggle Library for Arduino - Version 3.1.7
    by dlloydev https://github.com/Dlloydev/Toggle
    Licensed under the MIT License.
  ************************************************/
@@ -159,24 +159,28 @@ bool Toggle::blink(uint16_t ms, uint8_t mode) {
   else if (mode == 0 && onChange()) clearTimer();
   onPress();
   onRelease();
-  return (bool)(ms > (getElapsedMs()));
+  if ((startUs * 0.001) > ms) return (bool)(ms > (getElapsedMs()));
+  else return 0;
 }
 
 bool Toggle::pressedFor(uint16_t ms) {
+  if (onPress()) clearTimer();
   if (isPressed() && getElapsedMs() > ms) {
     return true;
   }
   return false;
 }
 
 bool Toggle::releasedFor(uint16_t ms) {
+  if (onRelease()) clearTimer();
   if (isReleased() && getElapsedMs() > ms) {
     return true;
   }
   return false;
 }
 
 bool Toggle::retrigger(uint16_t ms) {
+  if (onPress()) clearTimer();
   if (isPressed() && getElapsedMs() > ms) {
     clearTimer();
     return true;
@@ -191,7 +195,7 @@ uint8_t Toggle::pressCode(bool debug) {
   switch (_state) {
     case PB_DEFAULT:
       elapsedMs = getElapsedMs();
-      if (pCode && isReleased() && (elapsedMs > (CLICK::LONG + CLICK::MULTI))) _state = PB_DONE;
+      if (pCode && isReleased() && (elapsedMs > (CLICK::LONG))) _state = PB_DONE;
       if (onChange()) clearTimer();
       if (onPress()) {
         _state = PB_ON_PRESS;