Update

Update blink() function, readme and examples.
New Use_Button_As_Toggle.ino example

Author: Dlloydev

README.md

@@ -8,7 +8,7 @@
 
 The inputs can be from a single pin or several pins allowing the use of 2 or 3-position switches and up to seven debounced states. When linking to a data (byte) input, the debouncer can work with any selected bit or it can debounce all 8-bits in one Toggle instance. Examples:  [`Input_Bit_Test.ino`](https://github.com/Dlloydev/Toggle/blob/main/examples/Input_Bit_Test/Input_Bit_Test.ino) , [`Input_Bit.ino`](https://github.com/Dlloydev/Toggle/blob/main/examples/Input_Bit/Input_Bit.ino),  [`Input_Port_Test.ino`](https://github.com/Dlloydev/Toggle/blob/main/examples/Input_Port_Test/Input_Port_Test.ino) and [`Input_Port.ino`](https://github.com/Dlloydev/Toggle/blob/main/examples/Input_Port/Input_Port.ino).
 
-### Algorithm
+### Debounce Algorithm
 
 The debounce algorithm adds only 2 sample periods of time lag to the output signal. A 3-sample stable period is required for an output bit to change. Therefore, to set an output bit, 3 consecutive 1's are required. When 3 consecutive 0's are detected, that bit value is cleared.![image](https://user-images.githubusercontent.com/63488701/171260623-befe88a4-66c4-44a2-a38b-6c14c715a92d.png)
 
@@ -293,7 +293,7 @@ There are 4 timer functions to make timing operations simple to use in your code
 
 ##### Description
 
-This function sets the duration in milliseconds that the returned value is true. The mode parameter sets what blink responds to: onPress( 0), onRelease (1), onChange (2).
+This function sets the duration in milliseconds that the returned value is true. The mode parameter sets what blink responds to: onChange (0), onPress( 1) default, onRelease (2).
 
 ##### Syntax
 
@@ -303,19 +303,15 @@ This function sets the duration in milliseconds that the returned value is true.
 
 **ms:** The number of milliseconds *(unsigned int)*
 
-**mode:** Blink onPress( 0), onRelease (1), onChange (2) *(byte)*
+**mode:** Blink  onChange (0), onPress( 1) default, onRelease (2) *(byte)*
 
 ##### Returns
 
 *true* or *false*, depending on whether the elapsed time has expired after any state change set by the mode parameter. *(bool)*
 
 ##### Example
 
-```c++
-digitalWrite(ledPin, blink(100)); // blink an LED for 100ms just after state change set by mode
-```
-
- 
+ [Toggle_Basic.ino](https://github.com/Dlloydev/Toggle/blob/main/examples/Toggle_Basic/Toggle_Basic.ino)
 
 ## pressedFor(ms)
 

examples/Blink_On_Change/Blink_On_Change.ino

@@ -1,10 +1,9 @@
-/******************************************************
-  Eight Buttons (or Switches) Example:
-  ====================================
+/****************************************************
+  EIGHT BUTTONS EXAMPLE:
   An example that checks the status of eight buttons.
   All input pins will have their pullups enabled.
   The LED blinks for each on press transition.
-  *****************************************************/
+  ***************************************************/
 
 #include <Toggle.h>
 
@@ -31,7 +30,6 @@ void loop() {
     } else {
       ledState--;
     }
-    sw[i].onPress();
   }
   digitalWrite(ledPin, ledState);
 }

examples/Eight_buttons/Eight_buttons.ino

@@ -1,28 +1,25 @@
-/************************************************************************
-  Toggle Basic Example:
-  =====================
-  A simple example that toggles an LED each time a button is pressed
-  or switch is closed.  The input pin will have its pullup enabled.
-  The serial monitor indicates all switch transitions.
-  ***********************************************************************/
+/**********************************************************
+  TOGGLE BASIC EXAMPLE:
+  This example blinks the built in LED as configured below.
+  INPUT_PULLUP and debouncing are pre-configured.
+  *********************************************************/
 
-#include <Toggle.h>
+#include "Toggle.h"
 
 const byte buttonPin = 2;
 const byte ledPin = LED_BUILTIN;
 
-Toggle sw1(buttonPin);
+const byte blinkMs = 100; // blink duration (ms)
+const byte blinkMode = 1; // 0: on change, 1: on press (default), 2: on release
+
+Toggle button(buttonPin);
 
 void setup() {
-  while (!Serial) { }; // Leonardo
-  Serial.begin(115200);
-  sw1.begin(buttonPin);
+  button.begin(buttonPin);
   pinMode(ledPin, OUTPUT);
 }
 
 void loop() {
-  sw1.poll();
-  if (sw1.onPress()) Serial.println(F("sw1: OFF⇒ON"));
-  if (sw1.onRelease()) Serial.println(F("sw1: ON⇒OFF"));
-  digitalWrite(ledPin, sw1.toggle());
+  button.poll();
+  digitalWrite(ledPin, button.blink(blinkMs, blinkMode));
 }

examples/Toggle_Basic/Toggle_Basic.ino

@@ -0,0 +1,26 @@
+/*******************************************************************************
+  TURN A MOMENTARY PUSHBUTTON INTO 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 each time the button is pressed.
+  For the LED to change state on release, un-comment button.setInvertMode(1);
+  For LED startup in opposite state, use digitalWrite(ledPin, button.toggle(1));
+  ******************************************************************************/
+
+#include <Toggle.h>
+
+const byte buttonPin = 2;
+const byte ledPin = LED_BUILTIN;
+
+Toggle button(buttonPin);
+
+void setup() {
+  button.begin(buttonPin);
+  //button.setInvertMode(1);
+  pinMode(ledPin, OUTPUT);
+}
+
+void loop() {
+  button.poll();
+  digitalWrite(ledPin, button.toggle());
+}

examples/Use_Button_As_Toggle/Use_Button_As_Toggle.ino

@@ -1,6 +1,6 @@
 {
   "name": "Toggle",
-  "version": "3.1.3",
+  "version": "3.1.4",
   "description": "Arduino bounce library for debouncing hardware, signals and data. Works with all switch types, port expander and other 8-bit data sources. Robust debounce algorithm.",
   "keywords": "debounce, toggle, button, switch, data, deglitch",
   "repository":

library.json

@@ -1,5 +1,5 @@
 name=Toggle
-version=3.1.3
+version=3.1.4
 author=David Lloyd
 maintainer=David Lloyd <dlloydev@testcor.ca>
 sentence=Arduino bounce library for deglitching and debouncing hardware, signals and data. Works with all switch types, port expander and other 8-bit data sources.

library.properties

@@ -1,5 +1,5 @@
 /************************************************
-   Toggle Library for Arduino - Version 3.1.3
+   Toggle Library for Arduino - Version 3.1.4
    by dlloydev https://github.com/Dlloydev/Toggle
    Licensed under the MIT License.
  ************************************************/
@@ -108,9 +108,11 @@ bool Toggle::toggle(bool invert, uint8_t bit) {
 /************* button timer functions ****************/
 
 bool Toggle::blink(uint16_t ms, uint8_t mode) {
-  if (mode == 2 && onChange()) startUs = micros();
-  else if (mode == 1 && onChange() == 2) startUs = micros();
-  else if (onChange() == 1) startUs = micros();
+  if (mode == 2 && onChange() == 2) startUs = micros();
+  else if (mode == 1 && onChange() == 1) startUs = micros();
+  else if (mode == 0 && onChange()) startUs = micros();
+  onPress();
+  onRelease();
   return (bool)(ms > (getElapsedMs()));
 }
 
@@ -152,7 +154,6 @@ uint8_t Toggle::pressCode(bool debug) {
       if (pCode && isReleased() && (elapsedMs > (CLICK::LONG + CLICK::MULTI))) _state = PB_DONE;
       if (onChange()) startUs = micros();
       if (onPress()) {
-        //Serial.print(F(" Released:\t")); Serial.print(elapsedMs); Serial.println(" ms");
         _state = PB_ON_PRESS;
       }
       if (onRelease()) {

src/Toggle.cpp

@@ -26,9 +26,9 @@ class Toggle {
     bool isReleased(uint8_t bit = 0);                // returns true if released
     bool onPress();                                  // returns true if just pressed
     bool onRelease();                                // returns true if just released
-    uint8_t onChange();                              // returns (0) no change, (1) onPress, (2) onRelease
+    uint8_t onChange();                              // returns: no change(0), onPress(1), onRelease(2)
     bool toggle(bool invert = 0, uint8_t bit = 0);   // returns true/false (toggle) on each press
-    bool blink(uint16_t ms, uint8_t mode = 0);       // returns true for given ms (blink) on mode press(0), release(1), change(2)
+    bool blink(uint16_t ms, uint8_t mode = 1);       // returns true for given ms (blink) on mode: change(0), press(1), release(2),
     bool pressedFor(uint16_t ms);                    // returns true if pressed for at least the given ms
     bool releasedFor(uint16_t ms);                   // returns true if released for at least the given ms
     bool retrigger(uint16_t ms);                     // returns true each time the given ms expires while the button is pressed