v1.3.1 to add waitingForDRD() function

### Releases v1.3.1

1. Add waitingForDRD() function to signal in DRD wating period. Check [DRD is waiting for a double reset? #14](#14)
2. Add example [checkWaitingDRD](https://github.com/khoih-prog/ESP_DoubleResetDetector/tree/master/examples/checkWaitingDRD) to demo how to use the new feature.

Author: khoih-prog

CONTRIBUTING.md

@@ -29,7 +29,7 @@ Please ensure to specify the following:
 Arduino IDE version: 1.8.19
 ESP8266 Core Version 3.0.2
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-99-generic #112-Ubuntu SMP Thu Feb 3 13:50:55 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux kh-Inspiron-3593 5.4.0-100-generic #113-Ubuntu SMP Thu Feb 3 18:43:29 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered a non-response while trying to press the reset button twice.

README.md

@@ -6,7 +6,8 @@
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
 [![GitHub issues](https://img.shields.io/github/issues/khoih-prog/ESP_DoubleResetDetector.svg)](http://github.com/khoih-prog/ESP_DoubleResetDetector/issues)
 
-<a href="https://www.buymeacoffee.com/khoihprog6" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 50px !important;width: 181px !important;" ></a>
+<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
+<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
 
 ---
 ---
@@ -28,6 +29,7 @@
   * [ 2. ConfigOnDRD_ESP32_minimal](examples/ConfigOnDRD_ESP32_minimal)
   * [ 3. ConfigOnDRD_ESP8266_minimal](examples/ConfigOnDRD_ESP8266_minimal)
   * [ 4. minimal](examples/minimal)
+  * [ 5. checkWaitingDRD](examples/checkWaitingDRD) **New**
  * [Examples from other libraries](#examples-from-other-libraries)
   * [ 1. ESP_WiFiManager Library](https://github.com/khoih-prog/ESP_WiFiManager)
     * [ 1. ConfigOnDoubleReset](https://github.com/khoih-prog/ESP_WiFiManager/tree/master/examples/ConfigOnDoubleReset)
@@ -56,6 +58,7 @@
     * [ 6. Blynk_Async_ESP32_BT_WF](https://github.com/khoih-prog/Blynk_Async_ESP32_BT_WF)
     * [ 7. Blynk_Async_GSM_Manager](https://github.com/khoih-prog/Blynk_Async_GSM_Manager)
     * [ 8. Ethernet_Manager](https://github.com/khoih-prog/Ethernet_Manager)
+* [Example checkWaitingDRD](#Example-checkWaitingDRD) 
 * [Debug Terminal Output Samples](#debug-terminal-output-samples)
   * [1. ESP32_FSWebServer_DRD on ESP32_DEV](#1-esp32_fswebserver_drd-on-esp32_dev)
   * [2. ConfigOnDoubleReset on ESP32_DEV](#2-configondoublereset-on-esp32_dev)
@@ -265,19 +268,28 @@ and there are many more.
 * [ 7. Blynk_Async_GSM_Manager](https://github.com/khoih-prog/Blynk_Async_GSM_Manager)
 * [ 8. Ethernet_Manager](https://github.com/khoih-prog/Ethernet_Manager)
 
+---
+---
+
+### Example [checkWaitingDRD](examples/checkWaitingDRD)
+
+https://github.com/khoih-prog/ESP_DoubleResetDetector/blob/da76548b25f1c2d4774f154011e7221c1fd7d824/examples/checkWaitingDRD/checkWaitingDRD.ino#L14-L132
+
+
+
 ---
 ---
 
 ### Debug Terminal Output Samples
 
 #### 1. ESP32_FSWebServer_DRD on ESP32_DEV
 
-This is terminal debug output when running [ESP32_FSWebServer_DRD](https://github.com/khoih-prog/ESP_WiFiManager/tree/master/examples/ESP32_FSWebServer_DRD) on  ***ESP32 ESP32_DEV.***. Config Portal was requested by DRD to input and save Credentials. The boards then connected to WiFi AP **HueNet1** using new Static IP successfully. WiFi AP **HueNet1** is then lost, and board **autoreconnects** itself to backup WiFi AP **HueNet2**.
+This is terminal debug output when running [ESP32_FSWebServer_DRD](https://github.com/khoih-prog/ESP_WiFiManager/tree/master/examples/ESP32_FSWebServer_DRD) on  **ESP32 ESP32_DEV.**. Config Portal was requested by DRD to input and save Credentials. The boards then connected to WiFi AP **HueNet1** using new Static IP successfully. WiFi AP **HueNet1** is then lost, and board **autoreconnects** itself to backup WiFi AP **HueNet2**.
 
 ```cpp
 Starting ESP32_FSWebServer_DRD with DoubleResetDetect using SPIFFS on ESP32_DEV
-ESP_WiFiManager Version v1.9.0
-ESP_DoubleResetDetector Version v1.3.0
+ESP_WiFiManager v1.10.1
+ESP_DoubleResetDetector v1.3.1
 FS File: /ConfigSW.json, size: 150B
 FS File: /CanadaFlag_1.png, size: 40.25KB
 FS File: /CanadaFlag_2.png, size: 8.12KB
@@ -337,13 +349,13 @@ HHHHHHHHHH HHHHHHHHHH HHHHHHHHHH HHHHHHHHHH
 
 #### 2. ConfigOnDoubleReset on ESP32_DEV
 
-This is terminal debug output when running [ConfigOnDoubleReset](https://github.com/khoih-prog/ESP_WiFiManager/tree/master/examples/ConfigOnDoubleReset) on  ***ESP32 ESP32_DEV.***. Config Portal was requested by DRD to input and save Credentials.
+This is terminal debug output when running [ConfigOnDoubleReset](https://github.com/khoih-prog/ESP_WiFiManager/tree/master/examples/ConfigOnDoubleReset) on  **ESP32 ESP32_DEV.**. Config Portal was requested by DRD to input and save Credentials.
 
 
 ```
 Starting ConfigOnDoubleReset with DoubleResetDetect using LittleFS on ESP32_DEV
-ESP_WiFiManager Version v1.9.0
-ESP_DoubleResetDetector Version v1.3.0
+ESP_WiFiManager v1.10.1
+ESP_DoubleResetDetector v1.3.1
 [WM] RFC925 Hostname = ConfigOnDoubleReset
 [WM] Set CORS Header to :  Your Access-Control-Allow-Origin
 Stored: SSID = HueNet1, Pass = 12345678
@@ -386,8 +398,8 @@ load:0x40080400,len:6352
 entry 0x400806b8
 
 Starting ConfigOnDoubleReset with DoubleResetDetect using LittleFS on ESP32_DEV
-ESP_WiFiManager Version v1.9.0
-ESP_DoubleResetDetector Version v1.3.0
+ESP_WiFiManager Version v1.10.1
+ESP_DoubleResetDetector Version v1.3.1
 [WM] RFC925 Hostname = ConfigOnDoubleReset
 [WM] Set CORS Header to :  Your Access-Control-Allow-Origin
 Stored: SSID = HueNet1, Pass = jenniqqs
@@ -414,13 +426,13 @@ Starting configuration portal.
 
 #### 3. ESPAsync_WiFi using LittleFS on ESP32S3_DEV
 
-This is terminal debug output when running [ESPAsync_WiFi](https://github.com/khoih-prog/ESPAsync_WiFiManager_Lite/tree/master/examples/ESPAsync_WiFi) on  ***ESP32 ESP32S3_DEV.***. Config Portal was requested by DRD to input and save Credentials.
+This is terminal debug output when running [ESPAsync_WiFi](https://github.com/khoih-prog/ESPAsync_WiFiManager_Lite/tree/master/examples/ESPAsync_WiFi) on  **ESP32 ESP32S3_DEV.**. Config Portal was requested by DRD to input and save Credentials.
 
 
 ```
 Starting ESPAsync_WiFi using LittleFS on ESP32S3_DEV
-ESPAsync_WiFiManager_Lite v1.7.0
-ESP_DoubleResetDetector v1.3.0
+ESPAsync_WiFiManager_Lite v1.8.2
+ESP_DoubleResetDetector v1.3.1
 LittleFS Flag read = 0xD0D01234
 doubleResetDetected
 Saving config file...
@@ -536,10 +548,13 @@ Submit issues to: [ESP_DoubleResetDetector issues](https://github.com/khoih-prog
 ### Contributions and thanks
 
 1. Thanks to [zobix](https://github.com/zobix) for report the bug in [Isssue 2](https://github.com/khoih-prog/ESP_DoubleResetDetector/issues/2)
+1. Thanks to [Tochi Moreno](https://github.com/tochimoreno) for enhancement request in [DRD is waiting for a double reset? #14](https://github.com/khoih-prog/ESP_DoubleResetDetector/discussions/14) leading to v1.3.1 to add `waitingForDRD()` function to signal in DRD wating period
+
 
 <table>
   <tr>
     <td align="center"><a href="https://github.com/zobix"><img src="https://github.com/zobix.png" width="100px;" alt="zobix"/><br /><sub><b>Zobix</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/tochimoreno"><img src="https://github.com/tochimoreno.png" width="100px;" alt="tochimoreno"/><br /><sub><b>Tochi Moreno</b></sub></a><br /></td>
   </tr> 
 </table>
 

changelog.md

@@ -12,6 +12,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Releases v1.3.1](#releases-v131)
   * [Releases v1.3.0](#releases-v130)
   * [Releases v1.2.1](#releases-v121)
   * [Releases v1.2.0](#releases-v120)
@@ -27,6 +28,11 @@
 
 ## Changelog
 
+### Releases v1.3.1
+
+1. Add waitingForDRD() function to signal in DRD wating period. Check [DRD is waiting for a double reset? #14](https://github.com/khoih-prog/ESP_DoubleResetDetector/discussions/14)
+2. Add example [checkWaitingDRD](https://github.com/khoih-prog/ESP_DoubleResetDetector/tree/master/examples/checkWaitingDRD) to demo how to use the new feature.
+
 ### Releases v1.3.0
 
 1. Add support to `ESP32_S3` using [ESP32 core, esp32-s3-support branch, v2.0.2+](https://github.com/espressif/arduino-esp32/tree/esp32-s3-support)

keywords.txt

@@ -11,6 +11,7 @@ DoubleResetDetector
 # Methods and Functions (KEYWORD2)
 #######################################
 detectDoubleReset		KEYWORD2
+waitingForDRD KEYWORD2
 loop	KEYWORD2
 stop	KEYWORD2
 

library.json

@@ -1,6 +1,6 @@
 {
   "name": "ESP_DoubleResetDetector",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "keywords": "rtc, eeprom, littlefs, spiffs, reset, data, esp32, esp32-c3, esp32-s2, esp32-s3, esp8266, double-reset, detector, double-reset-detector",
   "description": "Library to detect a double reset within a predetermined time, using RTC Memory, EEPROM, LittleFS or SPIFFS for ESP8266 and ESP32. An alternative start-up mode can be used. One example use is to allow re-configuration of device WiFi credentials. Now supporting ESP32_C3, ESP32_S2 ans ESP32_S3",
   "authors":

library.properties

@@ -1,5 +1,5 @@
 name=ESP_DoubleResetDetector
-version=1.3.0
+version=1.3.1
 author=Khoi Hoang
 maintainer=Khoi Hoang <[email protected]>
 license=MIT

src/ESP_DoubleResetDetector.h

@@ -9,7 +9,7 @@
 
   Built by Khoi Hoang https://github.com/khoih-prog/ESP_DoubleResetDetector
   Licensed under MIT license
-  Version: 1.3.0
+  Version: 1.3.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -22,28 +22,33 @@
   1.1.2   K Hoang      10/10/2021 Update `platform.ini` and `library.json`
   1.2.0   K Hoang      26/11/2021 Auto detect ESP32 core and use either built-in LittleFS or LITTLEFS library
   1.2.1   K Hoang      26/11/2021 Fix compile error for ESP32 core v1.0.5-
-  1.3.0   K Hoang      10/02/2022 Add support to new ESP32-S3 
+  1.3.0   K Hoang      10/02/2022 Add support to new ESP32-S3
+  1.3.1   K Hoang      04/03/2022 Add waitingForDRD() function to signal in DRD wating period
 *****************************************************************************************************************************/
 
 #pragma once
 
 #ifndef ESP_DoubleResetDetector_H
 #define ESP_DoubleResetDetector_H
 
+#ifndef DOUBLERESETDETECTOR_DEBUG
+  #define DOUBLERESETDETECTOR_DEBUG       false
+#endif
+
 #if defined(ARDUINO) && (ARDUINO >= 100)
   #include <Arduino.h>
 #else
   #include <WProgram.h>
 #endif
 
 #ifndef ESP_DOUBLE_RESET_DETECTOR_VERSION
-  #define ESP_DOUBLE_RESET_DETECTOR_VERSION             "ESP_DoubleResetDetector v1.3.0"
+  #define ESP_DOUBLE_RESET_DETECTOR_VERSION             "ESP_DoubleResetDetector v1.3.1"
 
   #define ESP_DOUBLE_RESET_DETECTOR_VERSION_MAJOR       1
   #define ESP_DOUBLE_RESET_DETECTOR_VERSION_MINOR       3
-  #define ESP_DOUBLE_RESET_DETECTOR_VERSION_PATCH       0
+  #define ESP_DOUBLE_RESET_DETECTOR_VERSION_PATCH       1
 
-  #define ESP_DOUBLE_RESET_DETECTOR_VERSION_INT         1003000
+  #define ESP_DOUBLE_RESET_DETECTOR_VERSION_INT         1003001
 #endif
 
 #define ESP_DOUBLERESETDETECTOR_VERSION         ESP_DOUBLE_RESET_DETECTOR_VERSION
@@ -55,7 +60,11 @@
 
 #ifdef ESP32
   #if (!ESP_DRD_USE_EEPROM && !ESP_DRD_USE_SPIFFS && !ESP_DRD_USE_LITTLEFS)
-    #warning Neither EEPROM, SPIFFS nor LittleFS selected. Default to EEPROM
+  
+    #if (DOUBLERESETDETECTOR_DEBUG)
+      #warning Neither EEPROM, SPIFFS nor LittleFS selected. Default to EEPROM
+    #endif
+      
     #ifdef ESP_DRD_USE_EEPROM
       #undef ESP_DRD_USE_EEPROM
       #define ESP_DRD_USE_EEPROM      true
@@ -65,7 +74,10 @@
 
 #ifdef ESP8266
   #if (!ESP8266_DRD_USE_RTC && !ESP_DRD_USE_EEPROM && !ESP_DRD_USE_SPIFFS && !ESP_DRD_USE_LITTLEFS)
-    #warning Neither RTC, EEPROM, LITTLEFS nor SPIFFS selected. Default to EEPROM
+    #if (DOUBLERESETDETECTOR_DEBUG)
+      #warning Neither RTC, EEPROM, LITTLEFS nor SPIFFS selected. Default to EEPROM
+    #endif   
+    
     #ifdef ESP_DRD_USE_EEPROM
       #undef ESP_DRD_USE_EEPROM
       #define ESP_DRD_USE_EEPROM      true
@@ -97,14 +109,20 @@
     // Check cores/esp32/esp_arduino_version.h and cores/esp32/core_version.h
     //#if ( ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(2, 0, 0) )  //(ESP_ARDUINO_VERSION_MAJOR >= 2)
     #if ( defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR >= 2) )
-      #warning Using ESP32 Core 1.0.6 or 2.0.0+
+      #if (DOUBLERESETDETECTOR_DEBUG)
+        #warning Using ESP32 Core 1.0.6 or 2.0.0+
+      #endif 
+      
       // The library has been merged into esp32 core from release 1.0.6
       #include <LittleFS.h>
 
       #define FileFS        LittleFS
       #define FS_Name       "LittleFS"
     #else
-      #warning Using ESP32 Core 1.0.5-. You must install LITTLEFS library
+      #if (DOUBLERESETDETECTOR_DEBUG)
+        #warning Using ESP32 Core 1.0.5-. You must install LITTLEFS library
+      #endif 
+      
       // The library has been merged into esp32 core from release 1.0.6
       #include <LITTLEFS.h>             // https://github.com/lorol/LITTLEFS
 
@@ -135,9 +153,7 @@
 
 #endif    //#if ESP_DRD_USE_EEPROM
 
-#ifndef DOUBLERESETDETECTOR_DEBUG
-#define DOUBLERESETDETECTOR_DEBUG       false
-#endif
+
 
 #define DOUBLERESETDETECTOR_FLAG_SET    0xD0D01234
 #define DOUBLERESETDETECTOR_FLAG_CLEAR  0xD0D04321
@@ -204,6 +220,11 @@ class DoubleResetDetector
       return doubleResetDetected;
 
     };
+    
+    bool waitingForDRD()
+    {
+      return waitingForDoubleReset;
+    }
 
     void loop()
     {