version 3.4.0 - ButtonStateIsActive is now private

ArminJo · Dec 17, 2023 · 2d6448c · 2d6448c
1 parent 2bf373f
commit 2d6448c
Show file tree

Hide file tree

Showing 9 changed files with 157 additions and 74 deletions.
diff --git a/.github/workflows/LibraryBuild.yml b/.github/workflows/LibraryBuild.yml
@@ -41,8 +41,9 @@ jobs:
           - arduino:avr:uno
           - arduino:avr:leonardo
           - arduino:avr:mega
-          - ATTinyCore:avr:attinyx5:chip=85,clock=1internal
-          - ATTinyCore:avr:attinyx7micr:sketchclock=1external16
+          - digistump:avr:digispark-pro
+#          - ATTinyCore:avr:attinyx5:chip=85,clock=1internal
+#          - ATTinyCore:avr:attinyx7micr:sketchclock=1external16
 
         # Choose the right platform for the boards we want to test. (maybe in the future Arduino will automatically do this for you)
         # With sketches-exclude you may exclude specific examples for a board. Use a comma separated list.
@@ -51,15 +52,15 @@ jobs:
           - arduino-boards-fqbn: digistump:avr:digispark-pro
             platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
 
-          - arduino-boards-fqbn: ATTinyCore:avr:attinyx5:chip=85,clock=1internal # ATtiny85 board @1 MHz / Digispark
-            platform-url: http://drazzy.com/package_drazzy.com_index.json
-            build-properties:
-              TwoButtons: -DTX_PIN=PB0
+#          - arduino-boards-fqbn: ATTinyCore:avr:attinyx5:chip=85,clock=1internal # ATtiny85 board @1 MHz / Digispark
+#            platform-url: http://drazzy.com/package_drazzy.com_index.json
+#            build-properties:
+#              TwoButtons: -DTX_PIN=PB0
 
-          - arduino-boards-fqbn: ATTinyCore:avr:attinyx7micr:sketchclock=1external16 # Digispark pro
-            platform-url: http://drazzy.com/package_drazzy.com_index.json
-            build-properties:
-              TwoButtons: -DTX_PIN=PB0
+#          - arduino-boards-fqbn: ATTinyCore:avr:attinyx7micr:sketchclock=1external16 # Digispark pro
+#            platform-url: http://drazzy.com/package_drazzy.com_index.json
+#            build-properties:
+#              TwoButtons: -DTX_PIN=PB0
 
 
       # Do not cancel all jobs / architectures if one job fails
@@ -76,3 +77,4 @@ jobs:
           platform-url: ${{ matrix.platform-url }}
 #          sketches-exclude: ${{ matrix.sketches-exclude }}
           build-properties: ${{ toJson(matrix.build-properties) }}
+          cli-version: 0.33.0 # to avoid errors for ATTinyCore
diff --git a/README.md b/README.md
@@ -1,15 +1,34 @@
+<div align = center>
+
 # [EasyButton](https://github.com/ArminJo/EasyButtonAtInt01)
-Lightweight Arduino library for handling push buttons just connected between ground and INT0 and / or INT1 pin.
+Lightweight Arduino library for handling push buttons just connected between ground and INT0 and / or INT1 or any other PCINT pin.
+
+[![Badge License: GPLv3](https://img.shields.io/badge/License-GPLv3-brightgreen.svg)](https://www.gnu.org/licenses/gpl-3.0)
+ &nbsp; &nbsp; 
+[![Badge Version](https://img.shields.io/github/v/release/ArminJo/EasyButtonAtInt01?include_prereleases&color=yellow&logo=DocuSign&logoColor=white)](https://github.com/ArminJo/EasyButtonAtInt01/releases/latest)
+ &nbsp; &nbsp; 
+[![Badge Commits since latest](https://img.shields.io/github/commits-since/ArminJo/EasyButtonAtInt01/latest?color=yellow)](https://github.com/ArminJo/EasyButtonAtInt01/commits/master)
+ &nbsp; &nbsp; 
+[![Badge Build Status](https://github.com/ArminJo/EasyButtonAtInt01/workflows/LibraryBuild/badge.svg)](https://github.com/ArminJo/EasyButtonAtInt01/actions)
+ &nbsp; &nbsp; 
+![Badge Hit Counter](https://visitor-badge.laobi.icu/badge?page_id=ArminJo_EasyButtonAtInt01)
+<br/>
+<br/>
+[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)
+
+Available as [Arduino library "EasyButtonAtInt01"](https://www.arduinolibraries.info/libraries/easy-button-at-int01).
 
-### [Version 3.3.2](https://github.com/ArminJo/EasyButtonAtInt01/releases) - work in progress
+[![Button Install](https://img.shields.io/badge/Install-brightgreen?logoColor=white&logo=GitBook)](https://www.ardu-badge.com/EasyButtonAtInt01)
+ &nbsp; &nbsp; 
+[![Button Changelog](https://img.shields.io/badge/Changelog-blue?logoColor=white&logo=AzureArtifacts)](https://github.com/ArminJo/EasyButtonAtInt01#revision-history)
 
-[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
-[![Installation instructions](https://www.ardu-badge.com/badge/EasyButtonAtInt01.svg?)](https://www.ardu-badge.com/EasyButtonAtInt01)
-[![Commits since latest](https://img.shields.io/github/commits-since/ArminJo/EasyButtonAtInt01/latest)](https://github.com/ArminJo/EasyButtonAtInt01/commits/master)
-[![Build Status](https://github.com/ArminJo/EasyButtonAtInt01/workflows/LibraryBuild/badge.svg)](https://github.com/ArminJo/EasyButtonAtInt01/actions)
-![Hit Counter](https://visitor-badge.laobi.icu/badge?page_id=ArminJo_EasyButtonAtInt01)
+</div>
 
-Available as [Arduino library "EasyButtonAtInt01"](https://www.arduinolibraries.info/libraries/easy-button-at-int01).
+#### If you find this library useful, please give it a star.
+
+&#x1F30E; [Google Translate](https://translate.google.com/translate?sl=en&u=https://github.com/ArminJo/EasyButtonAtInt01)
+
+<br/>
 
 # Features
 - No external pullup, **no polling needed**.
@@ -97,7 +116,7 @@ void loop() {}
 ```
 
 ## Long press detection
-The easiest way is to check it in the button release handler. Do not forget, that you will get a press callback (if enabled) at the start of the long press.
+The easiest way is to use the button release handler. Keep in mind, that you will get a press callback at the start of the long press.
 
 ```c++
 #define USE_BUTTON_0 // Enable code for button at INT0 (pin2)
@@ -116,13 +135,33 @@ handleButtonRelease(bool aButtonToggleState, uint16_t aButtonPressDurationMillis
 
 void setup() {}
 void loop() {}
+```
+
+Or check in loop, this enables to react with feedback as soon as long press duration is reached.
+
+```c++
+#define USE_BUTTON_0 // Enable code for button at INT0 (pin2)
+#include "EasyButtonAtInt01.hpp"
+
+bool sLongPressMessageSent = false;
+void handleButtonPress(bool aButtonToggleState, uint16_t aButtonPressDurationMillis) {sLongPressMessageSent = false};
+EasyButton Button0AtPin2(&handleButtonPress); // Button is connected to INT0 (pin2)
+
+void setup() {}
+void loop() {
+if (!sLongPressMessageSent && Button0AtPin2.checkForLongPress(1000) == EASY_BUTTON_LONG_PRESS_DETECTED) {
+        Serial.println(F("Long press of 1000 ms just detected"));
+        sLongPressMessageSent = true; // Print message only once per long press
 }
+
 ```
 
+
+    if (sLCDDisplayPage == POWER_METER_PAGE_INFO && PageButtonAtPin3.checkForLongPress(1000) == EASY_BUTTON_LONG_PRESS_DETECTED) {
+
+
 ## Double press detection
-Call checkForDoublePress() only from button press callback function. It will not work as expected called outside this callback function.
-Be aware, that the first press after booting may be detected as double press!
-This is because the "last time of press" `ButtonReleaseMillis` is initialized with 0 milliseconds, which is interpreted as the first press happened at the beginning of boot.
+**Call checkForDoublePress() only from button press callback function**. It will not work as expected, if called outside this callback function.
 
 ```c++
 #define USE_BUTTON_0 // Enable code for button at INT0 (pin2)
@@ -144,10 +183,13 @@ void setup() {}
 void loop() {}
 ```
 
-## Handling the `multiple definition` error
+<br/>
+
+# Handling the `multiple definition` error
 If you get the error `multiple definition of __vector_1` (or `__vector_2`) because another library uses the attachInterrupt() function,
-then activate the line `#define USE_ATTACH_INTERRUPT` in *EasyButtonAtInt01.h* or
-define global symbol with `-DUSE_ATTACH_INTERRUPT` which is not yet possible in Arduino IDE :disappointed:.<br/>
+then insert the line `#define USE_ATTACH_INTERRUPT` in your program **before** the line `#include "EasyButtonAtInt01.hpp"`.
+
+<br/>
 
 
 # Compile options / macros for this library
@@ -156,12 +198,12 @@ These macros must be defined in your program **before** the line `#include "Easy
 Modify them by enabling / disabling them, or change the values if applicable.
 
 | Name | Default value | Description |
-|-|-|-|
+|-|-:|-|
 | `USE_BUTTON_0` | disabled | Enables code for button at INT0 (pin2 on 328P, PB6 on ATtiny167, PB2 on ATtinyX5). The macro INT0_PIN is set after the include. |
 | `USE_BUTTON_1` | disabled | Enables code for button at INT1 (pin3 on 328P, PA3 on ATtiny167, PCINT0 / PCx for ATtinyX5). The macro INT1_PIN is set after the include. |
 | `INT1_PIN` | % | It overrides the usage of pin at the processors INT1 pin. Thus, it is the pin number of the pin for button 1 to use with Pin Change Interrupts. |
 | `NO_INITIALIZE_IN_CONSTRUCTOR` | disabled | Disables the auto initializing in all constructors without the "aIsButtonAtINT0" parameter. Must be used if buttons must be initialized manually (e.g. later in setup). |
-| `BUTTON_IS_ACTIVE_HIGH` | disabled | Enable this if you buttons are active high. |
+| `BUTTON_IS_ACTIVE_HIGH` | disabled | Enable this if your buttons are active high. |
 | `USE_ATTACH_INTERRUPT` | disabled | This forces use of the arduino function attachInterrupt(). It is required if you get the error "multiple definition of \`__vector_1'" (or \`__vector_2'), because another library uses the attachInterrupt() function. |
 | `NO_BUTTON_RELEASE_CALLBACK` | disabled | Disables the code for release callback. This saves 2 bytes RAM and 64 bytes program memory. |
 | `BUTTON_DEBOUNCING_MILLIS` | 50 | With this you can adapt to the characteristic of your button. |
@@ -172,20 +214,6 @@ Modify them by enabling / disabling them, or change the values if applicable.
 
 The exact pin numbers of the buttons used internally are available by the macros INT0_PIN and INT1_PIN, which are set after the include.
 
-### Changing include (*.h) files with Arduino IDE
-First, use *Sketch > Show Sketch Folder (Ctrl+K)*.<br/>
-If you have not yet saved the example as your own sketch, then you are instantly in the right library folder.<br/>
-Otherwise you have to navigate to the parallel `libraries` folder and select the library you want to access.<br/>
-In both cases the library source and include files are located in the libraries `src` directory.<br/>
-The modification must be renewed for each new library version!
-
-### Modifying compile options / macros with PlatformIO
-If you are using PlatformIO, you can define the macros in the *[platformio.ini](https://docs.platformio.org/en/latest/projectconf/section_env_build.html)* file with `build_flags = -D MACRO_NAME` or `build_flags = -D MACRO_NAME=macroValue`.
-
-### Modifying compile options / macros with Sloeber IDE
-If you are using [Sloeber](https://eclipse.baeyens.it) as your IDE, you can easily define global symbols with *Properties > Arduino > CompileOptions*.<br/>
-![Sloeber settings](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/pictures/SloeberDefineSymbols.png)
-
 ## Class methods
 ```c++
 EasyButton(); // Constructor for button at INT0
@@ -200,6 +228,7 @@ void init(); // used by constructors
 #define EASY_BUTTON_DOUBLE_PRESS_DEFAULT_MILLIS 400
 
 bool readButtonState();
+bool readDebouncedButtonState();
 bool updateButtonState();
 uint16_t updateButtonPressDuration();
 uint8_t checkForLongPress(uint16_t aLongPressThresholdMillis = EASY_BUTTON_LONG_PRESS_DEFAULT_MILLIS);
@@ -209,7 +238,12 @@ bool checkForForButtonNotPressedTime(uint16_t aTimeoutMillis);
 ```
 
 # Revision History
-###  Version 3.3.2 - work in progress
+###  Version 3.4.1 - work in progress
+- Avoid wrong double press detection if calling checkForDoublePress() after release of button.
+
+###  Version 3.4.0
+- Added `NO_INITIALIZE_IN_CONSTRUCTOR` macro to enable late initializing.
+- `ButtonStateIsActive` is now private, since it is not reliable after bouncing. Use `readButtonState()` or `readDebouncedButtonState()` instead.
 
 ###  Version 3.3.1
 - Avoid mistakenly double press detection after boot.
@@ -255,8 +289,3 @@ The library examples are tested with GitHub Actions for the following boards:
 - digistump:avr:digispark-tiny1
 - digistump:avr:digispark-pro
 - ATTinyCore:avr:attinyx5:chip=85,clock=1internal
-
-## Requests for modifications / extensions
-Please write me a PM including your motivation/problem if you need a modification or an extension e.g. PCINT* support for ATtiny85.
-
-#### If you find this library useful, please give it a star.
diff --git a/examples/DebounceTest/DebounceTest.ino b/examples/DebounceTest/DebounceTest.ino
@@ -74,7 +74,7 @@ void loop() {
          * Print new status
          */
         Serial.print(F("Button1 IsActive="));
-        Serial.print(Button0AtPin2.ButtonStateIsActive);
+        Serial.print(Button0AtPin2.getButtonStateIsActive());
         Serial.print(F(" ToggleState="));
         Serial.println(Button0AtPin2.ButtonToggleState);
     }

diff --git a/examples/TwoButtons/ATtinySerialOut.h b/examples/TwoButtons/ATtinySerialOut.h
@@ -95,8 +95,11 @@
 
 #if !defined(TX_PIN)
 #  if defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark PRO board
-#    if defined PA1
-#define TX_PIN  PA1 // (package pin 2 / TXD on Tiny167) - can use one of PA0 to PA7here
+#    if defined PIN_PA1
+// ATTinyCore
+#define TX_PIN  PIN_PA1 // (package pin 2 / TXD on Tiny167) - can use one of PA0 to PA7 here
+#    elif defined PA1   //
+#define TX_PIN  PA1     // (package pin 2 / TXD on Tiny167) - can use one of PA0 to PA7 here
 #    endif
 
 #  elif defined(__AVR_ATtiny88__) //  MH-ET LIVE Tiny88(16.0MHz) board
@@ -109,6 +112,7 @@
 #    if defined(DIGISTUMPCORE)
 #define TX_PIN PB2 // (package pin 7 on Tiny85) - can use one of PB0 to PB4 (+PB5) here
 #    else
+// ATTinyCore
 #define TX_PIN PIN_PB2 // (package pin 7 on Tiny85) - can use one of PB0 to PB4 (+PB5) here
 #    endif
 #  endif

diff --git a/examples/TwoButtons/TwoButtons.ino b/examples/TwoButtons/TwoButtons.ino
@@ -61,10 +61,11 @@
 
 #include "EasyButtonAtInt01.hpp"
 
-// The callback function for button 0
-void handleButtonPress(bool aButtonToggleState);
+void handleButtonPress(bool aButtonToggleState);    // The callback function for button 0
 EasyButton Button0AtPin2(&handleButtonPress);       // Only callback parameter -> button is connected to INT0
 EasyButton Button1AtPin3(BUTTON_AT_INT1_OR_PCINT);  // Button is connected to INT1 or INT1_PIN if INT1_PIN is defined.
+#define LONG_PRESS_BUTTON_DURATION_MILLIS   1000
+bool sLongPressMessageSent = false;
 
 long sOldDeltaMillis;
 
@@ -86,6 +87,17 @@ void setup() {
 
 void loop() {
 
+    /*
+     * Check for long press of button 0
+     */
+    if (!sLongPressMessageSent
+            && Button0AtPin2.checkForLongPress(LONG_PRESS_BUTTON_DURATION_MILLIS) == EASY_BUTTON_LONG_PRESS_DETECTED) {
+        Serial.print(F("Long press of "));
+        Serial.print(LONG_PRESS_BUTTON_DURATION_MILLIS);
+        Serial.println(F(" ms just detected"));
+        sLongPressMessageSent = true; // Print message only once per long press
+    }
+
     /*
      * Button 1 - check manually here as demonstration, but it would be easier to just use a callback function like we do for button 0
      */
@@ -99,7 +111,7 @@ void loop() {
          * Print new status
          */
         Serial.print(F("Button 1 IsActive="));
-        Serial.print(Button1AtPin3.ButtonStateIsActive);
+        Serial.print(Button1AtPin3.getButtonStateIsActive());
         Serial.print(F(" ToggleState="));
         Serial.print(Button1AtPin3.ButtonToggleState);
         if (!Button1AtPin3.readDebouncedButtonState()) {
@@ -112,6 +124,8 @@ void loop() {
 }
 
 void handleButtonPress(bool aButtonToggleState) {
+    sLongPressMessageSent = false; // reset flag
+
     /*
      * checkForDoublePress() works reliable only, if called early in press callback function
      */

diff --git a/library.json b/library.json
@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/ArminJo/EasyButtonAtInt01"
   },
-  "version": "3.3.1",
+  "version": "3.4.0",
   "exclude": "pictures",
   "authors": {
     "name": "Armin Joachimsmeyer",

diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
 name=EasyButtonAtInt01
-version=3.3.1
+version=3.4.0
 author=Armin Joachimsmeyer
 maintainer=Armin Joachimsmeyer <[email protected]>
-sentence=Small and easy to use Arduino library for using push buttons at INT0/pin2 and / or any PinChangeInterrupt pin.<br/>Functions for long and double press detection are included.<br/><br/>Just connect buttons between ground and any pin of your Arduino - that's it<br/><br/><b>No call</b> of begin() or polling function like update() required. No blocking debouncing delay.<br/>
-paragraph=<br/>Define an EasyButtonIn in you main program and use <i>ButtonStateIsActive</i> or <i>ButtonToggleState</i> to determine your action.<br/>Or use a <b>callback function</b> which will be called once on every button press or release.<br/><br/>Usage:<pre>#define USE_BUTTON_0<br/>#include "EasyButtonAtInt01.hpp"<br/>EasyButton Button0AtPin2;<br/><br/>void setup() {}<br/>void loop() {<br/>...<br/>    digitalWrite(LED_BUILTIN, Button0AtPin2.ButtonToggleState);<br/>...<br/>}</pre><br/><br/><b>New: </b>Avoid mistakenly double press detection after boot.</b><br/>
+sentence=Small and easy to use Arduino library for using push buttons at any PinChangeInterrupt pin. Automatic debouncing, no delay required. Functions for long and double press detection are included.
+paragraph=Define an EasyButton in you main program and use a callback function which will be called once on every button press or release.
 category=Signal Input/Output
 url=https://github.com/ArminJo/EasyButtonAtInt01
 architectures=avr

diff --git a/src/EasyButtonAtInt01.h b/src/EasyButtonAtInt01.h
@@ -26,7 +26,7 @@
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- *  See the See the See the GNU General Public License for more details.
+ *  See the GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.
@@ -35,10 +35,10 @@
 #ifndef _EASY_BUTTON_AT_INT01_H
 #define _EASY_BUTTON_AT_INT01_H
 
-#define VERSION_EASY_BUTTON "3.3.2"
+#define VERSION_EASY_BUTTON "3.4.0"
 #define VERSION_EASY_BUTTON_MAJOR 3
-#define VERSION_EASY_BUTTON_MINOR 3
-#define VERSION_EASY_BUTTON_PATCH 2
+#define VERSION_EASY_BUTTON_MINOR 4
+#define VERSION_EASY_BUTTON_PATCH 0
 // The change log is at the bottom of the file
 
 /*
@@ -291,6 +291,7 @@ class EasyButton {
     bool checkForDoublePress(uint16_t aDoublePressDelayMillis = EASY_BUTTON_DOUBLE_PRESS_DEFAULT_MILLIS);
 
     bool readButtonState();
+    bool getButtonStateIsActive(); // get private member
     bool readDebouncedButtonState();
     bool updateButtonState();
     uint16_t updateButtonPressDuration(); // Updates the ButtonPressDurationMillis by polling, since this cannot be done by interrupt.
@@ -304,7 +305,6 @@ class EasyButton {
     void handleINT01Interrupts(); // internal use only
 
     bool LastBounceWasChangeToInactive; // Internal state, reflects actual reading with spikes and bouncing. Negative logic: true / active means button pin is LOW
-    volatile bool ButtonStateIsActive; // State at last change. Negative logic: true / active means button pin is LOW. If last press duration < BUTTON_DEBOUNCING_MILLIS it holds wrong value (true instead of false) :-(
     volatile bool ButtonToggleState;    // Toggle is on press, not on release - initial value is false
 
     /*
@@ -351,6 +351,13 @@ class EasyButton {
 #if defined(USE_BUTTON_1)
     static EasyButton *sPointerToButton1ForISR;
 #endif
+
+private:
+    /*
+     * If last press duration < BUTTON_DEBOUNCING_MILLIS it holds wrong value (true instead of false), therefore it is private.
+     * To get current state, use readButtonState().
+     */
+    volatile bool ButtonStateIsActive; // State at last change. Negative logic: true / active means button pin is LOW.
 };
 // end of class definition
 
@@ -370,9 +377,12 @@ void __attribute__ ((weak)) handleINT1Interrupt();
 
 #endif // defined(__AVR__)
 
-/*
- *  Version 3.3.2 - 9/2022
+/*  Version 3.4.1 - 12/2023
+ *  - Avoid wrong double press detection if calling checkForDoublePress() after release of button.
+ *
+ *  Version 3.4.0 - 10/2023
  *  - Added NO_INITIALIZE_IN_CONSTRUCTOR macro to enable late initializing.
+ *  - ButtonStateIsActive is now private, since it is not reliable after bouncing. Use readButtonState() or readDebouncedButtonState() instead.
  *
  *  Version 3.3.1 - 2/2022
  *  - Avoid mistakenly double press detection after boot.