v1.7.3 to Auto detect ESP32 core

khoih-prog · web-flow · commit 08cb978b5ed4 · 2021-12-01T13:48:15.000-05:00
### Releases v1.7.3

1. Auto detect ESP32 core for LittleFS for WT32_ETH01
2. Fix bug in examples.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
 Please ensure to specify the following:
 
 * Arduino IDE version (e.g. 1.8.16) or Platform.io version
-* Board Core Version (e.g. Arduino SAMDUE core v1.6.12, ESP8266 core v3.0.2, ArduinoCore-mbed v2.5.2, etc.)
+* Board Core Version (e.g. Arduino SAMDUE core v1.6.12, ESP8266 core v3.0.2, ArduinoCore-mbed v2.6.1, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
@@ -28,9 +28,9 @@ Please ensure to specify the following:
 ```
 Arduino IDE version: 1.8.16
 RASPBERRY_PI_PICO board
-ArduinoCore-mbed v2.5.2
+ArduinoCore-mbed v2.6.1
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-86-generic #97-Ubuntu SMP Fri Sep 17 19:19:40 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.4.0-91-generic #102-Ubuntu SMP Fri Nov 5 16:31:28 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered an endless loop while trying to connect to Local WiFi.
diff --git a/README.md b/README.md
diff --git a/changelog.md b/changelog.md
@@ -12,6 +12,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Releases v1.7.3](#releases-v173)
   * [Releases v1.7.2](#releases-v172)
   * [Releases v1.7.1](#releases-v171)
   * [Releases v1.7.0](#releases-v170)
@@ -28,6 +29,11 @@
 
 ## Changelog
 
+### Releases v1.7.3
+
+1. Auto detect ESP32 core for LittleFS for WT32_ETH01
+2. Fix bug in examples.
+
 ### Releases v1.7.2
 
 1. Fix crashing issue for new cleared flash. Check [RP2040_RTC_Time crashes Pico, does not work #3](https://github.com/khoih-prog/RP2040_RTC/issues/3)
diff --git a/examples/Ethernet/TZ_NTP_Clock_Ethernet/TZ_NTP_Clock_Ethernet.ino b/examples/Ethernet/TZ_NTP_Clock_Ethernet/TZ_NTP_Clock_Ethernet.ino
@@ -449,6 +449,8 @@ void setup()
   
 #endif
 
+  myTZ->writeRules();
+
   Udp.begin(localPort);
 }
 
diff --git a/examples/Ethernet/TZ_NTP_Clock_Ethernet/defines.h b/examples/Ethernet/TZ_NTP_Clock_Ethernet/defines.h
@@ -20,6 +20,7 @@
 
 // Debug Level from 0 to 4
 #define _ETHERNET_WEBSERVER_LOGLEVEL_       3
+#define _NTP_LOGLEVEL_                      0
 #define _TZ_LOGLEVEL_                       1
 
 #if    ( defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_SAMD_MKR1000) || defined(ARDUINO_SAMD_MKRWIFI1010) \
diff --git a/examples/Ethernet/TZ_NTP_Clock_STM32_Ethernet/TZ_NTP_Clock_STM32_Ethernet.ino b/examples/Ethernet/TZ_NTP_Clock_STM32_Ethernet/TZ_NTP_Clock_STM32_Ethernet.ino
@@ -270,6 +270,8 @@ void setup()
   
 #endif
 
+  myTZ.writeRules();
+
   Udp.begin(localPort);
 }
 
diff --git a/examples/Ethernet/TZ_NTP_Clock_STM32_Ethernet/defines.h b/examples/Ethernet/TZ_NTP_Clock_STM32_Ethernet/defines.h
@@ -27,6 +27,8 @@
 
 // Debug Level from 0 to 4
 #define _ETHERNET_WEBSERVER_LOGLEVEL_       2
+#define _NTP_LOGLEVEL_                      0
+#define _TZ_LOGLEVEL_                       3
 
 // If USE_BUILTIN_ETHERNET == false and USE_UIP_ETHERNET == false => 
 // either use W5x00 with EthernetXYZ library
diff --git a/examples/RTL8720DN/TZ_NTP_Clock_RTL8720DN/TZ_NTP_Clock_RTL8720DN.ino b/examples/RTL8720DN/TZ_NTP_Clock_RTL8720DN/TZ_NTP_Clock_RTL8720DN.ino
@@ -267,6 +267,8 @@ void setup()
   
 #endif
 
+  myTZ->writeRules();
+
   Udp.begin(localPort);
 
   Serial.print(F("Listening on port "));
diff --git a/examples/RTL8720DN/TZ_NTP_Clock_RTL8720DN/defines.h b/examples/RTL8720DN/TZ_NTP_Clock_RTL8720DN/defines.h
@@ -21,6 +21,7 @@
 // Debug Level from 0 to 4
 #define _WIFI_LOGLEVEL_             3
 #define _NTP_LOGLEVEL_              0
+#define _TZ_LOGLEVEL_               3
 
 #include <WiFiWebServer_RTL8720.h>
 
diff --git a/examples/WT32_ETH01/TZ_NTP_Clock_WT32_ETH01/TZ_NTP_Clock_WT32_ETH01.ino b/examples/WT32_ETH01/TZ_NTP_Clock_WT32_ETH01/TZ_NTP_Clock_WT32_ETH01.ino
@@ -196,6 +196,9 @@ void setup()
   Serial.println(WEBSERVER_WT32_ETH01_VERSION);
   Serial.println(TIMEZONE_GENERIC_VERSION);
 
+  // To be called before ETH.begin()
+  WT32_ETH01_onEvent();
+
   //bool begin(uint8_t phy_addr=ETH_PHY_ADDR, int power=ETH_PHY_POWER, int mdc=ETH_PHY_MDC, int mdio=ETH_PHY_MDIO, 
   //           eth_phy_type_t type=ETH_PHY_TYPE, eth_clock_mode_t clk_mode=ETH_CLK_MODE);
   //ETH.begin(ETH_PHY_ADDR, ETH_PHY_POWER, ETH_PHY_MDC, ETH_PHY_MDIO, ETH_PHY_TYPE, ETH_CLK_MODE);
@@ -205,8 +208,6 @@ void setup()
   //bool config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dns1 = 0, IPAddress dns2 = 0);
   ETH.config(myIP, myGW, mySN, myDNS);
 
-  WT32_ETH01_onEvent();
-
   WT32_ETH01_waitForConnect();
   
   Serial.print(F("TZ_NTP_Clock_WT32_ETH01 started @ IP address: "));
@@ -249,6 +250,8 @@ void setup()
   
 #endif
 
+  myTZ->writeRules();
+
   Udp.begin(localPort);
 
   Serial.print(F("Listening on port "));
diff --git a/examples/WT32_ETH01/TZ_NTP_Clock_WT32_ETH01/defines.h b/examples/WT32_ETH01/TZ_NTP_Clock_WT32_ETH01/defines.h
@@ -21,6 +21,7 @@
 // Debug Level from 0 to 4
 #define _WIFI_LOGLEVEL_             3
 #define _NTP_LOGLEVEL_              0
+#define _TZ_LOGLEVEL_               3
 
 #include <WebServer_WT32_ETH01.h>
 
diff --git a/examples/WT32_ETH01/TZ_NTP_WorldClock_WT32_ETH01/TZ_NTP_WorldClock_WT32_ETH01.ino b/examples/WT32_ETH01/TZ_NTP_WorldClock_WT32_ETH01/TZ_NTP_WorldClock_WT32_ETH01.ino
@@ -229,6 +229,9 @@ void setup()
   Serial.println(WEBSERVER_WT32_ETH01_VERSION);
   Serial.println(TIMEZONE_GENERIC_VERSION);
 
+  // To be called before ETH.begin()
+  WT32_ETH01_onEvent();
+
   //bool begin(uint8_t phy_addr=ETH_PHY_ADDR, int power=ETH_PHY_POWER, int mdc=ETH_PHY_MDC, int mdio=ETH_PHY_MDIO, 
   //           eth_phy_type_t type=ETH_PHY_TYPE, eth_clock_mode_t clk_mode=ETH_CLK_MODE);
   //ETH.begin(ETH_PHY_ADDR, ETH_PHY_POWER, ETH_PHY_MDC, ETH_PHY_MDIO, ETH_PHY_TYPE, ETH_CLK_MODE);
@@ -238,8 +241,6 @@ void setup()
   //bool config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dns1 = 0, IPAddress dns2 = 0);
   ETH.config(myIP, myGW, mySN, myDNS);
 
-  WT32_ETH01_onEvent();
-
   WT32_ETH01_waitForConnect();
   
   Serial.print(F("TZ_NTP_WorldClock_WT32_ETH01 started @ IP address: "));
@@ -259,6 +260,7 @@ void setup()
   usPT  = new Timezone(usPDT, usPST);
 
   ////////////////////////////////
+
   
   Udp.begin(localPort);
 
diff --git a/examples/WT32_ETH01/TZ_NTP_WorldClock_WT32_ETH01/defines.h b/examples/WT32_ETH01/TZ_NTP_WorldClock_WT32_ETH01/defines.h
@@ -21,6 +21,7 @@
 // Debug Level from 0 to 4
 #define _WIFI_LOGLEVEL_             3
 #define _NTP_LOGLEVEL_              0
+#define _TZ_LOGLEVEL_               3
 
 #include <WebServer_WT32_ETH01.h>
 
diff --git a/examples/WiFiNINA/TZ_NTP_Clock_WiFiNINA/TZ_NTP_Clock_WiFiNINA.ino b/examples/WiFiNINA/TZ_NTP_Clock_WiFiNINA/TZ_NTP_Clock_WiFiNINA.ino
@@ -265,6 +265,8 @@ void setup()
   
 #endif
 
+  myTZ->writeRules();
+
   Udp.begin(localPort);
 
   Serial.print(F("Listening on port "));
diff --git a/examples/WiFiNINA/TZ_NTP_Clock_WiFiNINA/defines.h b/examples/WiFiNINA/TZ_NTP_Clock_WiFiNINA/defines.h
@@ -21,6 +21,7 @@
 #define _WIFI_LOGLEVEL_             3
 #define _WIFININA_LOGLEVEL_         3
 #define _NTP_LOGLEVEL_              1
+#define _TZ_LOGLEVEL_               3
 
 #define USE_WIFI_NINA         true
 //#define USE_WIFI_NINA         false
diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "Timezone_Generic",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "keywords": "timing, device, control, ntp, rtc, wifi, ethernet, WiFiNINA, SAM DUE, SAMD, nRF52, STM32, wt32-eth01, rp2040, nano-rp2040-connect, rtl8720, FlashStorage, DueFlashStorage, LittleFS, EEPROM, rpi-pico",
   "description": "Library to facilitate time zone conversions and automatic daylight saving (summer) time adjustments. For ESP8266, ESP32, WT32-ETH01 (ESP32 + LAN8720), SAMD21, SAMD51, nRF52, STM32F/L/H/G/WB/MP1, Teensy, SAM DUE, RTL8720DN, RP2040-based (Nano_RP2040_Connect, RASPBERRY_PI_PICO) boards, etc. using W5x00/ENC28J60/LAN8742A Ethernet, ESP or ESP-AT WiFi or WiFiNINA",
   "authors": [
@@ -161,8 +161,10 @@
       "platforms": ["*"]
     }
   ],
+  "license": "LGPL-3.0",
   "frameworks": "*",
   "platforms": "*",
   "examples": "examples/*/*/*.ino",
-  "license": "LGPL-3.0"
+  "headers": ["Timezone_Generic.h"]
+  
 }
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=Timezone_Generic
-version=1.7.2
+version=1.7.3
 author=Jack Christensen <jack.christensen@outlook.com>, Khoi Hoang <khoih.prog@gmail.com>
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=Library to facilitate time zone conversions and automatic daylight saving (summer) time adjustments.
diff --git a/platformio/platformio.ini b/platformio/platformio.ini
@@ -40,11 +40,11 @@ lib_deps =
 ; PlatformIO 4.x
   Time@>=1.6.1
   DS323x_Generic@>=1.2.2
-  WiFiNINA_Generic@>=1.8.13
+  WiFiNINA_Generic@>=1.8.14-1
   WiFiWebServer@>=1.4.2
   EthernetWebServer@>=1.7.1
   EthernetWebServer_STM32@>=1.2.1
-  WebServer_WT32_ETH01@>=1.3.0
+  WebServer_WT32_ETH01@>=1.4.1
   ESP8266_AT_WebServer@>=1.4.0
   Ethernet@>=2.0.0
   EthernetLarge@>=2.0.0
@@ -62,11 +62,11 @@ lib_deps =
 ; PlatformIO 5.x  
 ;  paulstoffregen/Time@>=1.6.1
 ;  khoih-prog/DS323x_Generic@>=1.2.2
-;  khoih-prog/WiFiNINA_Generic@>=1.8.13
+;  khoih-prog/WiFiNINA_Generic@>=1.8.14-1
 ;  khoih-prog/WiFiWebServer@>=1.4.2
 ;  khoih-prog/EthernetWebServer@>=1.7.1
 ;  khoih-prog/EthernetWebServer_STM32@>=1.2.1
-;  khoih-prog/WebServer_WT32_ETH01@>=1.3.0
+;  khoih-prog/WebServer_WT32_ETH01@>=1.4.1
 ;  khoih-prog/ESP8266_AT_WebServer@>=1.4.0
 ;  PaulStoffregen/Ethernet@>=2.0.0
 ;  PaulStoffregen/EthernetLarge@>=2.0.0
diff --git a/src/Timezone_Generic.h b/src/Timezone_Generic.h
@@ -10,7 +10,7 @@
 
   Built by Khoi Hoang https://github.com/khoih-prog/Timezone_Generic
   Licensed under MIT license
-  Version: 1.7.2
+  Version: 1.7.3
 
   Version Modified By  Date      Comments
   ------- -----------  ---------- -----------
@@ -26,6 +26,7 @@
   1.7.0   K Hoang      10/08/2021 Add support to Ameba Realtek RTL8720DN, RTL8722DM and RTM8722CSM
   1.7.1   K Hoang      10/10/2021 Update `platform.ini` and `library.json`
   1.7.2   K Hoang      02/11/2021 Fix crashing issue for new cleared flash
+  1.7.3   K Hoang      01/12/2021 Auto detect ESP32 core for LittleFS. Fix bug in examples for WT32_ETH01
  *****************************************************************************************************************************/
 
 #pragma once
@@ -41,7 +42,7 @@
 // For ESP8266, use LitteFS, SPIFFS or EEPROM.
 // For ESP32, use SPIFFS or EEPROM.
 
-#define TIMEZONE_GENERIC_VERSION       "Timezone_Generic v1.7.2"
+#define TIMEZONE_GENERIC_VERSION       "Timezone_Generic v1.7.3"
 
 #if defined(ARDUINO) && (ARDUINO >= 100)
   #include <Arduino.h>
diff --git a/src/Timezone_Generic_Debug.h b/src/Timezone_Generic_Debug.h
@@ -10,7 +10,7 @@
 
   Built by Khoi Hoang https://github.com/khoih-prog/Timezone_Generic
   Licensed under MIT license
-  Version: 1.7.2
+  Version: 1.7.3
 
   Version Modified By  Date      Comments
   ------- -----------  ---------- -----------
@@ -26,6 +26,7 @@
   1.7.0   K Hoang      10/08/2021 Add support to Ameba Realtek RTL8720DN, RTL8722DM and RTM8722CSM
   1.7.1   K Hoang      10/10/2021 Update `platform.ini` and `library.json`
   1.7.2   K Hoang      02/11/2021 Fix crashing issue for new cleared flash
+  1.7.3   K Hoang      01/12/2021 Auto detect ESP32 core for LittleFS. Fix bug in examples for WT32_ETH01
  *****************************************************************************************************************************/
 
 #pragma once
@@ -47,7 +48,7 @@
 // 4: DEBUG: errors, warnings, informational and debug
 
 #ifndef _TZ_LOGLEVEL_
-  #define _TZ_LOGLEVEL_       0
+  #define _TZ_LOGLEVEL_       1
 #endif
 
 ///////////////////////////////////////
diff --git a/src/Timezone_Generic_Impl.h b/src/Timezone_Generic_Impl.h
@@ -10,7 +10,7 @@
 
   Built by Khoi Hoang https://github.com/khoih-prog/Timezone_Generic
   Licensed under MIT license
-  Version: 1.7.2
+  Version: 1.7.3
 
   Version Modified By  Date      Comments
   ------- -----------  ---------- -----------
@@ -26,6 +26,7 @@
   1.7.0   K Hoang      10/08/2021 Add support to Ameba Realtek RTL8720DN, RTL8722DM and RTM8722CSM
   1.7.1   K Hoang      10/10/2021 Update `platform.ini` and `library.json`
   1.7.2   K Hoang      02/11/2021 Fix crashing issue for new cleared flash
+  1.7.3   K Hoang      01/12/2021 Auto detect ESP32 core for LittleFS. Fix bug in examples for WT32_ETH01
  *****************************************************************************************************************************/
 
 #pragma once
@@ -87,12 +88,29 @@
   #if USE_LITTLEFS
     // Use LittleFS
     #include "FS.h"
-
-    // The library will be depreciated after being merged to future major Arduino esp32 core release 2.x
-    // At that time, just remove this library inclusion
-    #include <LITTLEFS.h>             // https://github.com/lorol/LITTLEFS
     
-    #define FileFS        LITTLEFS 
+    // 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) )
+      #if (_TZ_LOGLEVEL_ > 2)
+        #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
+    #else
+      #if (_TZ_LOGLEVEL_ > 2)
+        #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
+      
+      #define FileFS        LITTLEFS
+    #endif
+
   #else
     // Use SPIFFS
     #include "FS.h"
@@ -445,11 +463,39 @@ void Timezone::initStorage(uint32_t address)
 #elif TZ_USE_ESP32
   // Do something to init LittleFS / InternalFS
   // Initialize Internal File System
+  if (!FileFS.begin(true))
+  {
+    TZ_LOGDEBUG("SPIFFS/LittleFS failed! Already tried formatting.");
+  
+    if (!FileFS.begin())
+    {     
+      // prevents debug info from the library to hide err message.
+      delay(100);
+      
+      TZ_LOGERROR("LittleFS failed!");
+    }
+  }
   
 /////////////////////////////    
 #elif TZ_USE_ESP8266
   // Do something to init LittleFS / InternalFS
   // Initialize Internal File System
+  // Do something to init LittleFS / InternalFS
+  // Initialize Internal File System
+  FileFS.format();
+   
+  if (!FileFS.begin())
+  {
+    TZ_LOGDEBUG("SPIFFS/LittleFS failed! Already tried formatting.");
+  
+    if (!FileFS.begin())
+    {     
+      // prevents debug info from the library to hide err message.
+      delay(100);
+      
+      TZ_LOGERROR("LittleFS failed!");
+    }
+  }
   
 /////////////////////////////
 #elif TZ_USE_RP2040
diff --git a/src_cpp/Timezone_Generic.cpp b/src_cpp/Timezone_Generic.cpp
diff --git a/src_cpp/Timezone_Generic.h b/src_cpp/Timezone_Generic.h
diff --git a/src_cpp/Timezone_Generic_Debug.h b/src_cpp/Timezone_Generic_Debug.h
diff --git a/src_h/Timezone_Generic.h b/src_h/Timezone_Generic.h
diff --git a/src_h/Timezone_Generic_Debug.h b/src_h/Timezone_Generic_Debug.h
diff --git a/src_h/Timezone_Generic_Impl.h b/src_h/Timezone_Generic_Impl.h

Original file line number	Diff line number	Diff line change
`@@ -449,6 +449,8 @@ void setup()`
`449`	`449`
`450`	`450`	`#endif`
`451`	`451`
	`452`	`+ myTZ->writeRules();`
	`453`	`+`
`452`	`454`	`Udp.begin(localPort);`
`453`	`455`	`}`
`454`	`456`
Original file line number	Diff line number	Diff line change
`@@ -270,6 +270,8 @@ void setup()`
`270`	`270`
`271`	`271`	`#endif`
`272`	`272`
	`273`	`+ myTZ.writeRules();`
	`274`	`+`
`273`	`275`	`Udp.begin(localPort);`
`274`	`276`	`}`
`275`	`277`