v1.7.0 to add support to RTL8720DN

### Releases v1.7.0

1. Add support to RTL8720DN, RTL8722DM, RTM8722CSM, etc. boards
2. Add examples with new features

Author: khoih-prog

CONTRIBUTING.md

@@ -29,7 +29,7 @@ Please ensure to specify the following:
 Arduino IDE version: 1.8.15
 Arduino SAMD Core Version 1.8.11
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-77-generic #86-Ubuntu SMP Thu Jun 17 02:35:03 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.4.0-80-generic #90-Ubuntu SMP Fri Jul 9 22:49:44 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered an endless loop while trying to connect to Local WiFi.

README.md

@@ -0,0 +1,293 @@
+/****************************************************************************************************************************
+  TZ_NTP_Clock_RTL8720DN.ino
+  
+  For AVR, ESP8266/ESP32, SAMD21/SAMD51, nRF52, STM32, WT32_ETH01 boards
+
+  Based on and modified from Arduino Timezone Library (https://github.com/JChristensen/Timezone)
+  to support other boards such as ESP8266/ESP32, SAMD21, SAMD51, Adafruit's nRF52 boards, etc.
+
+  Copyright (C) 2018 by Jack Christensen and licensed under GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html
+
+  Built by Khoi Hoang https://github.com/khoih-prog/Timezone_Generic
+  Licensed under MIT license
+  Version: 1.6.0
+
+  Version Modified By  Date      Comments
+  ------- -----------  ---------- -----------
+  1.2.4   K Hoang      17/10/2020 Initial porting to support SAM DUE, SAMD21, SAMD51, nRF52, ESP32/ESP8266, STM32, etc. boards
+                                  using SPIFFS, LittleFS, EEPROM, FlashStorage, DueFlashStorage.
+  1.2.5   K Hoang      28/10/2020 Add examples to use STM32 Built-In RTC.
+  1.2.6   K Hoang      01/11/2020 Allow un-initialized TZ then use begin() method to set the actual TZ (Credit of 6v6gt)
+  1.3.0   K Hoang      09/01/2021 Add support to ESP32/ESP8266 using LittleFS/SPIFFS, and to AVR, UNO WiFi Rev2, etc.
+                                  Fix compiler warnings.
+  1.4.0   K Hoang      04/06/2021 Add support to RP2040-based boards using RP2040 Arduino-mbed or arduino-pico core
+  1.5.0   K Hoang      13/06/2021 Add support to ESP32-S2 and ESP32-C3. Fix bug
+  1.6.0   K Hoang      16/07/2021 Add support to WT32_ETH01
+ *****************************************************************************************************************************/
+
+#include "defines.h"
+
+//////////////////////////////////////////
+
+#include <Timezone_Generic.h>    // https://github.com/khoih-prog/Timezone_Generic
+
+#define USING_INITIALIZED_TZ      false   //true
+
+#if USING_INITIALIZED_TZ
+  // US Eastern Time Zone (New York, Detroit,Toronto)
+  TimeChangeRule myDST = {"EDT", Second, Sun, Mar, 2, -240};    // Daylight time = UTC - 4 hours
+  TimeChangeRule mySTD = {"EST", First,  Sun, Nov, 2, -300};    // Standard time = UTC - 5 hours
+  Timezone *myTZ;
+#else
+  // Allow a "blank" TZ object then use begin() method to set the actual TZ.
+  // Feature added by 6v6gt (https://forum.arduino.cc/index.php?topic=711259)
+  Timezone *myTZ;
+  TimeChangeRule myDST;
+  TimeChangeRule mySTD;
+#endif
+
+// If TimeChangeRules are already stored in EEPROM, comment out the three
+// lines above and uncomment the line below.
+//Timezone myTZ(100);       // assumes rules stored at EEPROM address 100
+
+TimeChangeRule *tcr;        // pointer to the time change rule, use to get TZ abbrev
+
+//////////////////////////////////////////
+
+int status = WL_IDLE_STATUS;      // the Wifi radio's status
+
+char timeServer[]         = "time.nist.gov";  // NTP server
+unsigned int localPort    = 2390;             // local port to listen for UDP packets
+
+const int NTP_PACKET_SIZE = 48;       // NTP timestamp is in the first 48 bytes of the message
+const int UDP_TIMEOUT     = 2000;     // timeout in miliseconds to wait for an UDP packet to arrive
+
+byte packetBuffer[NTP_PACKET_SIZE];   // buffer to hold incoming and outgoing packets
+
+// A UDP instance to let us send and receive packets over UDP
+WiFiUDP Udp;
+
+// send an NTP request to the time server at the given address
+void sendNTPpacket(char *ntpSrv)
+{
+  // set all bytes in the buffer to 0
+  memset(packetBuffer, 0, NTP_PACKET_SIZE);
+  // Initialize values needed to form NTP request
+  // (see URL above for details on the packets)
+
+  packetBuffer[0] = 0b11100011;   // LI, Version, Mode
+  packetBuffer[1] = 0;            // Stratum, or type of clock
+  packetBuffer[2] = 6;            // Polling Interval
+  packetBuffer[3] = 0xEC;         // Peer Clock Precision
+  // 8 bytes of zero for Root Delay & Root Dispersion
+  packetBuffer[12]  = 49;
+  packetBuffer[13]  = 0x4E;
+  packetBuffer[14]  = 49;
+  packetBuffer[15]  = 52;
+
+  // all NTP fields have been given values, now
+  // you can send a packet requesting a timestamp:
+  Udp.beginPacket(ntpSrv, 123); //NTP requests are to port 123
+
+  Udp.write(packetBuffer, NTP_PACKET_SIZE);
+
+  Udp.endPacket();
+}
+
+//////////////////////////////////////////
+
+// format and print a time_t value, with a time zone appended.
+void printDateTime(time_t t, const char *tz)
+{
+    char buf[48];
+    char m[4];    // temporary storage for month string (DateStrings.cpp uses shared buffer)
+
+    memset(buf, 0, sizeof(buf));
+    memset(m, 0, sizeof(m));
+    
+    strcpy(m, monthShortStr(month(t)));
+    sprintf(buf, "%2d:%2d:%2d %s %2d %s %d %s",
+        hour(t), minute(t), second(t), dayShortStr(weekday(t)), day(t), m, year(t), tz);
+    Serial.println(buf);
+}
+
+void displayClock(void)
+{
+  time_t utc = now();
+
+  time_t local = myTZ->toLocal(utc, &tcr);
+  
+  Serial.println();
+  printDateTime(utc, "UTC");
+  printDateTime(local, tcr -> abbrev);
+  delay(10000);
+}
+
+void getNTPTime(void)
+{
+  static bool gotCurrentTime = false;
+  
+  // Just get the correct ime once
+  if (!gotCurrentTime)
+  {
+    sendNTPpacket(timeServer); // send an NTP packet to a time server
+    // wait to see if a reply is available
+    delay(1000);
+
+    if (Udp.parsePacket())
+    {
+      Serial.println(F("Packet received"));
+      // We've received a packet, read the data from it
+      Udp.read(packetBuffer, NTP_PACKET_SIZE); // read the packet into the buffer
+
+      //the timestamp starts at byte 40 of the received packet and is four bytes,
+      // or two words, long. First, esxtract the two words:
+
+      unsigned long highWord = word(packetBuffer[40], packetBuffer[41]);
+      unsigned long lowWord = word(packetBuffer[42], packetBuffer[43]);
+      // combine the four bytes (two words) into a long integer
+      // this is NTP time (seconds since Jan 1 1900):
+      unsigned long secsSince1900 = highWord << 16 | lowWord;
+      Serial.print(F("Seconds since Jan 1 1900 = "));
+      Serial.println(secsSince1900);
+
+      // now convert NTP time into everyday time:
+      Serial.print(F("Unix time = "));
+      // Unix time starts on Jan 1 1970. In seconds, that's 2208988800:
+      const unsigned long seventyYears = 2208988800UL;
+      // subtract seventy years:
+      unsigned long epoch = secsSince1900 - seventyYears;
+
+      // Get the time_t from epoch
+      time_t epoch_t = epoch;
+
+      // set the system time to UTC
+      // warning: assumes that compileTime() returns US EDT
+      // adjust the following line accordingly if you're in another time zone
+      setTime(epoch_t);
+      
+      // print Unix time:
+      Serial.println(epoch);
+
+      // print the hour, minute and second:
+      Serial.print(F("The UTC time is "));       // UTC is the time at Greenwich Meridian (GMT)
+      Serial.print((epoch  % 86400L) / 3600); // print the hour (86400 equals secs per day)
+      Serial.print(':');
+
+      if (((epoch % 3600) / 60) < 10)
+      {
+        // In the first 10 minutes of each hour, we'll want a leading '0'
+        Serial.print('0');
+      }
+      Serial.print((epoch  % 3600) / 60); // print the minute (3600 equals secs per minute)
+      Serial.print(':');
+
+      if ((epoch % 60) < 10)
+      {
+        // In the first 10 seconds of each minute, we'll want a leading '0'
+        Serial.print('0');
+      }
+      Serial.println(epoch % 60); // print the second
+
+      gotCurrentTime = true;
+    }
+    else
+    {
+      // wait ten seconds before asking for the time again
+      delay(10000);
+    }
+  }
+}
+
+//////////////////////////////////////////
+
+void setup()
+{
+  Serial.begin(115200);
+  while (!Serial);
+
+  delay(200);
+
+  Serial.print(F("\nStart TZ_NTP_Clock_RTL8720DN on ")); Serial.println(BOARD_NAME);
+  Serial.println(WIFI_WEBSERVER_RTL8720_VERSION);
+  Serial.println(TIMEZONE_GENERIC_VERSION);
+
+  if (WiFi.status() == WL_NO_SHIELD)
+  {
+    Serial.println(F("WiFi shield not present"));
+    // don't continue
+    while (true);
+  }
+
+  String fv = WiFi.firmwareVersion();
+
+  Serial.print("Current Firmware Version = "); Serial.println(fv);
+  
+  if (fv != LATEST_RTL8720_FIRMWARE) 
+  {
+    Serial.println("Please upgrade the firmware");
+  }
+ 
+  // attempt to connect to Wifi network:
+  while (status != WL_CONNECTED) 
+  {
+    Serial.print("Attempting to connect to SSID: "); Serial.println(ssid);
+    
+    // Connect to WPA/WPA2 network. 2.4G and 5G are all OK
+    status = WiFi.begin(ssid, pass);
+
+    // wait 10 seconds for connection:
+    delay(10000);
+  }
+ 
+  Serial.print(F("TZ_NTP_Clock_RTL8720DN started @ IP address: "));
+  Serial.println(WiFi.localIP());
+
+#if (USING_INITIALIZED_TZ)
+
+  myTZ = new Timezone(myDST, mySTD);
+
+#else
+
+  // Can read this info from EEPROM, storage, etc
+  String tzName = "EDT/EST" ;
+
+  // Time zone rules can be set as below or dynamically built, say through a configuration
+  //  interface, or fetched from eeprom, flash etc.
+
+  if ( tzName == "EDT/EST" )
+  {
+    // America Eastern Time
+    myDST = (TimeChangeRule) {"EDT",  Second, Sun, Mar, 2, -240};    // Daylight time = UTC - 4 hours
+    mySTD = (TimeChangeRule) {"EST",  First,  Sun, Nov, 2, -300};     // Standard time = UTC - 5 hours
+  }
+  else if ( tzName == "CET/CEST" ) 
+  {
+    // central Europe
+    myDST = (TimeChangeRule) {"CEST", Last, Sun, Mar, 2, 120};
+    mySTD = (TimeChangeRule) {"CET",  Last, Sun, Oct, 3, 60};
+  }
+  
+  else if ( tzName == "GMT/BST" ) 
+  {
+    // UK
+    myDST = (TimeChangeRule) {"BST",  Last, Sun, Mar, 1, 60};
+    mySTD = (TimeChangeRule) {"GMT",  Last, Sun, Oct, 2, 0};
+  }
+
+  myTZ = new Timezone();
+  myTZ->init( myDST, mySTD );
+  
+#endif
+
+  Udp.begin(localPort);
+
+  Serial.print(F("Listening on port "));
+  Serial.println(localPort);
+}
+
+void loop()
+{
+  getNTPTime();
+  displayClock();
+}

examples/RTL8720DN/TZ_NTP_Clock_RTL8720DN/TZ_NTP_Clock_RTL8720DN.ino

@@ -0,0 +1,30 @@
+/****************************************************************************************************************************
+  defines.h
+  
+  For AVR, ESP8266/ESP32, SAMD21/SAMD51, nRF52, STM32, WT32_ETH01 boards
+
+  Based on and modified from Arduino Timezone Library (https://github.com/JChristensen/Timezone)
+  to support other boards such as ESP8266/ESP32, SAMD21, SAMD51, Adafruit's nRF52 boards, etc.
+
+  Copyright (C) 2018 by Jack Christensen and licensed under GNU GPL v3.0, https://www.gnu.org/licenses/gpl.html
+
+  Built by Khoi Hoang https://github.com/khoih-prog/Timezone_Generic
+  Licensed under MIT license
+ *****************************************************************************************************************************/
+
+#ifndef defines_h
+#define defines_h
+
+#define DEBUG_WIFI_WEBSERVER_PORT   Serial
+#define NTP_DBG_PORT                Serial
+
+// Debug Level from 0 to 4
+#define _WIFI_LOGLEVEL_             3
+#define _NTP_LOGLEVEL_              0
+
+#include <WiFiWebServer_RTL8720.h>
+
+char ssid[] = "SSID_5GHz";        // your network SSID (name)
+char pass[] = "12345678";        // your network password
+
+#endif    //defines_h