Update

Refactored code, updated examples and readme.

Author: Dlloydev

README.md

@@ -1,12 +1,12 @@
 # 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 button library for debouncing switch contacts and logic data.  New pressCode() function detects fast, short and long button presses for 225 combinations. Works with all switch types, port expanders and other 8-bit data sources. Debounce algorithm ignores several consecutive  spurious transitions.
+Arduino button library for debouncing switch contacts and input data.  New pressCode() function detects fast, short and long button presses for 225 combinations. Works with all switch types, port expanders and other 8-bit data sources. Debounce algorithm ignores several consecutive  spurious transitions.
 
 ## Features
 
 ### Flexible Inputs
 
-The inputs can be from a single pin or several pins allowing the use of 2 or 3-position switches and up to seven debounced states. When linking to a data (byte) input, the debouncer can work with any selected bit or it can debounce all 8-bits in one Toggle instance. Examples:  [`Input_Bit_Test.ino`](https://github.com/Dlloydev/Toggle/blob/main/examples/Input_Bit_Test/Input_Bit_Test.ino) , [`Input_Bit.ino`](https://github.com/Dlloydev/Toggle/blob/main/examples/Input_Bit/Input_Bit.ino),  [`Input_Port_Test.ino`](https://github.com/Dlloydev/Toggle/blob/main/examples/Input_Port_Test/Input_Port_Test.ino) and [`Input_Port.ino`](https://github.com/Dlloydev/Toggle/blob/main/examples/Input_Port/Input_Port.ino).
+The inputs can be from a single pin or several pins allowing the use of 2 or 3-position switches and up to seven debounced states. When linking to a data (byte) input, the debouncer can work with any selected bit or it can debounce all 8-bits in one Toggle instance. See [examples](https://github.com/Dlloydev/Toggle/tree/main/examples).
 
 ### Debounce Algorithm
 
@@ -122,15 +122,9 @@ None.
 ##### Example
 
 ```c++
-// a button or switch is connected from pin 2 to ground, 5000 μs sample interval (default),
-// pullup enabled (default), inverted = false (default)
-Toggle myInput(2);
-
-// same as above, but a 3 position switch is connected to pins 2 and 3
-Toggle myInput(2, 3);
-
-// a byte variable is linked to the Toggle object, defaults are same as above
-Toggle myInput(*Input);
+Toggle myInput(2);      // Button connected pin 2 to GND, INPUT_PULLUP, debounced
+Toggle myInput(2, 3);   // SPDT switch connected pins 2 and 3 to GND, INPUT_PULLUP, debounced
+Toggle myInput(*Input); // Byte variable as input, debounced
 ```
 
 
@@ -267,19 +261,18 @@ else {
 
 ##### Description
 
-This function will toggle the return value after each `onPress` state change. Useful to easily toggle an LED.
+This function can be used to convert a momentary push button to a toggle switch. By default, the retuen value will toggle `true-false` then `false-true` for  each `onPress` action of the button.
 
-##### Syntax
-
-`myInput.toggle(invert);` 
+- The `setToggleState()` function sets the initial state (*true* or *false*)
+- The `setToggleTrigger()` function sets the trigger mode: *false*: `onPress`, *true*: `onRelease`
 
 ##### Parameters
 
-**invert:** can be used to invert the initial toggle state *(bool)*
+None.
 
 ##### Returns
 
-*true* or *false*, toggles after each `onPress` state change. *(bool)
+*true* or *false*, (*bool*). Toggles as configured by `setToggleTrigger()`. Default is trigger `onPress`
 
 
 
@@ -420,21 +413,20 @@ None.
 myInput.setInputMode(sw1.inMode::input_input);     // high impedance input
 myInput.setInputMode(sw1.inMode::input_pullup);    // pullup resistor enabled (default)
 myInput.setInputMode(sw1.inMode::input_pulldown);  // pulldown resistor enabled (ESP32) 
-myInput.setInputMode(sw1.inMode::input_bit);       // input byte (bit0)
-myInput.setInputMode(sw1.inMode::input_port);      // input byte (8-bit)
+myInput.setInputMode(sw1.inMode::input_byte);      // input byte (8-bit)
 ```
 
 
 
-## setInvertMode()
+## setInputInvert()
 
 ##### Description
 
 Set true if the button or switch pulls the signal high when pressed. Default is false (button or switch pulls the signal low when pressed).
 
 ##### Syntax
 
-`myInput.setInvertMode(true);` 
+`myInput.setInputInvert(true);` 
 
 ##### Returns
 

examples/Input_Bit/Input_Bit.ino

@@ -24,7 +24,7 @@ void setup() {
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
   myInput.begin(Input);
-  myInput.setInputMode(myInput.inMode::input_port);
+  myInput.setInputMode(myInput.inputMode::input_byte);
   myInput.setSamplePeriodUs(20); // 0-65535μs
 
   for (int i = 0; i < 47; i++) {

examples/Input_Bit_Test/Input_Bit_Test.ino

@@ -1,5 +1,5 @@
 /******************************************************************
-  Input Port Example:
+  Input Byte Example:
   ===================
   This example demonstrates how you can debounce any byte variable
   in the sketch. The Arduino pin functions are not used.
@@ -20,7 +20,7 @@ void setup() {
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
   myInput.begin(Input);
-  myInput.setInputMode(myInput.inMode::input_port); // debounce all bits
+  myInput.setInputMode(myInput.inputMode::input_byte); // debounce all bits
   myInput.setSamplePeriodUs(20); // 0-65535μs
 }
 
@@ -32,5 +32,5 @@ void loop() {
   if (myInput.onRelease()) {
     Serial.print(F("b")); Serial.print(bit); Serial.println(F(": ON⇒OFF"));
   }
-  digitalWrite(ledPin, myInput.toggle(bit));
+  digitalWrite(ledPin, myInput.toggle());
 }

examples/Input_Port/Input_Port.ino renamed to examples/Input_Byte/Input_Byte.ino

@@ -1,5 +1,5 @@
 /*************************************************************************
-  Input Port Debouncer Test Example:
+  Input Byte Debouncer Test Example:
   ==================================
   This example demonstrates how you can debounce an 8-bit byte (8 signals)
   in just one Toggle object. The Arduino pin functions are not used.
@@ -57,7 +57,7 @@ void setup() {
   while (!Serial) { }; // Leonardo
   Serial.begin(115200);
   myInput.begin(Input);
-  myInput.setInputMode(myInput.inMode::input_port);
+  myInput.setInputMode(myInput.inputMode::input_byte);
   myInput.setSamplePeriodUs(20); // 0-65535μs
 
   for (int i = 0; i < 15; i++) {
@@ -66,7 +66,7 @@ void setup() {
     Serial.print(F("In: "));
     Serial.print(dat[i], BIN);
     Serial.print(F(" Out: "));
-    Serial.println(myInput.debounceInput(), BIN);
+    Serial.println(myInput.debouncer(), BIN);
   }
 }
 

examples/Input_Port_Test/Input_Port_Test.ino renamed to examples/Input_Byte_Test/Input_Byte_Test.ino

@@ -15,16 +15,13 @@ 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);
+  sw1.setInputMode(sw1.inputMode::input_pulldown);
+  sw1.setToggleState(0);    // set initial state 0 or 1
+  sw1.setToggleTrigger(0);  // set trigger onPress: 0, or onRelease: 1
 }
 
 void loop() {
   sw1.poll();
-  if (sw1.onPress()) Serial.println(F("sw1: OFF⇒ON"));
-  if (sw1.onRelease()) Serial.println(F("sw1: ON⇒OFF"));
   digitalWrite(ledPin, sw1.toggle());
 }

examples/Input_Pulldown/Input_Pulldown.ino

@@ -1,11 +1,9 @@
-/*******************************************************************************
-  TURN A MOMENTARY PUSHBUTTON INTO A TOGGLE SWITCH:
+/***********************************************
+  USE A MOMENTARY PUSHBUTTON AS A TOGGLE SWITCH:
   The button is connected from input pin to GND.
   INPUT_PULLUP and debouncing are pre-configured.
-  The built in LED changes state each time the button is pressed.
-  For the LED to change state on release, un-comment button.setInvertMode(1);
-  For LED startup in opposite state, use digitalWrite(ledPin, button.toggle(1));
-  ******************************************************************************/
+  The built in LED changes state as configured.
+  **********************************************/
 
 #include <Toggle.h>
 
@@ -16,7 +14,9 @@ Toggle button(buttonPin);
 
 void setup() {
   button.begin(buttonPin);
-  //button.setInvertMode(1);
+  button.setToggleState(0);    // set initial state 0 or 1
+  button.setToggleTrigger(0);  // set trigger onPress: 0, or onRelease: 1
+
   pinMode(ledPin, OUTPUT);
 }
 

examples/Use_Button_As_Toggle/Use_Button_As_Toggle.ino

@@ -8,6 +8,7 @@
 
 Toggle	KEYWORD1
 myInput	KEYWORD1
+myButton	KEYWORD1
 sw	KEYWORD1
 sw0	KEYWORD1
 sw1	KEYWORD1
@@ -26,21 +27,23 @@ sw9	KEYWORD1
 
 poll	KEYWORD2
 setInputMode	KEYWORD2
-setInvertMode	KEYWORD2
+setInputInvert	KEYWORD2
+toggle	KEYWORD2
+setToggleState	KEYWORD2
+setToggleTrigger	KEYWORD2
 setSamplePeriodUs	KEYWORD2
 getElapsedMs	KEYWORD2
 isPressed	KEYWORD2
 isReleased	KEYWORD2
 onPress	KEYWORD2
 onRelease	KEYWORD2
 onChange	KEYWORD2
-toggle	KEYWORD2
 blink	KEYWORD2
 pressedFor	KEYWORD2
 releasedFor	KEYWORD2
 retrigger	KEYWORD2
 pressCode	KEYWORD2
-debounceInput	KEYWORD2
+debouncer	KEYWORD2
 isUP	KEYWORD2
 isMID	KEYWORD2
 isDN	KEYWORD2
@@ -57,6 +60,6 @@ input	LITERAL1
 input_pullup	LITERAL1
 input_pulldown	LITERAL1
 input_bit	LITERAL1
-input_port	LITERAL1
+input_byte	LITERAL1
 MULTI	LITERAL1
 LONG	LITERAL1

keywords.txt

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

library.json

@@ -1,5 +1,5 @@
 name=Toggle
-version=3.1.4
+version=3.1.5
 author=David Lloyd
 maintainer=David Lloyd <[email protected]>
 sentence=Arduino bounce library for deglitching and debouncing hardware, signals and data. Works with all switch types, port expander and other 8-bit data sources.