modified: examples/button/button.ino

	modified:   examples/resetset/resetset.ino
	new file:   examples/resetset/temp.ino
	modified:   examples/toggle/toggle.ino
	modified:   keywords.txt
	modified:   library.properties
	modified:   src/adebouncer.cpp
	modified:   src/adebouncer.h

Author: MicroBeaut

examples/Button/Button.ino

@@ -1,23 +1,22 @@
 /*
-  Declare debounce mode as delayed mode.
-  Debounce the input signal from the button
-  and update LED_BUILTIN with the debounced state.
+  This code initializes a delayed debounce mode, debounces the button input signal,
+  and updates the state of the built-in LED accordingly.
 */
-
+ 
 #include "ADebouncer.h"
-
-#define buttonPin 2         // Define the button input pin.
-#define debouncePeroid 10   // Define the debounce period in milliseconds
-
-ADebouncer debouncer;       // Declare debouncer variable.
-
+ 
+#define BUTTON_INPUT_PIN 2    // Pin for the button input.
+#define DEBOUNCE_PERIOD_MS 10 // Debounce period in milliseconds.
+ 
+ADebouncer buttonDebouncer;   // Create a debouncer instance.
+ 
 void setup() {
-  pinMode(buttonPin, INPUT_PULLUP);               // Set the button mode as input pullup.
-  pinMode(LED_BUILTIN, OUTPUT);                   // Set the LED_BUILTIN mode as output.
-  debouncer.mode(DELAYED, debouncePeroid, HIGH);  // Set the debounce mode as delayed mode and debounce period as 10 ms, with the initial output in a HIGH state.
+  pinMode(BUTTON_INPUT_PIN, INPUT_PULLUP);  // Set the button input pin as input with pull-up.
+  pinMode(LED_BUILTIN, OUTPUT);             // Set the built-in LED pin as output.
+  buttonDebouncer.setMode(DELAYED, DEBOUNCE_PERIOD_MS, HIGH); // Set debounce mode to delayed with a 10ms period, starting with a HIGH output.
 }
-
+ 
 void loop() {
-  bool buttonState = debouncer.debounce(digitalRead(buttonPin));  // Save the debounced of the button state.
-  digitalWrite(LED_BUILTIN, buttonState);                         // Update LED_BUILTIN with the button state.
+  bool debouncedButtonState = buttonDebouncer.debounce(digitalRead(BUTTON_INPUT_PIN));  // Get the debounced button state.
+  digitalWrite(LED_BUILTIN, debouncedButtonState);                                      // Update the built-in LED with the debounced button state.
 }

examples/ResetSet/ResetSet.ino

@@ -1,31 +1,34 @@
 /*
-  Declare debounce mode as delayed mode.
-  Debounce the input signal from the button.
-  Toggle the state when pressing the button and update LED_BUILTIN with the toggle state.
+  Description: Debounces the input signals from the set and reset buttons and updates the state of LED_BUILTIN accordingly.
 */
 
 #include "ADebouncer.h"
 
-#define setPin          12    // Define the set input pin.
-#define resetPin        11    // Define the reset input pin.
-#define debouncePeroid  1000  // Define the debounce period in milliseconds
+#define SET_PIN          12       // Define the set input pin.
+#define RESET_PIN        11       // Define the reset input pin.
+#define DEBOUNCE_PERIOD_MS  1000  // Define the debounce period in milliseconds
 
 ADebouncer setButton;       // Declare set debouncer variable.
 ADebouncer resetButton;     // Declare reset debouncer variable.
 bool state;                 // Declare state variable for ResetSet.
 
 void setup() {
-  pinMode(setPin, INPUT_PULLUP);                    // Set the button mode as input pullup.
-  pinMode(resetPin, INPUT_PULLUP);                  // Set the button mode as input pullup.
-  pinMode(LED_BUILTIN, OUTPUT);                     // Set the LED_BUILTIN mode as output.
-  setButton.mode(DELAYED, debouncePeroid, HIGH);    // Set the debounce mode as delayed mode and debounce period, with the initial output in a HIGH state.
-  resetButton.mode(INSTANT, debouncePeroid, HIGH);  // Set the debounce mode as instant mode and debounce period, with the initial output in a HIGH state.
-  state = LOW;                                      // Initial state in a LOW state.
+  pinMode(SET_PIN, INPUT_PULLUP);   // Set the button mode as input pullup.
+  pinMode(RESET_PIN, INPUT_PULLUP); // Set the button mode as input pullup.
+  pinMode(LED_BUILTIN, OUTPUT);     // Set the LED_BUILTIN mode as output.
+  setButton.setMode(DELAYED, DEBOUNCE_PERIOD_MS, HIGH);    // Set the debounce mode as delayed mode and debounce period, with the initial output in a HIGH state.
+  resetButton.setMode(INSTANT, DEBOUNCE_PERIOD_MS, HIGH);  // Set the debounce mode as instant mode and debounce period, with the initial output in a HIGH state.
+  state = LOW;                                          // Initial state in a LOW state.
 }
 
 void loop() {
-  setButton.debounce(digitalRead(setPin));                              // Debounce input of the set button state.
-  resetButton.debounce(digitalRead(resetPin));                          // Debounce input of the reset button state.
-  state = (state | !setButton.debounced()) & resetButton.debounced();   // Reset and Set the state
-  digitalWrite(LED_BUILTIN, state);                                     // Update LED_BUILTIN with the state.
+  // Debounce input of the set button state.
+  setButton.debounce(digitalRead(SET_PIN));
+  // Debounce input of the reset button state.
+  resetButton.debounce(digitalRead(RESET_PIN));
+
+  // Update the state based on set and reset button outputs.
+  state = (state | !setButton.getDebouncedOutput()) & resetButton.getDebouncedOutput();
+  // Update LED_BUILTIN with the state.
+  digitalWrite(LED_BUILTIN, state);
 }

examples/ResetSet/temp.ino

@@ -0,0 +1,22 @@
+/*
+  This code initializes a delayed debounce mode, debounces the button input signal,
+  and updates the state of the built-in LED accordingly.
+*/
+ 
+#include "ADebouncer.h"
+ 
+#define BUTTON_INPUT_PIN 2        // Pin for the button input.
+#define DEBOUNCE_PERIOD_MS 10      // Debounce period in milliseconds.
+ 
+ADebouncer buttonDebouncer;       // Create a debouncer instance.
+ 
+void setup() {
+  pinMode(BUTTON_INPUT_PIN, INPUT_PULLUP);            // Set the button input pin as input with pull-up.
+  pinMode(LED_BUILTIN, OUTPUT);                       // Set the built-in LED pin as output.
+  buttonDebouncer.setMode(DELAYED, DEBOUNCE_PERIOD_MS, HIGH);  // Set debounce mode to delayed with a 10ms period, starting with a HIGH output.
+}
+ 
+void loop() {
+  bool debouncedButtonState = buttonDebouncer.debounce(digitalRead(BUTTON_INPUT_PIN));  // Get the debounced button state.
+  digitalWrite(LED_BUILTIN, debouncedButtonState);                                   // Update the built-in LED with the debounced button state.
+}

examples/Toggle/Toggle.ino

@@ -1,32 +1,32 @@
 /*
-  This example is designed to have a set button and a reset button to Reset-Set the state.
-  - Declare debouncer for the set button. set the debounce as a delayed mode
-  - Declare debouncer for the reset button. Set the debounce as an instant mode
+  This example sets up a debouncer for a set button and a reset button to control the state.
+  - Declare a debouncer for the set button with delayed mode for debouncing.
+  - Declare a debouncer for the reset button with instant mode for debouncing.
 
-  Both set and reset buttons have the same debounce period. in this example, will be set to debounce period for 1 second,
+  Both set and reset buttons have a debounce period set to 1 second.
   - To set the state, press the set button for 1 second.
-  - To reset the state, the state will be instantly reset after pressing the reset button.
+  - To reset the state, press the reset button for an instant reset.
 
-  The LED_BUILTIN will be updated with the state value.
+  The LED_BUILTIN will reflect the state value.
 */
 
 #include "ADebouncer.h"
 
-#define buttonPin 12        // Define the button input pin.
-#define debouncePeroid 10   // Define the debounce period in milliseconds
+#define BUTTON_INPUT_PIN 12     // Define the button input pin.
+#define DEBOUNCE_PERIOD_MS 10   // Define the debounce period in milliseconds
 
-ADebouncer debouncer;       // Declare debouncer variable.
-bool state;                 // Declare state variable.
+ADebouncer buttonDebouncer;       // Declare debouncer variable.
+bool state;                       // Declare state variable.
 
 void setup() {
-  pinMode(buttonPin, INPUT_PULLUP);               // Set the button mode as input pullup.
-  pinMode(LED_BUILTIN, OUTPUT);                   // Set the LED_BUILTIN mode as output.
-  debouncer.mode(DELAYED, debouncePeroid, HIGH);  // Set the debounce mode as delayed mode and debounce period, with the initial output in a HIGH state.
-  state = HIGH;                                   // Initial state in a HIGH state.
+  pinMode(BUTTON_INPUT_PIN, INPUT_PULLUP);                      // Set the button mode as input pullup.
+  pinMode(LED_BUILTIN, OUTPUT);                                 // Set the LED_BUILTIN mode as output.
+  buttonDebouncer.setMode(DELAYED, DEBOUNCE_PERIOD_MS, HIGH);   // Set the debounce mode as delayed mode and debounce period, with the initial output in a HIGH state.
+  state = HIGH;                                                 // Initial state is set to HIGH.
 }
 
 void loop() {
-  debouncer.debounce(digitalRead(buttonPin));   // Debounce input of the button state.
-  if (debouncer.falling()) state = !state;      // Toggle state of the state variable.
-  digitalWrite(LED_BUILTIN, state);             // Update LED_BUILTIN with the state.
+  buttonDebouncer.debounce(digitalRead(BUTTON_INPUT_PIN));  // Debounce input of the button state.
+  if (buttonDebouncer.isFallingEdge()) state = !state;      // Toggle state of the state variable.
+  digitalWrite(LED_BUILTIN, state);                         // Update LED_BUILTIN with the state.
 }

keywords.txt

@@ -11,14 +11,14 @@ instant_t       KEYWORD1
 #######################################
 # Methods and Functions (KEYWORD2)
 #######################################
-mode            KEYWORD2
-debounce        KEYWORD2
-input           KEYWORD2
-debouncing      KEYWORD2
-debounced       KEYWORD2
-rising          KEYWORD2
-falling         KEYWORD2
-MS2US           KEYWORD2
+setMode             KEYWORD2
+debounce            KEYWORD2
+getInputState       KEYWORD2
+isDebouncing        KEYWORD2
+getDebouncedOutput  KEYWORD2
+isRisingEdge        KEYWORD2
+isFallingEdge       KEYWORD2
+MS2US               KEYWORD2
 
 #######################################
 # Constants (LITERAL1)

library.properties

@@ -1,5 +1,5 @@
 name=ADebouncer
-version=1.1.1
+version=1.2.0
 author=MicroBeaut
 maintainer=MicroBeaut
 sentence=Advanced Debouncer Library for Arduino.

src/ADebouncer.cpp

@@ -10,56 +10,60 @@
 #include "ADebouncer.h"
 
 ADebouncer::ADebouncer() {
-  _instant = DEFAULT_DEBOUNCE_MODE;
-  _debouncePeriod = MS2US(DEFAULT_DEBOUNCE_PERIOD);
-  _output = DEFAULT_INITIAL_OUTPUT;
+  _debounceMode = DEFAULT_DEBOUNCE_MODE;
+  _debouncePeriodMicros = MS2US(DEFAULT_DEBOUNCE_PERIOD);
+  _outputState = DEFAULT_INITIAL_OUTPUT;
 }
 
-void ADebouncer::mode(debounce_t instant, unsigned long debouncePeriod, boolean initOutput) {
-  _instant = instant;
-  _debouncePeriod = MS2US(debouncePeriod);
-  _output = initOutput;
+void ADebouncer::setMode(DebounceMode mode, unsigned long debouncePeriod, boolean initialOutputState) {
+  _debounceMode = mode;
+  _debouncePeriodMicros = MS2US(debouncePeriod);
+  _outputState = initialOutputState;
 }
 
 boolean ADebouncer::debounce(boolean input) {
   unsigned long currentTime = micros();
-  _prevInput = _input;
-  _prevOutput = _output;
-  _input = input;
-  if (_input ^ _prevInput) _debounceStartTime = currentTime;
-  if (_debouncing) {
+  _previousInputState = _inputState;
+  _previousOutputState = _outputState;
+  _inputState = input;
+  if (_inputState ^ _previousInputState) {
+    _debounceStartTime = currentTime;
+  }
+  if (_isDebouncing) {
     unsigned long elapsedTime = currentTime - _debounceStartTime;
-    if (elapsedTime >= _debouncePeriod) {
-      _debouncing = false;
-      _output = _input;
+    if (elapsedTime >= _debouncePeriodMicros) {
+      _isDebouncing = false;
+      _outputState = _inputState;
     }
   } else {
-    if (_input ^ _output) {
-      if (_instant) _output = _input;
-      _debouncing = true;
+    if (_inputState ^ _outputState) {
+      if (_debounceMode) {
+        _outputState = _inputState;
+      }
+      _isDebouncing = true;
     }
   }
-  _rising = _output & ~_prevOutput;
-  _falling = ~_output & _prevOutput;
-  return _output;
+  _risingEdge = _outputState & ~_previousOutputState;
+  _fallingEdge = ~_outputState & _previousOutputState;
+  return _outputState;
 }
 
-boolean ADebouncer::input() {
-  return _input;
+boolean ADebouncer::getInputState() {
+  return _inputState;
 }
 
-boolean ADebouncer::debouncing() {
-  return _debouncing;
+boolean ADebouncer::isDebouncing() {
+  return _isDebouncing;
 }
 
-boolean ADebouncer::debounced() {
-  return _output;
+boolean ADebouncer::getDebouncedOutput() {
+  return _outputState;
 }
 
-boolean ADebouncer::rising() {
-  return _rising;
+boolean ADebouncer::isRisingEdge() {
+  return _risingEdge;
 }
 
-boolean ADebouncer::falling() {
-  return _falling;
+boolean ADebouncer::isFallingEdge() {
+  return _fallingEdge;
 }

src/ADebouncer.h

@@ -12,45 +12,45 @@
 
 #include <Arduino.h>
 
-#define ADEBOUNCER_VERSION "1.1.1"
+#define ADEBOUNCER_VERSION "1.2.0"
 #define ADEBOUNCER_AUTHOR "MicroBeaut"
 
-enum debounce_t : boolean {DELAYED, INSTANT};
+enum DebounceMode : boolean {DELAYED, INSTANT};
 
-#define DEFAULT_DEBOUNCE_PERIOD 10        // Default debounce Period in milliseconds
-#define DEFAULT_DEBOUNCE_MODE   DELAYED   // Default debounce mode
+#define DEFAULT_DEBOUNCE_PERIOD 10        // Default debounce period in milliseconds
+#define DEFAULT_DEBOUNCE_MODE   DebounceMode::DELAYED   // Default debounce mode
 #define DEFAULT_INITIAL_OUTPUT  true      // Default initial output
 
 #ifndef MS2US
-#define MS2US(ms) (ms*1000UL)
+#define MS2US(ms) (ms * 1000UL)
 #endif  // MS2US
 
 class ADebouncer {
   private:
-    unsigned char _instant: 1;
-    unsigned char _debouncing: 1;
+    unsigned char _debounceMode: 1;
+    unsigned char _isDebouncing: 1;
 
-    unsigned char _input: 1;
-    unsigned char _prevInput: 1;
+    unsigned char _inputState: 1;
+    unsigned char _previousInputState: 1;
 
-    unsigned char _output: 1;
-    unsigned char _prevOutput: 1;
+    unsigned char _outputState: 1;
+    unsigned char _previousOutputState: 1;
 
-    unsigned char _rising: 1;
-    unsigned char _falling: 1;
+    unsigned char _risingEdge: 1;
+    unsigned char _fallingEdge: 1;
 
-    unsigned long _debouncePeriod;
+    unsigned long _debouncePeriodMicros;
     unsigned long _debounceStartTime;
 
   public:
     ADebouncer();
-    void mode(debounce_t instant, unsigned long debouncePeriod = DEFAULT_DEBOUNCE_PERIOD, boolean initOutput = DEFAULT_INITIAL_OUTPUT);
-    boolean debounce(boolean input);
-    boolean input();
-    boolean debouncing();
-    boolean debounced();
-    boolean rising();
-    boolean falling();
+    void setMode(DebounceMode mode, unsigned long debouncePeriod = DEFAULT_DEBOUNCE_PERIOD, boolean initialOutputState = DEFAULT_INITIAL_OUTPUT);
+    boolean debounce(boolean inputState);
+    boolean getInputState();
+    boolean isDebouncing();
+    boolean getDebouncedOutput();
+    boolean isRisingEdge();
+    boolean isFallingEdge();
 };
 
 #endif  // ADEBOUNCER_H