Update

Major release with new functions and updated readme with function reference and updated examples.

Author: Dlloydev

README.md

@@ -3,32 +3,30 @@
   ====================================
   An example that checks the status of eight buttons.
   All input pins will have their pullups enabled.
-  The serial monitor shows switch transitions by pin number.
+  The LED toggles for each on press transition.
   **********************************************************/
 
 #include <Toggle.h>
 
 const byte num = 8; // number of buttons
 const byte pin[num] = {2, 3, 4, 5, 6, 7, 8, 9}; //button pins
+const byte ledPin = 13;
+byte ledState = LOW;
 
 Toggle *sw = new Toggle[num];
 
 void setup() {
-  while (!Serial) { }; // Leonardo
-  Serial.begin(115200);
   for (int i = 0; i < num; ++i) {
+    sw[i].begin(pin[i]);
     sw[i] = pin[i];
   }
 }
 
 void loop() {
-  for (int i = 0; i < num; i++) {
+
+  for (int i = 0; i < num; i++)  {
     sw[i].poll();
-    if (sw[i].OFFtoON()) {
-      Serial.print("pin"); Serial.print(pin[i]); Serial.println(": OFF⇒ON");
-    }
-    if (sw[i].ONtoOFF()) {
-      Serial.print("pin"); Serial.print(pin[i]); Serial.println(": ON⇒OFF");
-    }
+    if (sw[i].onPress()) ledState = !ledState;
   }
+  digitalWrite(ledPin, ledState);
 }

examples/Eight_buttons/Eight_buttons.ino

@@ -21,17 +21,17 @@ void setup() {
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
   myInput.setInputMode(myInput.inMode::input_bit);
-  myInput.setSampleUs(20); // sample ASAP
+  myInput.setSamplePeriodUs(20); // 0-65535μs
 }
 
 void loop() {
   myInput.poll(bit);
-  if (myInput.OFFtoON(bit)) {
+  if (myInput.onPress()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": OFF⇒ON"));
     ledState = !ledState;
     digitalWrite(ledPin, ledState);
   }
-  if (myInput.ONtoOFF(bit)) {
+  if (myInput.onRelease()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": ON⇒OFF"));
   }
 }

examples/Input_Bit/Input_Bit.ino

@@ -25,19 +25,19 @@ void setup() {
   Serial.begin(115200);
 
   myInput.setInputMode(myInput.inMode::input_port);
-  myInput.setSampleUs(20);
-  myInput.setAlgorithm(2);
+  myInput.setAlgorithm(2); // ignore(2), (1) or (0) glitches for robust, normal and quick response
+  myInput.setSamplePeriodUs(20); // 0-65535μs
 
   for (int i = 0; i < 47; i++) {
     Input = dat[i] << bit;
     myInput.poll(bit);
 
     for (int i = 0; i < 10; i++) { // zoom horizontal
       plot("In", Input + 8, false);
-      plot("isOFF", myInput.isOFF(bit) + 6, false);
-      plot("OFF2ON", myInput.OFFtoON(bit) + 4, false);
-      plot("ON2OFF", myInput.ONtoOFF(bit) + 2, false);
-      plot("isON", myInput.isON(bit), true);
+      plot("isOFF", myInput.isReleased(bit) + 6, false);
+      plot("OFF2ON", myInput.onPress() + 4, false);
+      plot("ON2OFF", myInput.onRelease() + 2, false);
+      plot("isON", myInput.isPressed(bit), true);
     }
   }
 }

examples/Input_Bit_Test/Input_Bit_Test.ino

@@ -21,17 +21,17 @@ void setup() {
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
   myInput.setInputMode(myInput.inMode::input_port); // debounce all bits
-  myInput.setSampleUs(20);
+  myInput.setSamplePeriodUs(20); // 0-65535μs
 }
 
 void loop() {
   myInput.poll();
-  if (myInput.OFFtoON(bit)) {
+  if (myInput.onPress()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": OFF⇒ON"));
     ledState = !ledState;
     digitalWrite(ledPin, ledState);
   }
-  if (myInput.ONtoOFF(bit)) {
+  if (myInput.onRelease()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": ON⇒OFF"));
   }
 }

examples/Input_Port/Input_Port.ino

@@ -59,7 +59,7 @@ void setup() {
 
   myInput.setInputMode(myInput.inMode::input_port);
   myInput.setAlgorithm(2); // ignore(2), (1) or (0) glitches for robust, normal and quick response
-  myInput.setSampleUs(20);
+  myInput.setSamplePeriodUs(20); // 0-65535μs
 
   for (int i = 0; i < 15; i++) {
     Input = dat[i];

examples/Input_Port_Test/Input_Port_Test.ino

@@ -24,10 +24,10 @@ void setup() {
 
 void loop() {
   sw1.poll();
-  if (sw1.OFFtoON()) {
+  if (sw1.onPress()) {
     Serial.println(F("sw1: OFF⇒ON"));
     ledState = !ledState;
     digitalWrite(ledPin, ledState);
   }
-  if (sw1.ONtoOFF()) Serial.println(F("sw1: ON⇒OFF"));
+  if (sw1.onRelease()) Serial.println(F("sw1: ON⇒OFF"));
 }

examples/Input_Pulldown/Input_Pulldown.ino

@@ -1,60 +1,32 @@
 /************************************************************************
   One Button and One Three Position Switch:
   =========================================
-  This example that blinks an LED each time a button or 3-position switch
+  This example checks each time a button or 3-position switch
   has transitioned. All input pins will have their pullups enabled.
-    • the built-in LED will blink once for each transition.
-    • open Serial Monitor to view transition status.
+  Open the Serial Monitor to view transition status.
   ***********************************************************************/
 
 #include <Toggle.h>
 
 const byte buttonPin = 2;
 const byte swPinA = 3;
 const byte swPinB = 4;
-const byte ledPin = LED_BUILTIN;
 
 Toggle sw1(buttonPin);       // button
 Toggle sw2(swPinA, swPinB);  // 3-position switch
 
 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"));
-    blink();
-  }
-  if (sw1.ONtoOFF()) {
-    Serial.println(F("sw1: ON⇒OFF"));
-    blink();
-  }
-  if (sw2.UPtoMID()) {
-    Serial.println(F("sw2: UP⇒MID"));
-    blink();
-  }
-  if (sw2.MIDtoDN()) {
-    Serial.println(F("sw2: MID⇒DN"));
-    blink();
-  }
-  if (sw2.DNtoMID()) {
-    Serial.println(F("sw2: DN⇒MID"));
-    blink();
-  }
-  if (sw2.MIDtoUP()) {
-    Serial.println(F("sw2: MID⇒UP"));
-    blink();
-  }
-}
-
-void blink() {
-  digitalWrite(ledPin, HIGH);
-  delay(20);
-  digitalWrite(ledPin, LOW);
+  if (sw1.onPress()) Serial.println(F("sw1: OFF⇒ON"));
+  if (sw1.onRelease()) Serial.println(F("sw1: ON⇒OFF"));
+  if (sw2.UPtoMID()) Serial.println(F("sw2: UP⇒MID"));
+  if (sw2.MIDtoDN()) Serial.println(F("sw2: MID⇒DN"));
+  if (sw2.DNtoMID()) Serial.println(F("sw2: DN⇒MID"));
+  if (sw2.MIDtoUP()) Serial.println(F("sw2: MID⇒UP"));
 }

examples/One_Button_One_Switch/One_Button_One_Switch.ino

@@ -4,7 +4,6 @@
   A simple example that toggles an LED each time a 3-position switch has
   transitioned.  Both input pins will have its pullup enabled. The
   switch is in the disconnected MID position if both inpits read high.
-    • the built-in LED will blink once for each transition.
     • open Serial Monitor to view transition status.
   ***********************************************************************/
 
@@ -24,26 +23,11 @@ void setup() {
 
 void loop() {
   sw1.poll();
-  if (sw1.UPtoMID()) {
-    Serial.println(F("sw1: UP⇒MID"));
-    blink();
-  }
-  if (sw1.MIDtoDN()) {
-    Serial.println(F("sw1: MID⇒DN"));
-    blink();
-  }
-  if (sw1.DNtoMID()) {
-    Serial.println(F("sw1: DN⇒MID"));
-    blink();
-  }
-  if (sw1.MIDtoUP()) {
-    Serial.println(F("sw1: MID⇒UP"));
-    blink();
-  }
-}
-
-void blink() {
-  digitalWrite(ledPin, HIGH);
-  delay(20);
-  digitalWrite(ledPin, LOW);
+ // call toggle() just after poll(). Toggles on MID⇒UP transitions only
+  digitalWrite(ledPin, sw1.toggle());
+ 
+  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"));
 }

examples/Three_Position_Switch/Three_Position_Switch.ino

@@ -10,7 +10,6 @@
 
 const byte buttonPin = 2;
 const byte ledPin = LED_BUILTIN;
-byte ledState = LOW;
 
 Toggle sw1(buttonPin);
 
@@ -22,10 +21,7 @@ void setup() {
 
 void loop() {
   sw1.poll();
-  if (sw1.OFFtoON()) {
-    Serial.println(F("sw1: OFF⇒ON"));
-    ledState = !ledState;
-    digitalWrite(ledPin, ledState);
-  }
-  if (sw1.ONtoOFF()) Serial.println(F("sw1: ON⇒OFF"));
+  digitalWrite(ledPin, sw1.toggle()); // call toggle() just after poll()
+  if (sw1.onPress()) Serial.println(F("sw1: OFF⇒ON"));
+  if (sw1.onRelease()) Serial.println(F("sw1: ON⇒OFF"));
 }