Update

- Added new `setSampleUs()` function to allow adjusting the sample period from 0-65535μs.
- Some fixes and updates to examples and code.

Author: Dlloydev

README.md

@@ -74,6 +74,12 @@ 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
+
+void setSampleUs(uint16_t sampleUs);
+
+// default sample period is 5000μs, range is 0-65535μs (0-65ms)
+// using 8 samples, the range for debounce will be (0-524ms)
+sw1.setSampleUs(5000); //μs
 ```
 
 #### Example Sketch:

examples/Toggle_Basic/Toggle_Basic.ino

@@ -14,7 +14,6 @@ const byte ledPin = LED_BUILTIN;
 byte ledState = LOW;
 
 Toggle sw1(buttonPin);
-Toggle sw2(buttonPin + 1);
 
 void setup() {
   pinMode(ledPin, OUTPUT);
@@ -24,11 +23,10 @@ void setup() {
 
 void loop() {
   sw1.poll();
-  sw2.poll();
-  if (sw1.ONtoOFF()) Serial.println(F("sw1: ON⇒OFF"));
   if (sw1.OFFtoON()) {
     Serial.println(F("sw1: OFF⇒ON"));
     ledState = !ledState;
     digitalWrite(ledPin, ledState);
   }
+  if (sw1.ONtoOFF()) Serial.println(F("sw1: ON⇒OFF"));
 }

keywords.txt

@@ -35,7 +35,7 @@ isOFF	KEYWORD2
 ONtoOFF	KEYWORD2
 OFFtoON	KEYWORD2
 setInputMode	KEYWORD2
-getInputMode	KEYWORD2
+setSampleUs	KEYWORD2
 
 ##########################################
 # Constants (LITERAL1)

library.json

@@ -1,6 +1,6 @@
 {
   "name": "Toggle",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "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":

library.properties

@@ -1,5 +1,5 @@
 name=Toggle
-version=2.2.0
+version=2.2.1
 author=David Lloyd
 maintainer=David Lloyd <[email protected]>
 sentence=Arduino library for deglitching and debouncing signals, stored data, buttons and switches. Decodes transistions (depicting direction) for SPST, SPDT or SP3T contacts.

src/Toggle.cpp

@@ -1,5 +1,5 @@
 /****************************************************
-   Toggle Library for Arduino - Version 2.2.0
+   Toggle Library for Arduino - Version 2.2.1
    by dlloydev https://github.com/Dlloydev/Toggle
    Licensed under the MIT License.
  ****************************************************/
@@ -14,6 +14,8 @@ Toggle::Toggle(uint8_t *logic) : _logic(logic) { }
 void Toggle::poll() {
   if (firstRun) {
     firstRun = false;
+    lastUs = micros();
+    statesOne |= 0b00010000; // lastOFF = 1
 
     if (_pinA) {
       if (_inputMode == static_cast<uint8_t>(inMode::input_pullup)) pinMode(_pinA, INPUT_PULLUP);
@@ -27,9 +29,8 @@ void Toggle::poll() {
   }
   lastRegA = regA;
   lastRegB = regB;
-
-  if (millis() - sampleTime > 5) {
-    sampleTime = millis();
+  if (micros() - lastUs > _sampleUs) {
+    lastUs += _sampleUs;
     if (_inputMode <= 2) {
       regA = regA << 1 | digitalRead(_pinA);
       if (_pinB) regB = regB << 1 | digitalRead(_pinB);
@@ -44,7 +45,7 @@ void Toggle::poll() {
 }
 
 void Toggle::setStatesOne() {
-  // when using one input b3:ONtoOFF, b2:OFFtoON, b1:isON, b0:isOFF;
+  // when using one input b4:lastOFF, b3:ONtoOFF, b2:OFFtoON, b1:isON, b0:isOFF;
   if (lastRegA == 0xFF) {
     statesOne |= 0b00000001; // isOFF = 1
     statesOne &= 0b11111101; // isON = 0
@@ -54,10 +55,13 @@ void Toggle::setStatesOne() {
     statesOne &= 0b11111110; // isOFF = 0
   }
   statesOne &= 0b11111011; // OFFtoON = 0
-  //if (lastRegA == 0xFF && regA == 0xFE) statesOne |= 0b00000100; // OFFtoON = 1
-  if ((lastRegA & 1) == 0 && (regA & 3) == 0) statesOne |= 0b00000100; // OFFtoON = 1
+  if ((statesOne & 0b00010000) && (statesOne & 0b00000001) == 0) statesOne |= 0b00000100; // OFFtoON = 1
+
   statesOne &= 0b11110111; // ONtoOFF = 0
-  if (lastRegA == 0x7F && regA == 0xFF) statesOne |= 0b00001000; // ONtoOFF = 1
+  if ((statesOne & 0b00010000) == 0 && (statesOne & 0b00000001)) statesOne |= 0b00001000; // ONtoOFF = 1
+
+  if (statesOne & 1) statesOne |= 0b00010000; // lastOFF = 1
+  else statesOne &= 0b11101111; // lastOFF = 0
 }
 
 void Toggle::setStatesTwo() {
@@ -91,8 +95,8 @@ void Toggle::setInputMode(inMode inputMode) {
   _inputMode = static_cast<uint8_t>(inputMode);
 }
 
-uint8_t Toggle::getInputMode() {
-  return static_cast<uint8_t>(_inputMode);
+void Toggle::setSampleUs(uint16_t sampleUs) {
+  _sampleUs = sampleUs;
 }
 
 bool Toggle::isOFF() {

src/Toggle.h

@@ -26,20 +26,23 @@ class Toggle {
     bool DNtoMID();
     bool MIDtoUP();
     void setInputMode(inMode inputMode);
-    uint8_t getInputMode();
+    void setSampleUs(uint16_t sampleUs);
 
-  private:
+   private:
     void setStatesOne();
     void setStatesTwo();
-    float *_Input;
+
+    uint8_t _inputMode = static_cast<uint8_t>(inMode::input_pullup);
+    uint8_t _pinA, _pinB;
     uint8_t *_logic;
-    uint8_t statesOne, statesTwo;
-    uint8_t regA = 0xFF, regB = 0xFF, lastRegA = 0xFF, lastRegB = 0xFF;
-    uint32_t sampleTime;
+    float *_Input;
+ 
     bool firstRun = true;
     inMode inputMode = inMode::input_pullup;
-    uint8_t _inputMode = static_cast<uint8_t>(inMode::input_pullup);
-    uint8_t _pinA, _pinB;
+    uint8_t regA = 0xFF, regB = 0xFF, lastRegA = 0xFF, lastRegB = 0xFF;
+    uint8_t statesOne, statesTwo;
+    uint16_t _sampleUs = 5000;
+    uint32_t lastUs;
 
 };
 #endif