Update

- New feature to debounce byte data as an input.
- Updated readme with test results
- New examples

Author: Dlloydev

README.md

@@ -4,14 +4,17 @@
 
 # Toggle    [![arduino-library-badge](https://www.ardu-badge.com/badge/Toggle.svg?)](https://www.ardu-badge.com/Toggle) [![PlatformIO Registry](https://badges.registry.platformio.org/packages/dlloydev/library/Toggle.svg)](https://registry.platformio.org/libraries/dlloydev/Toggle)
 
-Arduino switch and button library for SPST, SPDT or SP3T contacts. Simple to use, provides debouncing, deglitching and uses very little memory. Captures one-shot transitions (depicting direction) and current position status. 
+Arduino library for deglitching and debouncing signals, buttons and switches.  One or two inputs can be monitored to decode transistions (depicting direction) for SPST, SPDT or SP3T contacts. Simple to use and requires very little memory. Captures one-shot transitions (depicting direction) and current status. 
+
+![image](https://user-images.githubusercontent.com/63488701/167322856-91eba08a-687d-4b0b-813a-97d32b092327.png)
 
 #### Features
 
 - Performs both debouncing and deglitching.
+- Works with signals, stored data, buttons and switches.
 - External pull-up resistors not required.
 - Very simple to use.
-- Ultra low memory use (14 bytes per button).
+- Ultra low memory use.
 
 ## Using Toggle
 
@@ -36,7 +39,7 @@ sw1.poll();
 sw2.poll();
 ```
 
-###### The switch functions when using 1 input pin:
+#### The switch functions when using 1 input pin:
 
 ```c++
 bool isOFF();
@@ -47,7 +50,7 @@ bool ONtoOFF();
 
 The switch has 2 positions referred to as OFF (input is high) and ON (input is low). The first 2 functions will continuously return true if the switch is at that current position. The last 2 functions return true (once only) if the switch has just transitioned to the checked position. This is very handy to execute code based on direction of switched operation or for any one-shot processing of code.
 
-###### The switch functions when using 2 input pins:
+#### The switch functions when using 2 input pins:
 
 ```c++
 bool isUP();
@@ -61,7 +64,19 @@ bool MIDtoUP();
 
 The switch has 3 positions referred to as UP, MID (center) and DN (down). The first 3 functions will continuously return true if the switch is at that position. The last 4 functions return true (once only) if the switch has just transitioned to that position. This is very handy to execute code based on direction of switched operation or for any one-shot processing of code.
 
-#### Example Sketch
+#### Other functions:
+
+```c++
+void setInputMode(inMode inputMode);
+
+// options:
+sw1.setInputMode(sw1.inMode::input_input);     // high impedance input
+sw1.setInputMode(sw1.inMode::input_pullup);    // pullup resistor enabled (default)
+sw1.setInputMode(sw1.inMode::input_pulldown);  // not used 
+sw1.setInputMode(sw1.inMode::input_logic);     // uses a byte variable for input data
+```
+
+#### Example Sketch:
 
 This sketch checks the status of a SP3T and a basic SPST switch or button:
 
@@ -80,21 +95,13 @@ void loop() {
   sw1.poll();
   sw2.poll();
 
-  if (sw1.OFFtoON) Serial.println(F("sw1: OFF⇒ON"));
-  if (sw1.ONtoOFF) Serial.println(F("sw1: ON⇒OFF"));
-
-  if (sw2.OFFtoON) Serial.println(F("sw2: OFF⇒ON"));
-  if (sw2.ONtoOFF) Serial.println(F("sw2: ON⇒OFF"));
-
   if (sw1.UPtoMID) Serial.println(F("sw1: UP⇒MID"));
   if (sw1.MIDtoDN) Serial.println(F("sw1: MID⇒DN"));
   if (sw1.DNtoMID) Serial.println(F("sw1: DN⇒MID"));
   if (sw1.MIDtoUP) Serial.println(F("sw1: MID⇒UP"));
 
-  if (sw2.UPtoMID) Serial.println(F("sw1: UP⇒MID"));
-  if (sw2.MIDtoDN) Serial.println(F("sw1: MID⇒DN"));
-  if (sw2.DNtoMID) Serial.println(F("sw1: DN⇒MID"));
-  if (sw2.MIDtoUP) Serial.println(F("sw1: MID⇒UP"));
+  if (sw2.OFFtoON) Serial.println(F("sw2: OFF⇒ON"));
+  if (sw2.ONtoOFF) Serial.println(F("sw2: ON⇒OFF"));
 }
 ```
 
@@ -147,23 +154,23 @@ A set of connections are shown where 0.1μF capacitors are optionally added to p
 
 #### Polling
 
-The switch inputs are polled in the main loop and the history of readings is stored in an 8-bit shift register (byte) where bit0 is the present reading and bit7 is the oldest reading. Data is shifted and updated every 10ms.
+The switch inputs are polled in the main loop and the history of readings is stored in an 8-bit shift register (byte) where bit0 is the present reading and bit7 is the oldest reading. Data is shifted and updated every 5ms.
 
 #### Deglitching
 
-Using the input pullups provides a high 20K-50K impedance that makes the signals more susceptible to noise pickup, especially if longer cables are used in a noisy environment. To improve this possible situation, software deglitching is internally set to 1 read sample which represents a minimum period of 10ms that any reading change is ignored.
+Using the input pullups provides a high 20K-50K impedance that makes the signals more susceptible to noise pickup, especially if longer cables are used in a noisy environment. To improve this possible situation, software deglitching is internally set to 1 read sample which represents a minimum period of 5ms that any reading change is ignored.
 
 #### Debouncing
 
-Debouncing requires the shift register to be completely filled with 1's or 0's to signify a stable state. This occurs 80ms after the last transition. Contact closure will be detected after at least 10ms have elapsed (de-glitch period). Contact release is detected in at least 80ms.
+Debouncing requires the shift register to be completely filled with 1's or 0's to signify a stable state. This occurs 40ms after bouncing stops. Contact closure will be detected after 2 stable samples (readings) are made. This allows single sample anomalies to be ignored (deglitched). Contact release is detected when 8 stable samples (readings) have been made.
 
 #### Memory Comparison on Leonardo with 2 buttons attached :
 
 | Library      | Version   | Bytes   | Bytes Used |
 | ------------ | --------- | ------- | ---------- |
 | Empty sketch | --        | 149     | --         |
-| **Toggle.h** | **2.1.1** | **177** | **28**     |
 | JC_Button.h  | 2.1.2     | 186     | 37         |
+| **Toggle.h** | **2.2.0** | **190** | **41**     |
 | Bounce2.h    | 2.71.0    | 193     | 44         |
 | AceButton.h  | 1.9.2     | 205     | 56         |
 | ezButton.h   | 1.0.3     | 331     | 182        |

examples/Input_Logic_Test/Input_Logic_Test.ino

@@ -0,0 +1,55 @@
+/************************************************************************
+  Input logic Test Example:
+  =========================
+  A simple example that reads array bytes as the input signal.
+  • open Serial Monitor to view/copy the results in csv format.
+  • open Serial Plotter to view the noisy input and debounced outputs.
+  • can be used to monitor, deglitch and debounce an input representing
+  RPM pulses, flow meter pulses, noisy comparator output signal, etc.
+  ***********************************************************************/
+
+#include <Toggle.h>
+
+const byte ledPin = LED_BUILTIN;
+const byte dat[47] = {
+  1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1
+};
+
+byte logic;
+
+Toggle sw1(&logic);
+
+void setup() {
+  pinMode(ledPin, OUTPUT);
+  while (!Serial) { }; // Leonardo
+  Serial.begin(115200);
+
+  sw1.setInputMode(sw1.inMode::input_logic);
+
+  for (int i = 0; i < 47; i++) {
+    logic = dat[i];
+    sw1.poll();
+
+    bool off = sw1.isOFF();
+    bool on = sw1.isON();
+    digitalWrite(ledPin, on);
+
+    for (int i = 0; i < 10; i++) { // zoom horizontal
+      plot("In", logic + 4, false);
+      plot("isOFF", off + 2, false);
+      plot("isON", on, true);
+    }
+    delay(50);
+  }
+}
+
+void loop() {
+}
+
+void plot(String label, float value, bool last) {
+  Serial.print(label); // can be empty
+  if (label != "") Serial.print(":");
+  Serial.print(value);
+  if (last == false) Serial.print(", ");
+  else Serial.println();
+}

examples/Toggle_Basic/Toggle_Basic.ino

@@ -1,30 +1,34 @@
+/************************************************************************
+  Toggle Basic Example:
+  =====================
+  A simple example that toggles an LED each time a button is pressed
+  or switch is closed. The input pin is pulled high and connected to GND.
+  Therefore, when released (OFF),the signal is HIGH. When pressed (ON),
+  the signal is LOW. The serial monitor indicates switch transitions.
+  ***********************************************************************/
+
 #include <Toggle.h>
 
-Toggle sw1(6,7);
-Toggle sw2(8);
+const byte buttonPin = 2;
+const byte ledPin = LED_BUILTIN;
+byte ledState = LOW;
+
+Toggle sw1(buttonPin);
+Toggle sw2(buttonPin + 1);
 
 void setup() {
+  pinMode(ledPin, OUTPUT);
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
 }
 
 void loop() {
   sw1.poll();
   sw2.poll();
-
-  if (sw1.OFFtoON()) Serial.println(F("sw1: OFF⇒ON"));
   if (sw1.ONtoOFF()) Serial.println(F("sw1: ON⇒OFF"));
-
-  if (sw2.OFFtoON()) Serial.println(F("sw2: OFF⇒ON"));
-  if (sw2.ONtoOFF()) Serial.println(F("sw2: ON⇒OFF"));
-
-  if (sw1.UPtoMID()) Serial.println(F("sw1: UP⇒MID"));
-  if (sw1.MIDtoDN()) Serial.println(F("sw1: MID⇒DN"));
-  if (sw1.DNtoMID()) Serial.println(F("sw1: DN⇒MID"));
-  if (sw1.MIDtoUP()) Serial.println(F("sw1: MID⇒UP"));
-
-  if (sw2.UPtoMID()) Serial.println(F("sw1: UP⇒MID"));
-  if (sw2.MIDtoDN()) Serial.println(F("sw1: MID⇒DN"));
-  if (sw2.DNtoMID()) Serial.println(F("sw1: DN⇒MID"));
-  if (sw2.MIDtoUP()) Serial.println(F("sw1: MID⇒UP"));
+  if (sw1.OFFtoON()) {
+    Serial.println(F("sw1: OFF⇒ON"));
+    ledState = !ledState;
+    digitalWrite(ledPin, ledState);
+  }
 }

keywords.txt

@@ -34,7 +34,15 @@ isON	KEYWORD2
 isOFF	KEYWORD2
 ONtoOFF	KEYWORD2
 OFFtoON	KEYWORD2
+setInputMode	KEYWORD2
+getInputMode	KEYWORD2
 
 ##########################################
 # Constants (LITERAL1)
 ##########################################
+
+input	LITERAL1
+input_pullup	LITERAL1
+input_pulldown	LITERAL1
+input_logic	LITERAL1
+input_float	LITERAL1

library.json

@@ -1,8 +1,8 @@
 {
   "name": "Toggle",
-  "version": "2.1.1",
-  "description": "Arduino switch and button library for SPST, SPDT or SP3T contacts. Simple to use, provides debouncing, deglitching and uses very little memory. Captures one-shot transitions (depicting direction) and current position status.",
-  "keywords": "toggle, switch",
+  "version": "2.2.0",
+  "description": "Arduino library for deglitching and debouncing signals, stored data, buttons and switches. Decodes transistions (depicting direction) for SPST, SPDT or SP3T contacts. Captures one-shot transitions and current status. Simple to use.",
+  "keywords": "debounce, toggle, button, switch, data, deglitch",
   "repository":
   {
     "type": "git",

library.properties

@@ -1,9 +1,9 @@
 name=Toggle
-version=2.1.1
+version=2.2.0
 author=David Lloyd
 maintainer=David Lloyd <[email protected]>
-sentence=Arduino switch and button library for SPST, SPDT or SP3T contacts. Simple to use, provides debouncing, deglitching and uses very little memory.
-paragraph=Captures one-shot transitions (depicting direction) and current position status.
+sentence=Arduino library for deglitching and debouncing signals, stored data, buttons and switches. Decodes transistions (depicting direction) for SPST, SPDT or SP3T contacts.
+paragraph= Captures one-shot transitions and current status. Simple to use.
 category=Signal Input/Output
 url=https://github.com/Dlloydev/Toggle
 architectures=*