New status added

Author: DoImant

README.md

@@ -9,7 +9,7 @@ be pressed for at least 0.5 seconds).
 
 ButtonSL is extended so that a distinction can be made between a short and long button press.
 A time (in ms) can be specified after which a button press is considered "long".
-Correspondingly, the tick() method returns the status notPressed, shortPressed or longPressed.
+Correspondingly, the tick() method returns the status notPressed, shortPressed or longPressed/pressed.
 
 ## Examples
 
@@ -103,6 +103,15 @@ You can test this library with the online simulator wokwi:: [Button Example](htt
 * Debounce time: 30ms (max. 65535 ms).
 * For ButtonSL releaseOff()
 
+## Notes
+
+Version 1.1.6:
+The ButtonState::pressed status has been added.
+For a long button press with automatic release enabled, the ButtonState::longPressed status is returned once
+when the defined time for a long button press is reached and then the ButtonState::pressed status is returned
+as long as the button is held down.  Previously (version 1.1.6), ButtonState::nopressed was returned even
+if the button had not yet been released.
+
 ## Methods
 
 The methods of the objects are named so that their function should be self-explanatory:

examples/Button_SL-example/Button_SL-example.ino

@@ -1,22 +1,38 @@
 #include <Button_SL.hpp>
+#include "Button_SL.hpp"
+
+//////////////////////////////////////////////////////////////////////////////
+/// @brief Auxiliary class for time-controlled functions.
+///
+//////////////////////////////////////////////////////////////////////////////
+class Timer {
+public:
+  void start() { timeStamp = millis(); }
+  bool operator()(const unsigned long duration) const { return millis() - timeStamp >= duration; }
+
+private:
+  unsigned long timeStamp {0};
+};
 
 //////////////////////////////////////////////////
 // Global constants and variables
 //////////////////////////////////////////////////
-constexpr uint8_t BUTTON_PIN1{2};
-constexpr uint8_t BUTTON_PIN2{3};
-constexpr uint8_t BUTTON_PIN3{4};
+constexpr uint8_t btn_pin1 {2};
+constexpr uint8_t btn_pin2 {3};
+constexpr uint8_t btn_pin3 {4};
+constexpr uint8_t led_short {6};
+constexpr uint8_t led_long {7};
+constexpr unsigned long duration {500};
+constexpr unsigned long blink_duration {200};
 
 using namespace Btn;
 
-Button btn{BUTTON_PIN1};
+Button btn{btn_pin1};
 ButtonSL bArray[]{
-    {BUTTON_PIN2},
-    {BUTTON_PIN3, 1500, HIGH}
+    {btn_pin2}, 
+    {btn_pin3, 1500, HIGH}
 };
-//////////////////////////////////////////////////
-// Function forward declaration
-//////////////////////////////////////////////////
+Timer wait;
 
 //////////////////////////////////////////////////////////////////////////////
 /// @brief Initialize the program.
@@ -25,14 +41,16 @@ ButtonSL bArray[]{
 void setup() {
   Serial.begin(115200);
   Serial.println("Start");
+  pinMode(led_short, OUTPUT);
+  pinMode(led_long, OUTPUT);
+
   // Initialize Buttons
   for (auto &buttons : bArray) {
     buttons.begin();
   }
   btn.begin();
   btn.setDebounceTime_ms(20);
   bArray[1].releaseOn();
-
 }
 
 //////////////////////////////////////////////////////////////////////////////
@@ -45,12 +63,12 @@ void loop() {
 
   switch (bArray[0].tick()) {
     case ButtonState::shortPressed:
-      Serial.print("B1 . ");
+      Serial.print("B1 (short) ");
       Serial.print(bArray[0].getDuration_ms());
       Serial.println(" ms");
       break;
     case ButtonState::longPressed:
-      Serial.print("B1 + ");
+      Serial.print("B1 (long) ");
       Serial.print(bArray[0].getDuration_ms());
       Serial.println(" ms");
       break;
@@ -59,16 +77,27 @@ void loop() {
 
   switch (bArray[1].tick()) {
     case ButtonState::shortPressed:
-      Serial.print("B2 . ");
+      wait.start();
+      digitalWrite(led_short, HIGH);
+      Serial.print("B2 (short) ");
       Serial.print(bArray[1].getDuration_ms());
       Serial.println(" ms");
       break;
-    case ButtonState::longPressed:
-      Serial.print("B2 + ");
+    case ButtonState::longPressed: 
+      Serial.print("B2 (long) ");
       Serial.print(bArray[1].getDuration_ms());
       Serial.println(" ms");
       Serial.println("Auto released");
       break;
-    default: break;
+    case ButtonState::pressed:
+      if (wait(blink_duration)) {
+        digitalWrite(led_long, !digitalRead(led_long));
+        wait.start();
+      }
+      break;
+    default:
+      if (digitalRead(led_short) && wait(duration)) { digitalWrite(led_short, LOW); }
+      if (digitalRead(led_long)) { digitalWrite(led_long, LOW); }
+      break;
   }
 }

library.json

@@ -1,6 +1,6 @@
 {
   "name": "Button_SL",
-  "version": "1.1.5",
+  "version": "1.1.6",
 	"keywords": "button, debounce, signal, input, ouput",
   "description": "Button_SL enables the query of buttons. The query is debounced. A query can be made as to whether the button was pressed for a short or long time.",
   "repository": {

library.properties

@@ -1,5 +1,5 @@
 name=Button_SL
-version=1.1.5
+version=1.1.6
 author=Kai R.
 maintainer=Kai R. 
 sentence=Button query

src/Button_SL.cpp

@@ -107,7 +107,7 @@ ButtonState ButtonSL::tick() {
       return ButtonState::longPressed;
     }
   }
-  return ButtonState::notPressed;
+  return hasReleased ? ButtonState::pressed : ButtonState::notPressed;
 }
 
 //////////////////////////////////////////////////////////////////////////////

src/Button_SL.hpp

@@ -30,7 +30,7 @@ constexpr uint8_t DEBOUNCE_TIME{30};   // The value can be reduced for buttons t
 //////////////////////////////////////////////////
 // Variables and Classdefinitions
 //////////////////////////////////////////////////
-enum class ButtonState : uint8_t { notPressed, shortPressed, longPressed };
+enum class ButtonState : uint8_t { notPressed = false, pressed = true, shortPressed = 2, longPressed };
 
 //////////////////////////////////////////////////////////////////////////////
 /// @brief Button object