Update

Uses much less memory than other libraries (only 19 bytes per button). Updated documentation.

Author: Dlloydev

README.md

@@ -4,14 +4,14 @@
 
 # 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. Status indicates one-shot transitions (depicting direction) and current position status. 
+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. 
 
 #### Features
 
 - Performs both debouncing and deglitching.
 - External pull-up resistors not required.
 - Very simple to use.
-- Very low memory use.
+- Ultra low memory use (14 bytes per button).
 
 ## Using Toggle
 
@@ -36,30 +36,30 @@ sw1.poll();
 sw2.poll();
 ```
 
-###### The switch status options when using 1 input pin:
+###### The switch functions when using 1 input pin:
 
 ```c++
-sw.isON;
-sw.isOFF;
-sw.ONtoOFF;
-sw.OFFtoON;
+bool isOFF();
+bool isON();
+bool OFFtoON();
+bool ONtoOFF();
 ```
 
-The switch has 2 positions referred to as OFF (input is high) and ON (input is low). The first 2 status options will continuously return true if the switch is at that current position. The last 2 status options 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 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 status options when using 2 input pins:
+###### The switch functions when using 2 input pins:
 
 ```c++
-sw.isUP;
-sw.isMID;
-sw.isDN;
-sw.UPtoMID;
-sw.MIDtoDN;
-sw.DNtoMID;
-sw.MIDtoUP;
+bool isUP();
+bool isMID();
+bool isDN();
+bool UPtoMID();
+bool MIDtoDN();
+bool DNtoMID();
+bool MIDtoUP();
 ```
 
-The switch has 3 positions referred to as UP, MID (center) and DN (down). The first 3 status options will continuously return true if the switch is at that position. The last 4 status options 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.
+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
 
@@ -155,7 +155,18 @@ Using the input pullups provides a high 20K-50K impedance that makes the signals
 
 #### 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 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.
+
+#### Memory Comparison on Leonardo with 2 buttons attached :
+
+| Library      | Version   | Bytes   | Bytes Used |
+| ------------ | --------- | ------- | ---------- |
+| Empty sketch | --        | 149     | --         |
+| **Toggle.h** | **2.0.1** | **177** | **28**     |
+| JC_Button.h  | 2.1.2     | 186     | 37         |
+| Bounce2.h    | 2.71.0    | 193     | 44         |
+| AceButton.h  | 1.9.2     | 205     | 56         |
+| ezButton.h   | 1.0.3     | 331     | 182        |
 
 ### References
 

keywords.txt

@@ -23,19 +23,18 @@ sw9	KEYWORD1
 ##########################################
 
 poll	KEYWORD2
+isUP	KEYWORD2
+isMID	KEYWORD2
+isDN	KEYWORD2
+UPtoMID	KEYWORD2
+MIDtoDN	KEYWORD2
+DNtoMID	KEYWORD2
+MIDtoUP	KEYWORD2
+isON	KEYWORD2
+isOFF	KEYWORD2
+ONtoOFF	KEYWORD2
+OFFtoON	KEYWORD2
 
 ##########################################
 # Constants (LITERAL1)
 ##########################################
-
-isUP	LITERAL1
-isMID	LITERAL1
-isDN	LITERAL1
-UPtoMID	LITERAL1
-MIDtoDN	LITERAL1
-DNtoMID	LITERAL1
-MIDtoUP	LITERAL1
-isON	LITERAL1
-isOFF	LITERAL1
-ONtoOFF	LITERAL1
-OFFtoON	LITERAL1

library.json

@@ -1,7 +1,7 @@
 {
   "name": "Toggle",
-  "version": "2.0.0",
-  "description": "Arduino switch and button library for SPST, SPDT or SP3T contacts. Simple to use, provides debouncing, deglitching and uses very little memory. Status indicates one-shot transitions (depicting direction) and current position status.",
+  "version": "2.1.0",
+  "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",
   "repository":
   {

library.properties

@@ -1,9 +1,9 @@
 name=Toggle
-version=2.0.0
+version=2.1.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=Status indicates one-shot transitions (depicting direction) and current position status.
+paragraph=Captures one-shot transitions (depicting direction) and current position status.
 category=Signal Input/Output
 url=https://github.com/Dlloydev/Toggle
 architectures=*

src/Toggle.cpp

@@ -1,5 +1,5 @@
 /****************************************************
-   Toggle Library for Arduino - Version 2.0.0
+   Toggle Library for Arduino - Version 2.1.0
    by dlloydev https://github.com/Dlloydev/Toggle
    Licensed under the MIT License.
  ****************************************************/
@@ -13,69 +13,122 @@ Toggle::Toggle(uint8_t pinA, uint8_t pinB)
 }
 
 void Toggle::poll() {
-
   if (firstRun) {
     firstRun = false;
     if (_pinA) pinMode(_pinA, INPUT_PULLUP);
     if (_pinB) {
       pinMode(_pinB, INPUT_PULLUP);
-    } else {
-      lastRegA = 0xFF;
-      regA = 0xFF;
-    }
+    } 
   }
-  ms = millis();
-
   lastRegA = regA;
   lastRegB = regB;
 
-  if (ms - sampleTime > 10) {
+  if (millis() - sampleTime > 10) {
+    sampleTime = millis();
     regA = regA << 1 | digitalRead(_pinA);
     if (_pinB) {
       regB = regB << 1 | digitalRead(_pinB);
     }
     else regB = 0xFF;
-    sampleTime = ms;
   }
 
+  // b3:ONtoOFF, b2:OFFtoON, b1:isON, b0:isOFF;
+
   if (_pinA && !_pinB) {
-    if (regA == 0xFF) {
-      isOFF = true;
-      isON = false;
+    if (lastRegA == 0xFF) {
+      statusOne |= 0b00000001; // isOFF = 1
+      statusOne &= 0b11111101; // isON = 0
     }
     if (regA == 0xFC) {
-      isON = true;
-      isOFF = false;
+      statusOne |= 0b00000010; // isON = 1
+      statusOne &= 0b11111110; // isOFF = 0
     }
-    OFFtoON = false;
-    if (lastRegA == 0xFE && regA == 0xFC) OFFtoON = true;
-    ONtoOFF = false;
-    if (lastRegA == 0x7F && regA == 0xFF) ONtoOFF = true;
+    statusOne &= 0b11111011; // OFFtoON = 0
+    if (lastRegA == 0xFF && regA == 0xFE) statusOne |= 0b00000100; // OFFtoON = 1
+    statusOne &= 0b11110111; // ONtoOFF = 0
+    if (lastRegA == 0x7F && regA == 0xFF) statusOne |= 0b00001000; // ONtoOFF = 1
   }
 
+  // b6:MIDtoUP, b5:DNtoMID, b4:MIDtoDN, b3:UPtoMID, b2:isDN, b1:isMID, b0:isUP;
+
   if (_pinA && _pinB) {
     if (lastRegA == 0xFE && regA == 0xFC && regB == 0xFF) {
-      isUP = true;
-      isMID = false;
-      isDN = false;
+      statusTwo |= 0b00000001; // isUP = 1
+      statusTwo &= 0b11111101; // isMID = 0
+      statusTwo &= 0b11111011; // isDN = 0
     }
-    if (regA == 0xFF && regB == 0xFF) {
-      isUP = false;
-      isMID = true;
-      isDN = false;
+    if (lastRegA == 0xFF && lastRegB == 0xFF) {
+      statusTwo &= 0b11111110; // isUP = 0
+      statusTwo |= 0b00000010; // isMID = 1
+      statusTwo &= 0b11111011; // isDN = 0
     }
     if (lastRegB == 0xFE && regB == 0xFC && regA == 0xFF) {
-      isUP = false;
-      isMID = false;
-      isDN = true;
+      statusTwo &= 0b11111110; // isUP = 0
+      statusTwo &= 0b11111101; // isMID = 0
+      statusTwo |= 0b00000100; // isDN = 1
     }
-    UPtoMID = false;
-    if (lastRegA == 0x1 && regA == 0x3 && regB == 0xFF) UPtoMID = true;
-    MIDtoDN = false;
-    if (lastRegB == 0xFE && regB == 0xFC && regA == 0xFF) MIDtoDN = true;
-    DNtoMID = false;
-    if (lastRegB == 0x1 && regB == 0x3 && regA == 0xFF) DNtoMID = true;
-    MIDtoUP = false;
-    if (lastRegA == 0xFE && regA == 0xFC && regB == 0xFF) MIDtoUP = true;
+    statusTwo &= 0b10111111; // MIDtoUP = 0
+    if (lastRegA == 0xFF && regA == 0xFE) statusTwo |= 0b01000000; // MIDtoUP = 1
+    statusTwo &= 0b11110111; // UPtoMID = 0
+    if (lastRegA < 0xFF && regA == 0xFF) statusTwo |= 0b00001000; // UPtoMID = 1
+    statusTwo &= 0b11101111; // MIDtoDN = 0
+    if (lastRegB == 0xFF && regB == 0xFE) statusTwo |= 0b00010000; // MIDtoDN = 1
+    statusTwo &= 0b11011111; // DNtoMID = 0
+    if (lastRegB < 0xFF && regB == 0xFF) statusTwo |= 0b00100000; // DNtoMID = 1
   }
 }
+
+bool Toggle::isOFF() {
+  if ((statusOne & 0b00000001) == 0b00000001) return true;
+  return false;
+}
+
+bool Toggle::isON() {
+  if ((statusOne & 0b00000010) == 0b00000010) return true;
+  return false;
+}
+
+bool Toggle::OFFtoON() {
+  if ((statusOne & 0b00000100) == 0b00000100) return true;
+  return false;
+}
+
+bool Toggle::ONtoOFF() {
+  if ((statusOne & 0b00001000) == 0b00001000) return true;
+  return false;
+}
+
+bool Toggle::isUP() {
+  if ((statusTwo & 0b00000001) == 0b00000001) return true;
+  return false;
+}
+
+bool Toggle::isMID() {
+  if ((statusTwo & 0b00000010) == 0b00000010) return true;
+  return false;
+}
+
+bool Toggle::isDN() {
+  if ((statusTwo & 0b00000100) == 0b00000100) return true;
+  return false;
+}
+
+bool Toggle::UPtoMID() {
+  if ((statusTwo & 0b00001000) == 0b00001000) return true;
+  return false;
+}
+
+bool Toggle::MIDtoDN() {
+  if ((statusTwo & 0b00010000) == 0b00010000) return true;
+  return false;
+}
+
+bool Toggle::DNtoMID() {
+  if ((statusTwo & 0b00100000) == 0b00100000) return true;
+  return false;
+}
+
+bool Toggle::MIDtoUP() {
+  if ((statusTwo & 0b01000000) == 0b01000000) return true;
+  return false;
+}

src/Toggle.h

@@ -1,23 +1,34 @@
 #pragma once
 #ifndef Toggle_h
 #define Toggle_h
-#include "Arduino.h"
+#include <Arduino.h>
 
 class Toggle {
 
   public:
 
     Toggle(uint8_t pinA, uint8_t pinB = 0);
+
     void poll();
+    bool isOFF();
+    bool isON();
+    bool OFFtoON();
+    bool ONtoOFF();
+    bool isUP();
+    bool isMID();
+    bool isDN();
+    bool UPtoMID();
+    bool MIDtoDN();
+    bool DNtoMID();
+    bool MIDtoUP();
 
-    bool isUP, isMID, isDN, UPtoMID, MIDtoDN, DNtoMID, MIDtoUP, isON, isOFF, ONtoOFF, OFFtoON;
+    uint8_t statusOne, statusTwo;
 
   private:
 
-    uint8_t regA = 0xAA, regB = 0x55, lastRegA = 0xAA, lastRegB = 0x55;
-    uint32_t sampleTime, ms;
+    uint8_t regA = 0xFF, regB = 0xFF, lastRegA = 0xFF, lastRegB = 0xFF;
+    uint32_t sampleTime;
     uint8_t _pinA, _pinB;
     bool firstRun = true;
-
 };
 #endif