Update

- Fixed toggle function
- Added `begin()` function to setup in examples
- Updated readme

Author: Dlloydev

README.md

@@ -121,7 +121,7 @@ Toggle(*in);
 
 ##### Description
 
-The constructor defines a button object. If the default constructor is used when declaring an array of pointers to button objects,        then it must be followed by a call to begin in setup. Otherwise, begin() is automatically called and not needed in setup.
+The constructor defines a button object. If the default constructor is used when declaring an array of pointers to button objects,        then it must be followed by a call to begin in setup.
 
 ##### Syntax
 
@@ -293,7 +293,7 @@ else
 
 ##### Description
 
-This function will toggle the return value after each state change. Useful to easily toggle an LED responding to every state change.
+This function will toggle the return value after each `onPress` state change. Useful to easily toggle an LED.
 
 ##### Syntax
 
@@ -305,7 +305,7 @@ This function will toggle the return value after each state change. Useful to ea
 
 ##### Returns
 
-*true* or *false*, toggles after any state change. *(bool)
+*true* or *false*, toggles after each `onPress` state change. *(bool)
 
 
 

examples/Input_Bit/Input_Bit.ino

@@ -9,7 +9,6 @@
 #include <Toggle.h>
 
 const byte ledPin = LED_BUILTIN;
-byte ledState = LOW;
 
 byte bit = 0; // choose bit(0-7)
 byte Input;
@@ -20,6 +19,7 @@ void setup() {
   pinMode(ledPin, OUTPUT);
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
+  myInput.begin(Input);
   myInput.setInputMode(myInput.inMode::input_bit);
   myInput.setSamplePeriodUs(20); // 0-65535μs
 }
@@ -28,10 +28,9 @@ void loop() {
   myInput.poll(bit);
   if (myInput.onPress()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": OFF⇒ON"));
-    ledState = !ledState;
-    digitalWrite(ledPin, ledState);
-  }
+   }
   if (myInput.onRelease()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": ON⇒OFF"));
   }
+   digitalWrite(ledPin, myInput.toggle(bit));
 }

examples/Input_Bit_Test/Input_Bit_Test.ino

@@ -23,7 +23,7 @@ Toggle myInput(&Input);
 void setup() {
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
-
+  myInput.begin(Input);
   myInput.setInputMode(myInput.inMode::input_port);
   myInput.setAlgorithm(2); // ignore(2), (1) or (0) glitches for robust, normal and quick response
   myInput.setSamplePeriodUs(20); // 0-65535μs

examples/Input_Port/Input_Port.ino

@@ -9,7 +9,6 @@
 #include <Toggle.h>
 
 const byte ledPin = LED_BUILTIN;
-byte ledState = LOW;
 
 byte bit = 0; // choose bit(0-7)
 byte Input;
@@ -20,6 +19,7 @@ void setup() {
   pinMode(ledPin, OUTPUT);
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
+  myInput.begin(Input);
   myInput.setInputMode(myInput.inMode::input_port); // debounce all bits
   myInput.setSamplePeriodUs(20); // 0-65535μs
 }
@@ -28,10 +28,9 @@ void loop() {
   myInput.poll();
   if (myInput.onPress()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": OFF⇒ON"));
-    ledState = !ledState;
-    digitalWrite(ledPin, ledState);
   }
   if (myInput.onRelease()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": ON⇒OFF"));
   }
+  digitalWrite(ledPin, myInput.toggle(bit));
 }

examples/Input_Port_Test/Input_Port_Test.ino

@@ -56,7 +56,7 @@ Toggle myInput(&Input);
 void setup() {
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
-
+  myInput.begin(Input);
   myInput.setInputMode(myInput.inMode::input_port);
   myInput.setAlgorithm(2); // ignore(2), (1) or (0) glitches for robust, normal and quick response
   myInput.setSamplePeriodUs(20); // 0-65535μs

examples/Input_Pulldown/Input_Pulldown.ino

@@ -10,24 +10,21 @@
 
 const byte buttonPin = 2;
 const byte ledPin = LED_BUILTIN;
-byte ledState = LOW;
 
 Toggle sw1(buttonPin);
 
 void setup() {
   pinMode(ledPin, OUTPUT);
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
+  sw1.begin(buttonPin);
   sw1.setInputMode(sw1.inMode::input_pulldown);
   sw1.setInvertMode(true);
 }
 
 void loop() {
   sw1.poll();
-  if (sw1.onPress()) {
-    Serial.println(F("sw1: OFF⇒ON"));
-    ledState = !ledState;
-    digitalWrite(ledPin, ledState);
-  }
+  if (sw1.onPress()) Serial.println(F("sw1: OFF⇒ON"));
   if (sw1.onRelease()) Serial.println(F("sw1: ON⇒OFF"));
+  digitalWrite(ledPin, sw1.toggle());
 }

examples/One_Button_One_Switch/One_Button_One_Switch.ino

@@ -1,32 +1,38 @@
-/************************************************************************
+/******************************************************************
   One Button and One Three Position Switch:
   =========================================
-  This example checks each time a button or 3-position switch
+  This example that blinks an LED each time the button
   has transitioned. All input pins will have their pullups enabled.
   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);
+  sw1.begin(buttonPin);
+  sw2.begin(swPinA, swPinB);
 }
 
 void loop() {
   sw1.poll();
   sw2.poll();
+
   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"));
+  digitalWrite(ledPin, sw1.toggle());
 }

examples/Three_Position_Switch/Three_Position_Switch.ino

@@ -1,33 +1,32 @@
-/************************************************************************
+/***********************************************************************
   Using Three Position Switches:
   ==============================
   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.
-    • open Serial Monitor to view transition status.
-  ***********************************************************************/
+  Open the Serial Monitor to view transition status.
+  **********************************************************************/
 
 #include <Toggle.h>
 
 const byte pinA = 2;
 const byte pinB = 3;
 const byte ledPin = LED_BUILTIN;
 
-Toggle sw1(pinA, pinB);  // 3-position switch
+Toggle sw1(pinA, pinB); // 3-position switch
 
 void setup() {
   pinMode(ledPin, OUTPUT);
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
+  sw1.begin(pinA, pinB);
 }
 
 void loop() {
   sw1.poll();
- // 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"));
+  digitalWrite(ledPin, sw1.toggle()); // toggles on MID⇒UP transition only
 }

examples/Toggle_Basic/Toggle_Basic.ino

@@ -14,14 +14,15 @@ const byte ledPin = LED_BUILTIN;
 Toggle sw1(buttonPin);
 
 void setup() {
-  pinMode(ledPin, OUTPUT);
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
+  sw1.begin(buttonPin);
+  pinMode(ledPin, OUTPUT);
 }
 
 void loop() {
   sw1.poll();
-  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"));
+  digitalWrite(ledPin, sw1.toggle());
 }

library.json

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