khoih-prog / NTPClient_Generic

Library for NTPClient to connect to an NTP time-server. Get time from a NTP time-server and keep it in sync. For ESP8266/ESP32, nRF52, SAMD21/SAMD51, STM32F/L/H/G/WB/MP1, Teensy, etc. besides AVR, using ESP WiFi, WiFiNINA, Ethernet W5x00, ENC28J60, LAN8742A, ESP8266/ESP32 AT-command WiFi.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NTPClient_Generic Library

arduino-library-badge GitHub release GitHub contributions welcome GitHub issues

Donate to my libraries using BuyMeACoffee



Table of Contents



Important Change from v3.7.0

Please have a look at HOWTO Fix Multiple Definitions Linker Error

From v3.7.2, you can use the new setUDP() function for auto-switching between WiFi and Ethernet UDP to update NTP time.

Check examples ESP_WiFi_ETH_NTPClient_Advanced and WT32_WiFi_ETH01_NTPClient_Advanced for a demo.



Why do we need this NTPClient_Generic library

Features

The NTPClient_Generic library is designed to work in conjunction with the Arduino Time library, which must also be installed on your system. This documentation assumes some familiarity with the Time library.

The primary goal of the NTPClient_Generic library is to enable the creation of an NTPClient to connect to NTP time-servers to get time and keep local time in sync. For ESP8266/ESP32, WT32_ETH01 (ESP32 + LAN8720), nRF52, SAMD21/SAMD51, STM32F/L/H/G/WB/MP1, Teensy, RP2040-based boards (Nano_RP2040_Connect, RASPBERRY_PI_PICO), etc. besides AVR, using ESP WiFi, WiFiNINA, Ethernet W5x00, ENC28J60, LAN8742A, ESP8266/ESP32 AT-command WiFi. But whether hardware RTC or another time-keeping source is present is not mandatory, since the Time library library can function as a software RTC without additional hardware (although its accuracy is dependent on the accuracy of the microcontroller's system clock.)

The examples will demonstrate how to get the UTC time from NTP server, then update the DS3231 RTC or local clock to make sure the time is perfectly correct.

In the examples, the interval to get perfect time from the NTP server to update RTC and/or local clock is configurable to ensure the RTC and/or local clock accuracy.

This NTPClient_Generic library is based on and modified from Fabrice Weinberg's NTPClient Library to add functions, features and as well as support to many boards and shields.


Currently supported Boards

This NTPClient_Generic library currently supports these following boards:

  1. nRF52 boards, such as AdaFruit Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox, etc.

  2. SAMD21

  • Arduino SAMD21: ZERO, MKRs, NANO_33_IOT, etc.
  • Adafruit SAMD21 (M0): ItsyBitsy M0, Feather M0, Feather M0 Express, Metro M0 Express, Circuit Playground Express, Trinket M0, PIRkey, Hallowing M0, Crickit M0, etc.
  • Seeeduino: LoRaWAN, Zero, Femto M0, XIAO M0, Wio GPS Board, etc.
  1. SAMD51
  • Adafruit SAMD51 (M4): Metro M4, Grand Central M4, ItsyBitsy M4, Feather M4 Express, Trellis M4, Metro M4 AirLift Lite, MONSTER M4SK Express, Hallowing M4, etc.
  • Seeeduino: Wio Terminal, Grove UI Wireless
  1. SAM DUE
  2. Teensy (4.1, 4.0, 3.6, 3.5, 3,2, 3.1, 3.0)
  3. STM32F/L/H/G/WB/MP1 boards (with 32+K Flash)
  • Nucleo-144
  • Nucleo-64
  • Discovery
  • Generic STM32F0, STM32F1, STM32F2, STM32F3, STM32F4, STM32F7 (with 64+K Flash): x8 and up
  • STM32L0, STM32L1, STM32L4
  • STM32G0, STM32G4
  • STM32H7
  • STM32WB
  • STM32MP1
  • LoRa boards
  • 3-D printer boards
  • Generic Flight Controllers
  • Midatronics boards
  1. ESP32

  2. ESP8266

  3. AVR Mega1280, 2560, ADK.

  4. RP2040-based boards, such as Nano_RP2040_Connect, using Arduino mbed OS for Nano boards.

  5. RP2040-based boards, such as RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, using Arduino-mbed RP2040 core or Earle Philhower's arduino-pico core.

  6. WT32_ETH01 boards using ESP32-based boards and LAN8720 Ethernet

  7. RTL8720DN, RTL8722DM, RTL8722CSM, etc. boards

  8. Portenta_H7 using Murata WiFi or Vision-shield Ethernet

  9. RP2040W boards using CYW43439 WiFi, such as RASPBERRY_PI_PICO_W, using Earle Philhower's arduino-pico core.


Currently supported WiFi shields/modules

  1. WiFiNINA using WiFiNINA_Generic library
  2. WiFi101 using WiFi101 library v0.16.1+
  3. U-Blox W101, W102 using WiFiNINA_Generic library
  4. ESP826-AT command using WiFiEspAT library
  5. ESP8266/ESP32-AT command using ESP_AT_Lib library and ESP8266_AT_WebServer
  6. ESP32 and ESP8266 WiFi
  7. RTL8720DN, RTL8722DM, RTL8722CSM
  8. Portenta_H7 Murata WiFi
  9. RASPBERRY_PI_PICO_W CYW43439 WiFi

Currently supported Ethernet shields/modules

  1. W5x00 using Ethernet_Generic library
  2. W5x00 using Ethernet, EthernetLarge, Ethernet2 or Ethernet3 library
  3. ENC28J60 using EthernetENC or UIPEthernet library
  4. Teensy 4.1 built-in Ethernet using NativeEthernet library
  5. Teensy 4.1 built-in Ethernet using QNEthernet library
  6. LAN8742A using STM32Ethernet / STM32 LwIP libraries.
  7. LAN8720A in WT32-ETH01 using WebServer_WT32_ETH01
  8. Portenta_H7 Ethernet using Portenta_Ethernet library


Prerequisites

  1. Arduino IDE 1.8.19+ for Arduino. GitHub release

  2. ESP32 Core 2.0.5+ for ESP32-based boards. Latest release

  3. ESP8266 Core 3.0.2+ for ESP8266-based boards. Latest release. To use ESP8266 core 2.7.1+ for LittleFS.

  4. Arduino AVR core 1.8.5+ for Arduino (Use Arduino Board Manager) for AVR boards. GitHub release

  5. Teensy core v1.57+ for Teensy (4.1, 4.0, 3.6, 3.5, 3,2, 3.1, 3.0) boards.

  6. Arduino SAM DUE core v1.6.12+ for SAM DUE ARM Cortex-M3 boards.

  7. Arduino SAMD core 1.8.13+ for SAMD ARM Cortex-M0+ boards. GitHub release

  8. Adafruit SAMD core 1.7.10+ for SAMD ARM Cortex-M0+ and M4 boards (Nano 33 IoT, etc.). GitHub release

  9. Seeeduino SAMD core 1.8.3+ for SAMD21/SAMD51 boards (XIAO M0, Wio Terminal, etc.). Latest release

  10. Adafruit nRF52 v1.3.0+ for nRF52 boards such as Adafruit NRF52840_FEATHER, NRF52832_FEATHER, NRF52840_FEATHER_SENSE, NRF52840_ITSYBITSY, NRF52840_CIRCUITPLAY, NRF52840_CLUE, NRF52840_METRO, NRF52840_PCA10056, PARTICLE_XENON, NINA_B302_ublox, etc. GitHub release

  11. Arduino Core for STM32 v2.3.0+ for STM32F/L/H/G/WB/MP1 boards. GitHub release

  12. ArduinoCore-mbed mbed_rp2040, mbed_nano, mbed_portenta core 3.4.1+ for Arduino (Use Arduino Board Manager) Portenta_H7, RP2040-based boards, such as Nano_RP2040_Connect, RASPBERRY_PI_PICO. GitHub release

  13. Earle Philhower's arduino-pico core v2.6.1+ for RP2040-based boards such as RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, etc. GitHub release

  14. Arduino AmebaD core 3.1.4+ for Realtek RTL8720DN, RTL8722DM and RTL8722CSM. GitHub release

  15. Time v1.6.1+. GitHub release

  16. For built-in LAN8742A Ethernet:

  1. For W5x00 Ethernet:
  1. For ENC28J60 Ethernet:
  1. WiFiNINA_Generic library v1.8.14-6+ to use WiFiNINA modules/shields. To install. check arduino-library-badge if using WiFiNINA for boards such as Nano 33 IoT, nRF52, Teensy, etc.

  2. WiFiWebServer library v1.9.5+ to use WiFi/WiFiNINA modules/shields. To install, check arduino-library-badge

  3. EthernetWebServer library v2.2.3+ to use Ethernet modules/shields on boards other than STM32F/L/H/G/WB/MP1. To install. check arduino-library-badge.

  4. EthernetWebServer_STM32 library v1.5.0+ to use Ethernet modules/shields on STM32F/L/H/G/WB/MP1 boards. To install, check arduino-library-badge.

  5. ESP8266_AT_WebServer library v1.5.4+ to use ESP8266-AT/ESP32-AT WiFi modules/shields. To install, check arduino-library-badge

  6. DS323x_Generic library v1.3.1+ to use examples using DS323x RTC modules/shields. To install, check arduino-library-badge

  7. Timezone_Generic library v1.10.1+ to use examples using Timezone. To install, check arduino-library-badge

  8. STM32RTC library v1.3.2+ to use STM32 examples using built-in STM32 RTC. GitHub release.

  9. WebServer_WT32_ETH01 library v1.5.1+ to use WT32_ETH01 (ESP32 + LAN8720). To install, check arduino-library-badge.

  10. WiFiWebServer_RTL8720 library v1.1.2+ to use Realtek RTL8720DN, etc. To install, check arduino-library-badge.

  11. Modified WiFi101 Library v0.16.1+ to use SAMD MKR1000, etc. boards with WiFi101.

  12. WiFiEspAT library v1.4.1+ if using ESP8288/ESP32-AT shields. GitHub release

  13. FlashStorage_SAMD library v1.3.2+ for SAMD21 and SAMD51 boards (ZERO, MKR, NANO_33_IOT, M0, M0 Pro, AdaFruit Itsy-Bitsy M4, etc.). GitHub release

  14. FlashStorage_STM32F1 library v1.1.0+ for STM32F1/F3 boards. To install. check arduino-library-badge

  15. FlashStorage_STM32 library v1.2.0+ for STM32F/L/H/G/WB/MP1 boards. To install. check arduino-library-badge



Installation

Use Arduino Library Manager

The best and easiest way is to use Arduino Library Manager. Search for NTPClient_Generic, then select / install the latest version. You can also use this link arduino-library-badge for more detailed instructions.

Manual Install

Another way to install is to:

  1. Navigate to NTPClient_Generic page.
  2. Download the latest release NTPClient_Generic-main.zip.
  3. Extract the zip file to NTPClient_Generic-main directory
  4. Copy whole NTPClient_Generic-main/src folder to Arduino libraries' directory such as ~/Arduino/libraries/.

VS Code & PlatformIO

  1. Install VS Code
  2. Install PlatformIO
  3. Install NTPClient_Generic library by using Library Manager. Search for NTPClient_Generic in Platform.io Author's Libraries
  4. Use included platformio.ini file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at Project Configuration File


Packages' Patches

1. For Adafruit nRF52840 and nRF52832 boards

To be able to compile, run and automatically detect and display BOARD_NAME on nRF52840/nRF52832 boards, you have to copy the whole nRF52 Packages_Patches directory into Adafruit nRF52 directory (~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0).

Supposing the Adafruit nRF52 version is 1.3.0. These files must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/boards.txt
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/cores/nRF5/Udp.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/cores/nRF5/Print.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/cores/nRF5/Print.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/variants/NINA_B302_ublox/variant.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/variants/NINA_B302_ublox/variant.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/variants/NINA_B112_ublox/variant.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/variants/NINA_B112_ublox/variant.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/1.3.0/cores/nRF5/Udp.h

Whenever a new version is installed, remember to copy these files into the new version directory. For example, new version is x.yy.z These files must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/boards.txt
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/cores/nRF5/Udp.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/cores/nRF5/Print.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/cores/nRF5/Print.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/variants/NINA_B302_ublox/variant.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/variants/NINA_B302_ublox/variant.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/variants/NINA_B112_ublox/variant.h
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/variants/NINA_B112_ublox/variant.cpp
  • ~/.arduino15/packages/adafruit/hardware/nrf52/x.yy.z/cores/nRF5/Udp.h

2. For Teensy boards

To be able to compile and run on Teensy boards, you have to copy the files in Packages_Patches for Teensy directory into Teensy hardware directory (./arduino-1.8.19/hardware/teensy/avr/boards.txt).

Supposing the Arduino version is 1.8.19. These files must be copied into the directory:

  • ./arduino-1.8.19/hardware/teensy/avr/boards.txt
  • ./arduino-1.8.19/hardware/teensy/avr/cores/teensy/Stream.h
  • ./arduino-1.8.19/hardware/teensy/avr/cores/teensy3/Stream.h
  • ./arduino-1.8.19/hardware/teensy/avr/cores/teensy4/Stream.h

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz These files must be copied into the directory:

  • ./arduino-x.yy.zz/hardware/teensy/avr/boards.txt
  • ./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy/Stream.h
  • ./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy3/Stream.h
  • ./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy4/Stream.h

3. For Arduino SAM DUE boards

To be able to compile and run on SAM DUE boards, you have to copy the whole SAM DUE directory into Arduino sam directory (~/.arduino15/packages/arduino/hardware/sam/1.6.12).

Supposing the Arduino SAM core version is 1.6.12. This file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/sam/1.6.12/platform.txt

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/sam/x.yy.zz/platform.txt

4. For Arduino SAMD boards

To be able to compile, run and automatically detect and display BOARD_NAME on Arduino SAMD (Nano-33-IoT, etc) boards, you have to copy the whole Arduino SAMD Packages_Patches directory into Arduino SAMD directory (~/.arduino15/packages/arduino/hardware/samd/1.8.13).

For core version v1.8.10+

Supposing the Arduino SAMD version is 1.8.13. Now only one file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/1.8.13/platform.txt

Whenever a new version is installed, remember to copy this files into the new version directory. For example, new version is x.yy.zz

This file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.zz/platform.txt

For core version v1.8.9-

Supposing the Arduino SAMD version is 1.8.9. These files must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/1.8.9/platform.txt
  • ~/.arduino15/packages/arduino/hardware/samd/1.8.9/cores/arduino/Arduino.h

Whenever a new version is installed, remember to copy these files into the new version directory. For example, new version is x.yy.z

These files must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.z/platform.txt
  • ~/.arduino15/packages/arduino/hardware/samd/x.yy.z/cores/arduino/Arduino.h

This is mandatory to fix the notorious Arduino SAMD compiler error. See Improve Arduino compatibility with the STL (min and max macro)

 ...\arm-none-eabi\include\c++\7.2.1\bits\stl_algobase.h:243:56: error: macro "min" passed 3 arguments, but takes just 2
     min(const _Tp& __a, const _Tp& __b, _Compare __comp)

Whenever the above-mentioned compiler error issue is fixed with the new Arduino SAMD release, you don't need to copy the Arduino.h file anymore.

5. For Adafruit SAMD boards

To be able to compile, run and automatically detect and display BOARD_NAME on Adafruit SAMD (Itsy-Bitsy M4, etc) boards, you have to copy the whole Adafruit SAMD Packages_Patches directory into Adafruit samd directory (~/.arduino15/packages/adafruit/hardware/samd/1.7.10).

Supposing the Adafruit SAMD core version is 1.7.10. This file must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.10/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.10/cores/arduino/Print.h
  • ~/.arduino15/packages/adafruit/hardware/samd/1.7.10/cores/arduino/Print.cpp

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/platform.txt
  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/cores/arduino/Print.h
  • ~/.arduino15/packages/adafruit/hardware/samd/x.yy.zz/cores/arduino/Print.cpp

6. For Seeeduino SAMD boards

To be able to compile, run and automatically detect and display BOARD_NAME on Seeeduino SAMD (XIAO M0, Wio Terminal, etc) boards, you have to copy the whole Seeeduino SAMD Packages_Patches directory into Seeeduino samd directory (~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3).

Supposing the Seeeduino SAMD core version is 1.8.3. This file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3/platform.txt
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3/cores/arduino/Arduino.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3/cores/arduino/Print.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/1.8.3/cores/arduino/Print.cpp

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/platform.txt
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Arduino.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Print.h
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/cores/arduino/Print.cpp

7. For STM32 boards

7.1 For STM32 boards to use LAN8720

To use LAN8720 on some STM32 boards

  • Nucleo-144 (F429ZI, NUCLEO_F746NG, NUCLEO_F746ZG, NUCLEO_F756ZG)
  • Discovery (DISCO_F746NG)
  • STM32F4 boards (BLACK_F407VE, BLACK_F407VG, BLACK_F407ZE, BLACK_F407ZG, BLACK_F407VE_Mini, DIYMORE_F407VGT, FK407M1)

you have to copy the files stm32f4xx_hal_conf_default.h and stm32f7xx_hal_conf_default.h into STM32 stm32 directory (~/.arduino15/packages/STM32/hardware/stm32/2.3.0/system) to overwrite the old files.

Supposing the STM32 stm32 core version is 2.3.0. These files must be copied into the directory:

  • ~/.arduino15/packages/STM32/hardware/stm32/2.3.0/system/STM32F4xx/stm32f4xx_hal_conf_default.h for STM32F4.
  • ~/.arduino15/packages/STM32/hardware/stm32/2.3.0/system/STM32F7xx/stm32f7xx_hal_conf_default.h for Nucleo-144 STM32F7.

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz, these files must be copied into the corresponding directory:

  • ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F4xx/stm32f4xx_hal_conf_default.h
  • `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F7xx/stm32f7xx_hal_conf_default.h

7.2 For STM32 boards to use Serial1

To use Serial1 on some STM32 boards without Serial1 definition (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.) boards, you have to copy the files STM32 variant.h into STM32 stm32 directory (~/.arduino15/packages/STM32/hardware/stm32/2.3.0). You have to modify the files corresponding to your boards, this is just an illustration how to do.

Supposing the STM32 stm32 core version is 2.3.0. These files must be copied into the directory:

  • ~/.arduino15/packages/STM32/hardware/stm32/2.3.0/variants/STM32F7xx/F765Z(G-I)T_F767Z(G-I)T_F777ZIT/NUCLEO_F767ZI/variant.h for Nucleo-144 NUCLEO_F767ZI.
  • ~/.arduino15/packages/STM32/hardware/stm32/2.3.0/variants/STM32L0xx/L052R(6-8)T_L053R(6-8)T_L063R8T/NUCLEO_L053R8/variant.h for Nucleo-64 NUCLEO_L053R8.

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz, these files must be copied into the corresponding directory:

  • ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/variants/STM32F7xx/F765Z(G-I)T_F767Z(G-I)T_F777ZIT/NUCLEO_F767ZI/variant.h
  • ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/variants/STM32L0xx/L052R(6-8)T_L053R(6-8)T_L063R8T/NUCLEO_L053R8/variant.h

8. For RP2040-based boards using Earle Philhower arduino-pico core

8.1 To use BOARD_NAME

To be able to automatically detect and display BOARD_NAME on RP2040-based boards (RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc) boards, you have to copy the file RP2040 platform.txt into rp2040 directory (~/.arduino15/packages/rp2040/hardware/rp2040/1.4.0).

Supposing the rp2040 core version is 1.4.0. This file must be copied into the directory:

  • ~/.arduino15/packages/rp2040/hardware/rp2040/1.4.0/platform.txt

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/rp2040/hardware/rp2040/x.yy.zz/platform.txt

With core after v1.5.0, this step is not necessary anymore thanks to the PR Add -DBOARD_NAME="{build.board}" #136.

8.2 To avoid compile error relating to microsecondsToClockCycles

Some libraries, such as Adafruit DHT-sensor-library, require the definition of microsecondsToClockCycles(). To be able to compile and run on RP2040-based boards, you have to copy the files in RP2040 Arduino.h into rp2040 directory (~/.arduino15/packages/rp2040/hardware/rp2040/1.4.0).

Supposing the rp2040 core version is 1.4.0. This file must be copied to replace:

  • ~/.arduino15/packages/rp2040/hardware/rp2040/1.4.0/cores/rp2040/Arduino.h

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied to replace:

  • ~/.arduino15/packages/rp2040/hardware/rp2040/x.yy.zz/cores/rp2040/Arduino.h

With core after v1.5.0, this step is not necessary anymore thanks to the PR Add defs for compatibility #142.

9. For Portenta_H7 boards using Arduino IDE in Linux

To be able to upload firmware to Portenta_H7 using Arduino IDE in Linux (Ubuntu, etc.), you have to copy the file portenta_post_install.sh into mbed_portenta directory (~/.arduino15/packages/arduino/hardware/mbed_portenta/3.4.1/portenta_post_install.sh).

Then run the following command using sudo

$ cd ~/.arduino15/packages/arduino/hardware/mbed_portenta/3.4.1
$ chmod 755 portenta_post_install.sh
$ sudo ./portenta_post_install.sh

This will create the file /etc/udev/rules.d/49-portenta_h7.rules as follows:

# Portenta H7 bootloader mode UDEV rules

SUBSYSTEMS=="usb", ATTRS{idVendor}=="2341", ATTRS{idProduct}=="035b", GROUP="plugdev", MODE="0666"

Supposing the ArduinoCore-mbed core version is 3.4.1. Now only one file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/mbed_portenta/3.4.1/portenta_post_install.sh

Whenever a new version is installed, remember to copy this files into the new version directory. For example, new version is x.yy.zz

This file must be copied into the directory:

  • ~/.arduino15/packages/arduino/hardware/mbed_portenta/x.yy.zz/portenta_post_install.sh

10. For RTL8720DN boards using AmebaD core

To avoid compile error relating to PROGMEM, you have to copy the file Realtek AmebaD core pgmspace.h into Realtek AmebaD directory (~/.arduino15/packages/realtek/hardware/AmebaD/3.1.4/cores/arduino/avr/pgmspace.h).

Supposing the Realtek AmebaD core version is 3.1.4. This file must be copied into the directory:

  • ~/.arduino15/packages/realtek/hardware/AmebaD/3.1.4/cores/arduino/avr/pgmspace.h

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/realtek/hardware/AmebaD/x.yy.zz/cores/arduino/avr/pgmspace.h

11. For SAMD21 and SAMD51 boards using ArduinoCore-fab-sam core

To avoid compile error relating to SAMD21/SAMD51, you have to copy the file ArduinoCore-fab-sam core pgmspace.h into ArduinoCore-fab-sam samd directory (~/.arduino15/packages/Fab_SAM_Arduino/hardware/samd/1.7.0/boards.txt).

Supposing the ArduinoCore-fab-sam samd core version is 1.7.0. This file must be copied into the directory:

  • ~/.arduino15/packages/Fab_SAM_Arduino/hardware/samd/1.7.0/boards.txt

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/Fab_SAM_Arduino/hardware/samd/x.yy.zz/boards.txt

12. For Seeeduino RP2040 boards

To be able to compile, run and automatically detect and display BOARD_NAME on Seeeduino RP2040 (XIAO RP2040, Wio RP2040 Mini) boards, you have to copy the whole Seeeduino RP2040 Packages_Patches directory into Seeeduino samd directory (~/.arduino15/packages/Seeeduino/hardware/rp2040/2.7.2).

Supposing the Seeeduino SAMD core version is 2.7.2. This file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/rp2040/2.7.2/boards.txt
  • ~/.arduino15/packages/Seeeduino/hardware/rp2040/2.7.2/variants/Seeed_XIAO_RP2040/pins_arduino.h

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz This file must be copied into the directory:

  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/boards.txt
  • ~/.arduino15/packages/Seeeduino/hardware/samd/x.yy.zz/variants/Seeed_XIAO_RP2040/pins_arduino.h


Libraries' Patches

1. For application requiring 2K+ HTML page

If your application requires 2K+ HTML page, the current Ethernet library must be modified if you are using W5200/W5500 Ethernet shields. W5100 is not supported for 2K+ buffer. If you use boards requiring different CS/SS pin for W5x00 Ethernet shield, for example ESP32, ESP8266, nRF52, etc., you also have to modify the following libraries to be able to specify the CS/SS pin correctly.

2. For Ethernet library

To fix Ethernet library, just copy these following files into the Ethernet library directory to overwrite the old files:

3. For EthernetLarge library

To fix EthernetLarge library, just copy these following files into the EthernetLarge library directory to overwrite the old files:

4. For Ethernet2 library

To fix Ethernet2 library, just copy these following files into the Ethernet2 library directory to overwrite the old files:

To add UDP Multicast support, necessary for the UPnP_Generic library:

5. For Ethernet3 library

  1. To fix Ethernet3 library, just copy these following files into the Ethernet3 library directory to overwrite the old files:

6. For UIPEthernet library

To be able to compile and run on nRF52 boards with ENC28J60 using UIPEthernet library, you have to copy these following files into the UIPEthernet utility directory to overwrite the old files:

7. For fixing ESP32 compile error

To fix ESP32 compile error, just copy the following file into the ESP32 cores/esp32 directory (e.g. ./arduino-1.8.13/hardware/espressif/cores/esp32) to overwrite the old file:

8. For fixing ESP8266 compile error

To fix ESP8266 compile error such as

error: 'class EthernetClass' has no member named 'init'
Ethernet.init (USE_THIS_SS_PIN);

just rename the following file in ./arduino-1.8.13/hardware/esp8266com/esp8266/libraries/Ethernet directory

  • From Ethernet.h to Ethernet_ESP8266.h


HOWTO Fix Multiple Definitions Linker Error

The current library implementation, using xyz-Impl.h instead of standard xyz.cpp, possibly creates certain Multiple Definitions Linker error in certain use cases.

You can use

#include <NTPClient_Generic.hpp>               //https://github.com/khoih-prog/NTPClient_Generic

in many files. But be sure to use the following #include <NTPClient_Generic.h> in just 1 .h, .cpp or .ino file, which must not be included in any other file, to avoid Multiple Definitions Linker Error

// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include <NTPClient_Generic.h>                //https://github.com/khoih-prog/NTPClient_Generic

Check multiFileProject for a demo how to avoid multiple-definitions linker error for multiple-file project



HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)

Please have a look at ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to have more detailed description and solution of the issue.

1. ESP32 has 2 ADCs, named ADC1 and ADC2

2. ESP32 ADCs functions

  • ADC1 controls ADC function for pins GPIO32-GPIO39
  • ADC2 controls ADC function for pins GPIO0, 2, 4, 12-15, 25-27

3.. ESP32 WiFi uses ADC2 for WiFi functions

Look in file adc_common.c

In ADC2, there're two locks used for different cases:

  1. lock shared with app and Wi-Fi: ESP32: When Wi-Fi using the ADC2, we assume it will never stop, so app checks the lock and returns immediately if failed. ESP32S2: The controller's control over the ADC is determined by the arbiter. There is no need to control by lock.

  2. lock shared between tasks: when several tasks sharing the ADC2, we want to guarantee all the requests will be handled. Since conversions are short (about 31us), app returns the lock very soon, we use a spinlock to stand there waiting to do conversions one by one.

adc2_spinlock should be acquired first, then adc2_wifi_lock or rtc_spinlock.

  • In order to use ADC2 for other functions, we have to acquire complicated firmware locks and very difficult to do
  • So, it's not advisable to use ADC2 with WiFi/BlueTooth (BT/BLE).
  • Use ADC1, and pins GPIO32-GPIO39
  • If somehow it's a must to use those pins serviced by ADC2 (GPIO0, 2, 4, 12, 13, 14, 15, 25, 26 and 27), use the fix mentioned at the end of ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to work with ESP32 WiFi/BlueTooth (BT/BLE).


Important Notes

  1. Code is restructured to provide flexibility to make it easy to support many more WiFi/Ethernet modules/shields in the future. Please delete the *.cpp files, replaced by *.hpp files, in the src directory, if *.cpp files still exist after installing new version.

  2. For Adafruit nRF52, use the SPI's pin as follows:

  • SS/CS = 10
  • SPI_MOSI = MO(SI)
  • SPI_MISO = MI(SO)
  • SPI_SCK = SCK
  1. For Adafruit SAMD21/SAMD51, use the SPI's CS/SS pin as follows:
  • Itsy-Bitsy M0/M4, Feather M0 (Express), Hallowing M0 Express, Zero, Metro M0 => use CS = 16 = pin A2
  • Feather M4 (SAMD51) => use SS/CS = 9
  • Grand Central M4 => use SS/CS = 53
  • Hallowing M4 => use SS/CS = 10
  • Metro M4 AirLift => use SS/CS = 36

To know the default CS/SS pins of not listed boards, check the related variant.h files in

~/.arduino15/packages/adafruit/hardware/samd/x.y.zz/variants/board_name/variant.h

  1. For Arduino SAM DUE, use the SPI's pin as follows:



Examples

ESP32/ESP8266 Boards

  1. ESP_NTPClient_Advanced
  2. ESP_NTPClient_Basic
  3. ESP_WiFi_ETH_NTPClient_Advanced New

Generic Boards with Ethernet

  1. Ethernet_NTPClient_Advanced
  2. Ethernet_NTPClient_Basic
  3. RTC_Ethernet_NTPClient
  4. TZ_NTP_Clock_Ethernet
  5. TZ_NTP_WorldClock_Ethernet

STM32F/L/H/G/WB/MP1 Boards with Ethernet

  1. BI_RTC_Alarm_Ethernet_NTPClient_STM32
  2. BI_RTC_Ethernet_NTPClient_STM32
  3. Ethernet_NTPClient_Advanced_STM32
  4. Ethernet_NTPClient_Basic_STM32
  5. RTC_Ethernet_NTPClient_STM32
  6. TZ_NTP_Clock_STM32_Ethernet
  7. TZ_NTP_WorldClock_STM32_Ethernet

Generic Boards with WiFiNINA

  1. NINA_NTPClient_Advanced
  2. NINA_NTPClient_Basic
  3. NINA_TZ_NTP_Clock
  4. NINA_TZ_NTP_WorldClock

WT32_ETH01 Boards

  1. WT32_ETH01_NTPClient_Advanced
  2. WT32_ETH01_NTPClient_Basic
  3. WT32_ETH01_TZ_NTP_Clock
  4. WT32_ETH01_TZ_NTP_WorldClock
  5. WT32_WiFi_ETH01_NTPClient_Advanced New

RTL8720DN Boards

  1. RTL8720DN_NTPClient_Advanced
  2. RTL8720DN_NTPClient_Basic
  3. RTL8720DN_TZ_NTP_Clock
  4. RTL8720DN_TZ_NTP_WorldClock

Portenta_H7 Boards with WiFi

  1. Portenta_H7_NTPClient_Advanced
  2. Portenta_H7_NTPClient_Basic

Portenta_H7 Boards with Ethernet

  1. Portenta_H7_NTPClient_Advanced
  2. Portenta_H7_NTPClient_Basic

General

  1. multiFileProject New


#include "defines.h"
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include <Timezone_Generic.h> // https://github.com/khoih-prog/Timezone_Generic
#include <DS323x_Generic.h> // https://github.com/khoih-prog/DS323x_Generic
DS323x rtc;
//////////////////////////////////////////
// US Eastern Time Zone (New York, Detroit)
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;
TimeChangeRule *tcr; //pointer to the time change rule, use to get TZ abbrev
//////////////////////////////////////////
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
#include <NTPClient_Generic.h> // https://github.com/khoih-prog/NTPClient_Generic
// A UDP instance to let us send and receive packets over UDP
EthernetUDP ntpUDP;
// NTP server
//World
//char timeServer[] = "time.nist.gov";
// Canada
char timeServer[] = "0.ca.pool.ntp.org";
//char timeServer[] = "1.ca.pool.ntp.org";
//char timeServer[] = "2.ca.pool.ntp.org";
//char timeServer[] = "3.ca.pool.ntp.org";
// Europe
//char timeServer[] = ""europe.pool.ntp.org";
#define TIME_ZONE_OFFSET_HRS (-4)
#define NTP_UPDATE_INTERVAL_MS 60000L
// You can specify the time server pool and the offset (in seconds, can be
// changed later with setTimeOffset() ). Additionaly you can specify the
// update interval (in milliseconds, can be changed using setUpdateInterval() ).
NTPClient timeClient(ntpUDP, timeServer, (3600 * TIME_ZONE_OFFSET_HRS), NTP_UPDATE_INTERVAL_MS);
static bool gotCurrentTime = false;
// format and print a time_t value, with a time zone appended.
void printDateTime(time_t t, const char *tz)
{
char buf[32];
char m[4]; // temporary storage for month string (DateStrings.cpp uses shared buffer)
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 update_RTC(void)
{
// Just get the correct time once
if (timeClient.updated())
{
Serial.println("********UPDATED********");
rtc.now( DateTime(timeClient.getUTCEpochTime()) );
gotCurrentTime = true;
}
}
void displayRTC()
{
// Display time from RTC
DateTime now = rtc.now();
Serial.println("============================");
time_t utc = now.get_time_t();
time_t local = myTZ->toLocal(utc, &tcr);
printDateTime(utc, "UTC");
printDateTime(local, tcr -> abbrev);
}
void check_status(void)
{
// Update first time after 5s
static ulong checkstatus_timeout = 5000L;
static ulong RTCDisplay_timeout = 0;
static ulong current_millis;
// Display every 10s
#define RTC_DISPLAY_INTERVAL (10000L)
// Update RTC every hour if got correct time from NTP
#define RTC_UPDATE_INTERVAL (3600 * 1000L)
// Retry updating RTC every 5s if haven't got correct time from NTP
#define RTC_RETRY_INTERVAL (3 * 1000L)
current_millis = millis();
if ((current_millis > RTCDisplay_timeout) || (RTCDisplay_timeout == 0))
{
if (gotCurrentTime)
displayRTC();
RTCDisplay_timeout = current_millis + RTC_DISPLAY_INTERVAL;
}
// Update RTC every RTC_UPDATE_INTERVAL (3600) seconds.
if ((current_millis > checkstatus_timeout))
{
update_RTC();
if (gotCurrentTime)
{
Serial.println("RTC updated. Next update in seconds : " + String(RTC_UPDATE_INTERVAL/1000, DEC));
checkstatus_timeout = current_millis + RTC_UPDATE_INTERVAL;
}
else
{
Serial.println("Retry RTC update in seconds : " + String(RTC_RETRY_INTERVAL/1000, DEC));
checkstatus_timeout = current_millis + RTC_RETRY_INTERVAL;
}
}
}
//////////////////////////////////////////
void initEthernet()
{
#if USE_ETHERNET_PORTENTA_H7
ET_LOGWARN(F("======== USE_PORTENTA_H7_ETHERNET ========"));
#elif USE_NATIVE_ETHERNET
ET_LOGWARN(F("======== USE_NATIVE_ETHERNET ========"));
#elif USE_ETHERNET_GENERIC
ET_LOGWARN(F("=========== USE_ETHERNET_GENERIC ==========="));
#elif USE_ETHERNET_ESP8266
ET_LOGWARN(F("=========== USE_ETHERNET_ESP8266 ==========="));
#elif USE_ETHERNET_ENC
ET_LOGWARN(F("=========== USE_ETHERNET_ENC ==========="));
#else
ET_LOGWARN(F("========================="));
#endif
#if !(USE_NATIVE_ETHERNET || USE_ETHERNET_PORTENTA_H7)
#if (USING_SPI2)
#if defined(CUR_PIN_MISO)
ET_LOGWARN(F("Default SPI pinout:"));
ET_LOGWARN1(F("MOSI:"), CUR_PIN_MOSI);
ET_LOGWARN1(F("MISO:"), CUR_PIN_MISO);
ET_LOGWARN1(F("SCK:"), CUR_PIN_SCK);
ET_LOGWARN1(F("SS:"), CUR_PIN_SS);
ET_LOGWARN(F("========================="));
#endif
#else
ET_LOGWARN(F("Default SPI pinout:"));
ET_LOGWARN1(F("MOSI:"), MOSI);
ET_LOGWARN1(F("MISO:"), MISO);
ET_LOGWARN1(F("SCK:"), SCK);
ET_LOGWARN1(F("SS:"), SS);
ET_LOGWARN(F("========================="));
#endif
#if defined(ESP8266)
// For ESP8266, change for other boards if necessary
#ifndef USE_THIS_SS_PIN
#define USE_THIS_SS_PIN D2 // For ESP8266
#endif
ET_LOGWARN1(F("ESP8266 setCsPin:"), USE_THIS_SS_PIN);
#if ( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
// For ESP8266
// Pin D0(GPIO16) D1(GPIO5) D2(GPIO4) D3(GPIO0) D4(GPIO2) D8
// EthernetGeneric X X X X X 0
// Ethernet_ESP8266 0 0 0 0 0 0
// D2 is safe to used for Ethernet, Ethernet2, Ethernet3, EthernetLarge libs
// Must use library patch for Ethernet, EthernetLarge libraries
Ethernet.init (USE_THIS_SS_PIN);
#elif USE_CUSTOM_ETHERNET
// You have to add initialization for your Custom Ethernet here
// This is just an example to setCSPin to USE_THIS_SS_PIN, and can be not correct and enough
Ethernet.init(USE_THIS_SS_PIN);
#endif //( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
#elif defined(ESP32)
// You can use Ethernet.init(pin) to configure the CS pin
//Ethernet.init(10); // Most Arduino shields
//Ethernet.init(5); // MKR ETH shield
//Ethernet.init(0); // Teensy 2.0
//Ethernet.init(20); // Teensy++ 2.0
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
#ifndef USE_THIS_SS_PIN
#define USE_THIS_SS_PIN 5 //22 // For ESP32
#endif
ET_LOGWARN1(F("ESP32 setCsPin:"), USE_THIS_SS_PIN);
// For other boards, to change if necessary
#if ( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
// Must use library patch for Ethernet, EthernetLarge libraries
// ESP32 => GPIO2,4,5,13,15,21,22 OK with Ethernet, Ethernet2, EthernetLarge
// ESP32 => GPIO2,4,5,15,21,22 OK with Ethernet3
//Ethernet.setCsPin (USE_THIS_SS_PIN);
Ethernet.init (USE_THIS_SS_PIN);
#elif USE_CUSTOM_ETHERNET
// You have to add initialization for your Custom Ethernet here
// This is just an example to setCSPin to USE_THIS_SS_PIN, and can be not correct and enough
Ethernet.init(USE_THIS_SS_PIN);
#endif //( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
#elif ETHERNET_USE_RPIPICO
pinMode(USE_THIS_SS_PIN, OUTPUT);
digitalWrite(USE_THIS_SS_PIN, HIGH);
// ETHERNET_USE_RPIPICO, use default SS = 5 or 17
#ifndef USE_THIS_SS_PIN
#if defined(ARDUINO_ARCH_MBED)
#define USE_THIS_SS_PIN 5 // For Arduino Mbed core
#else
#define USE_THIS_SS_PIN 17 // For E.Philhower core
#endif
#endif
ET_LOGWARN1(F("RPIPICO setCsPin:"), USE_THIS_SS_PIN);
// For other boards, to change if necessary
#if ( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
// Must use library patch for Ethernet, EthernetLarge libraries
// For RPI Pico using Arduino Mbed RP2040 core
// SCK: GPIO2, MOSI: GPIO3, MISO: GPIO4, SS/CS: GPIO5
// For RPI Pico using E. Philhower RP2040 core
// SCK: GPIO18, MOSI: GPIO19, MISO: GPIO16, SS/CS: GPIO17
// Default pin 5/17 to SS/CS
//Ethernet.setCsPin (USE_THIS_SS_PIN);
Ethernet.init (USE_THIS_SS_PIN);
#endif //( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
#else //defined(ESP8266)
// unknown board, do nothing, use default SS = 10
#ifndef USE_THIS_SS_PIN
#define USE_THIS_SS_PIN 10 // For other boards
#endif
#if defined(BOARD_NAME)
ET_LOGWARN3(F("Board :"), BOARD_NAME, F(", setCsPin:"), USE_THIS_SS_PIN);
#else
ET_LOGWARN1(F("Unknown board setCsPin:"), USE_THIS_SS_PIN);
#endif
// For other boards, to change if necessary
#if ( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC || USE_NATIVE_ETHERNET )
// Must use library patch for Ethernet, Ethernet2, EthernetLarge libraries
Ethernet.init (USE_THIS_SS_PIN);
#elif USE_CUSTOM_ETHERNET
// You have to add initialization for your Custom Ethernet here
// This is just an example to setCSPin to USE_THIS_SS_PIN, and can be not correct and enough
Ethernet.init(USE_THIS_SS_PIN);
#endif //( USE_ETHERNET_GENERIC || USE_ETHERNET_ENC )
#endif // defined(ESP8266)
#endif // #if !(USE_NATIVE_ETHERNET)
// start the ethernet connection and the server:
// Use DHCP dynamic IP and random mac
uint16_t index = millis() % NUMBER_OF_MAC;
// Use Static IP
//Ethernet.begin(mac[index], ip);
Ethernet.begin(mac[index]);
#if !(USE_NATIVE_ETHERNET || USE_ETHERNET_PORTENTA_H7)
ET_LOGWARN(F("========================="));
#if defined( ESP32 )
// Just info to know how to connect correctly
// To change for other SPI
ET_LOGWARN(F("Currently Used SPI pinout:"));
ET_LOGWARN1(F("MOSI:"), PIN_MOSI);
ET_LOGWARN1(F("MISO:"), PIN_MISO);
ET_LOGWARN1(F("SCK:"), PIN_SCK);
ET_LOGWARN1(F("SS:"), PIN_SS);
#else
#if defined(CUR_PIN_MISO)
ET_LOGWARN(F("Currently Used SPI pinout:"));
ET_LOGWARN1(F("MOSI:"), CUR_PIN_MOSI);
ET_LOGWARN1(F("MISO:"), CUR_PIN_MISO);
ET_LOGWARN1(F("SCK:"), CUR_PIN_SCK);
ET_LOGWARN1(F("SS:"), CUR_PIN_SS);
#else
ET_LOGWARN(F("Currently Used SPI pinout:"));
ET_LOGWARN1(F("MOSI:"), MOSI);
ET_LOGWARN1(F("MISO:"), MISO);
ET_LOGWARN1(F("SCK:"), SCK);
ET_LOGWARN1(F("SS:"), SS);
#endif
#endif
ET_LOGWARN(F("========================="));
#elif (USE_ETHERNET_PORTENTA_H7)
if (Ethernet.hardwareStatus() == EthernetNoHardware)
{
Serial.println("No Ethernet found. Stay here forever");
while (true)
{
delay(1); // do nothing, no point running without Ethernet hardware
}
}
if (Ethernet.linkStatus() == LinkOFF)
{
Serial.println("Not connected Ethernet cable");
}
#endif
Serial.print(F("Using mac index = "));
Serial.println(index);
Serial.print(F("Connected! IP address: "));
Serial.println(Ethernet.localIP());
}
void setup()
{
Serial.begin(115200);
while (!Serial && millis() < 5000);
Serial.print("\nStarting RTC_Ethernet_NTPClient on "); Serial.print(BOARD_NAME);
Serial.print(" with "); Serial.println(SHIELD_TYPE);
Serial.println(ETHERNET_WEBSERVER_VERSION);
Serial.println(NTPCLIENT_GENERIC_VERSION);
Wire.begin();
initEthernet();
myTZ = new Timezone(myDST, mySTD);
timeClient.begin();
rtc.attach(Wire);
}
void loop()
{
timeClient.update();
check_status();
}


2. File defines.h

#pragma once
#ifndef defines_h
#define defines_h
#define DEBUG_ETHERNET_WEBSERVER_PORT Serial
// Debug Level from 0 to 4
#define _ETHERNET_WEBSERVER_LOGLEVEL_ 3
#define _NTP_LOGLEVEL_ 0
#define USING_SPI2 false //true
#if ( defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4) )
#if defined(BOARD_NAME)
#undef BOARD_NAME
#endif
#if defined(CORE_CM7)
#warning Using Portenta H7 M7 core
#define BOARD_NAME "PORTENTA_H7_M7"
#else
#warning Using Portenta H7 M4 core
#define BOARD_NAME "PORTENTA_H7_M4"
#endif
#define ETHERNET_USE_PORTENTA_H7 true
#define USE_ETHERNET_PORTENTA_H7 true
#endif
#if ( defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_SAMD_MKR1000) || defined(ARDUINO_SAMD_MKRWIFI1010) \
|| defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_SAMD_MKRFox1200) || defined(ARDUINO_SAMD_MKRWAN1300) || defined(ARDUINO_SAMD_MKRWAN1310) \
|| defined(ARDUINO_SAMD_MKRGSM1400) || defined(ARDUINO_SAMD_MKRNB1500) || defined(ARDUINO_SAMD_MKRVIDOR4000) || defined(__SAMD21G18A__) \
|| defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS) || defined(__SAMD21E18A__) || defined(__SAMD51__) || defined(__SAMD51J20A__) || defined(__SAMD51J19A__) \
|| defined(__SAMD51G19A__) || defined(__SAMD51P19A__) || defined(__SAMD21G18A__) )
#if defined(ETHERNET_USE_SAMD)
#undef ETHERNET_USE_SAMD
#endif
#define ETHERNET_USE_SAMD true
#endif
#if ( defined(NRF52840_FEATHER) || defined(NRF52832_FEATHER) || defined(NRF52_SERIES) || defined(ARDUINO_NRF52_ADAFRUIT) || \
defined(NRF52840_FEATHER_SENSE) || defined(NRF52840_ITSYBITSY) || defined(NRF52840_CIRCUITPLAY) || defined(NRF52840_CLUE) || \
defined(NRF52840_METRO) || defined(NRF52840_PCA10056) || defined(PARTICLE_XENON) || defined(NINA_B302_ublox) || defined(NINA_B112_ublox) )
#if defined(ETHERNET_USE_NRF528XX)
#undef ETHERNET_USE_NRF528XX
#endif
#define ETHERNET_USE_NRF528XX true
#endif
#if ( defined(ARDUINO_SAM_DUE) || defined(__SAM3X8E__) )
#if defined(ETHERNET_USE_SAM_DUE)
#undef ETHERNET_USE_SAM_DUE
#endif
#define ETHERNET_USE_SAM_DUE true
#endif
#if ( defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_RASPBERRY_PI_PICO) || defined(ARDUINO_ADAFRUIT_FEATHER_RP2040) || defined(ARDUINO_GENERIC_RP2040) )
#if defined(ETHERNET_USE_RPIPICO)
#undef ETHERNET_USE_RPIPICO
#endif
#define ETHERNET_USE_RPIPICO true
#endif
#if defined(ETHERNET_USE_SAMD)
// For SAMD
// Default pin 10 to SS/CS
#define USE_THIS_SS_PIN 10
#if ( defined(ARDUINO_SAMD_ZERO) && !defined(SEEED_XIAO_M0) )
#define BOARD_TYPE "SAMD Zero"
#elif defined(ARDUINO_SAMD_MKR1000)
#define BOARD_TYPE "SAMD MKR1000"
#elif defined(ARDUINO_SAMD_MKRWIFI1010)
#define BOARD_TYPE "SAMD MKRWIFI1010"
#elif defined(ARDUINO_SAMD_NANO_33_IOT)
#define BOARD_TYPE "SAMD NANO_33_IOT"
#elif defined(ARDUINO_SAMD_MKRFox1200)
#define BOARD_TYPE "SAMD MKRFox1200"
#elif ( defined(ARDUINO_SAMD_MKRWAN1300) || defined(ARDUINO_SAMD_MKRWAN1310) )
#define BOARD_TYPE "SAMD MKRWAN13X0"
#elif defined(ARDUINO_SAMD_MKRGSM1400)
#define BOARD_TYPE "SAMD MKRGSM1400"
#elif defined(ARDUINO_SAMD_MKRNB1500)
#define BOARD_TYPE "SAMD MKRNB1500"
#elif defined(ARDUINO_SAMD_MKRVIDOR4000)
#define BOARD_TYPE "SAMD MKRVIDOR4000"
#elif defined(ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS)
#define BOARD_TYPE "SAMD ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS"
#elif defined(ADAFRUIT_FEATHER_M0_EXPRESS)
#define BOARD_TYPE "SAMD21 ADAFRUIT_FEATHER_M0_EXPRESS"
#elif defined(ADAFRUIT_METRO_M0_EXPRESS)
#define BOARD_TYPE "SAMD21 ADAFRUIT_METRO_M0_EXPRESS"
#elif defined(ADAFRUIT_CIRCUITPLAYGROUND_M0)
#define BOARD_TYPE "SAMD21 ADAFRUIT_CIRCUITPLAYGROUND_M0"
#elif defined(ADAFRUIT_GEMMA_M0)
#define BOARD_TYPE "SAMD21 ADAFRUIT_GEMMA_M0"
#elif defined(ADAFRUIT_TRINKET_M0)
#define BOARD_TYPE "SAMD21 ADAFRUIT_TRINKET_M0"
#elif defined(ADAFRUIT_ITSYBITSY_M0)
#define BOARD_TYPE "SAMD21 ADAFRUIT_ITSYBITSY_M0"
#elif defined(ARDUINO_SAMD_HALLOWING_M0)
#define BOARD_TYPE "SAMD21 ARDUINO_SAMD_HALLOWING_M0"
#elif defined(ADAFRUIT_METRO_M4_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_METRO_M4_EXPRESS"
#elif defined(ADAFRUIT_GRAND_CENTRAL_M4)
#define BOARD_TYPE "SAMD51 ADAFRUIT_GRAND_CENTRAL_M4"
#elif defined(ADAFRUIT_FEATHER_M4_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_FEATHER_M4_EXPRESS"
#elif defined(ADAFRUIT_ITSYBITSY_M4_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_ITSYBITSY_M4_EXPRESS"
#define USE_THIS_SS_PIN 10
#elif defined(ADAFRUIT_TRELLIS_M4_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_TRELLIS_M4_EXPRESS"
#elif defined(ADAFRUIT_PYPORTAL)
#define BOARD_TYPE "SAMD51 ADAFRUIT_PYPORTAL"
#elif defined(ADAFRUIT_PYPORTAL_M4_TITANO)
#define BOARD_TYPE "SAMD51 ADAFRUIT_PYPORTAL_M4_TITANO"
#elif defined(ADAFRUIT_PYBADGE_M4_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_PYBADGE_M4_EXPRESS"
#elif defined(ADAFRUIT_METRO_M4_AIRLIFT_LITE)
#define BOARD_TYPE "SAMD51 ADAFRUIT_METRO_M4_AIRLIFT_LITE"
#elif defined(ADAFRUIT_PYGAMER_M4_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_PYGAMER_M4_EXPRESS"
#elif defined(ADAFRUIT_PYGAMER_ADVANCE_M4_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_PYGAMER_ADVANCE_M4_EXPRESS"
#elif defined(ADAFRUIT_PYBADGE_AIRLIFT_M4)
#define BOARD_TYPE "SAMD51 ADAFRUIT_PYBADGE_AIRLIFT_M4"
#elif defined(ADAFRUIT_MONSTER_M4SK_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_MONSTER_M4SK_EXPRESS"
#elif defined(ADAFRUIT_HALLOWING_M4_EXPRESS)
#define BOARD_TYPE "SAMD51 ADAFRUIT_HALLOWING_M4_EXPRESS"
#elif defined(SEEED_WIO_TERMINAL)
#define BOARD_TYPE "SAMD SEEED_WIO_TERMINAL"
#elif defined(SEEED_FEMTO_M0)
#define BOARD_TYPE "SAMD SEEED_FEMTO_M0"
#elif defined(SEEED_XIAO_M0)
#define BOARD_TYPE "SAMD SEEED_XIAO_M0"
#ifdef USE_THIS_SS_PIN
#undef USE_THIS_SS_PIN
#endif
#define USE_THIS_SS_PIN A1
#warning define SEEED_XIAO_M0 USE_THIS_SS_PIN == A1
#elif defined(Wio_Lite_MG126)
#define BOARD_TYPE "SAMD SEEED Wio_Lite_MG126"
#elif defined(WIO_GPS_BOARD)
#define BOARD_TYPE "SAMD SEEED WIO_GPS_BOARD"
#elif defined(SEEEDUINO_ZERO)
#define BOARD_TYPE "SAMD SEEEDUINO_ZERO"
#elif defined(SEEEDUINO_LORAWAN)
#define BOARD_TYPE "SAMD SEEEDUINO_LORAWAN"
#elif defined(SEEED_GROVE_UI_WIRELESS)
#define BOARD_TYPE "SAMD SEEED_GROVE_UI_WIRELESS"
#elif defined(__SAMD21E18A__)
#define BOARD_TYPE "SAMD21E18A"
#elif defined(__SAMD21G18A__)
#define BOARD_TYPE "SAMD21G18A"
#elif defined(__SAMD51G19A__)
#define BOARD_TYPE "SAMD51G19A"
#elif defined(__SAMD51J19A__)
#define BOARD_TYPE "SAMD51J19A"
#elif defined(__SAMD51J20A__)
#define BOARD_TYPE "SAMD51J20A"
#elif defined(__SAM3X8E__)
#define BOARD_TYPE "SAM3X8E"
#elif defined(__CPU_ARC__)
#define BOARD_TYPE "CPU_ARC"
#elif defined(__SAMD51__)
#define BOARD_TYPE "SAMD51"
#else
#define BOARD_TYPE "SAMD Unknown"
#endif
#elif (ETHERNET_USE_SAM_DUE)
// Default pin 10 to SS/CS
#define USE_THIS_SS_PIN 10
#define BOARD_TYPE "SAM DUE"
#elif (ETHERNET_USE_NRF528XX)
// Default pin 10 to SS/CS
#define USE_THIS_SS_PIN 10
#if defined(NRF52840_FEATHER)
#define BOARD_TYPE "NRF52840_FEATHER"
#elif defined(NRF52832_FEATHER)
#define BOARD_TYPE "NRF52832_FEATHER"
#elif defined(NRF52840_FEATHER_SENSE)
#define BOARD_TYPE "NRF52840_FEATHER_SENSE"
#elif defined(NRF52840_ITSYBITSY)
#define BOARD_TYPE "NRF52840_ITSYBITSY"
#define USE_THIS_SS_PIN 10 // For other boards
#elif defined(NRF52840_CIRCUITPLAY)
#define BOARD_TYPE "NRF52840_CIRCUITPLAY"
#elif defined(NRF52840_CLUE)
#define BOARD_TYPE "NRF52840_CLUE"
#elif defined(NRF52840_METRO)
#define BOARD_TYPE "NRF52840_METRO"
#elif defined(NRF52840_PCA10056)
#define BOARD_TYPE "NRF52840_PCA10056"
#elif defined(NINA_B302_ublox)
#define BOARD_TYPE "NINA_B302_ublox"
#elif defined(NINA_B112_ublox)
#define BOARD_TYPE "NINA_B112_ublox"
#elif defined(PARTICLE_XENON)
#define BOARD_TYPE "PARTICLE_XENON"
#elif defined(ARDUINO_NRF52_ADAFRUIT)
#define BOARD_TYPE "ARDUINO_NRF52_ADAFRUIT"
#else
#define BOARD_TYPE "nRF52 Unknown"
#endif
#elif ( defined(CORE_TEENSY) )
// Default pin 10 to SS/CS
#define USE_THIS_SS_PIN 10
#if defined(__IMXRT1062__)
// For Teensy 4.1/4.0
#if defined(ARDUINO_TEENSY41)
#define BOARD_TYPE "TEENSY 4.1"
// Use true for NativeEthernet Library, false if using other Ethernet libraries
#define USE_NATIVE_ETHERNET true
#elif defined(ARDUINO_TEENSY40)
#define BOARD_TYPE "TEENSY 4.0"
#else
#define BOARD_TYPE "TEENSY 4.x"
#endif
#elif defined(__MK66FX1M0__)
#define BOARD_TYPE "Teensy 3.6"
#elif defined(__MK64FX512__)
#define BOARD_TYPE "Teensy 3.5"
#elif defined(__MKL26Z64__)
#define BOARD_TYPE "Teensy LC"
#elif defined(__MK20DX256__)
#define BOARD_TYPE "Teensy 3.2" // and Teensy 3.1 (obsolete)
#elif defined(__MK20DX128__)
#define BOARD_TYPE "Teensy 3.0"
#elif defined(__AVR_AT90USB1286__)
#error Teensy 2.0++ not supported yet
#elif defined(__AVR_ATmega32U4__)
#error Teensy 2.0 not supported yet
#else
// For Other Boards
#define BOARD_TYPE "Unknown Teensy Board"
#endif
#elif ( defined(ESP8266) )
// For ESP8266
#warning Use ESP8266 architecture
#include <ESP8266mDNS.h>
#define ETHERNET_USE_ESP8266
#define BOARD_TYPE ARDUINO_BOARD
#elif ( defined(ESP32) )
// For ESP32
#warning Use ESP32 architecture
#define ETHERNET_USE_ESP32
#define BOARD_TYPE ARDUINO_BOARD
#define W5500_RST_PORT 21
#elif ETHERNET_USE_RPIPICO
// Default pin 5 (in Mbed) or 17 to SS/CS
#if defined(ARDUINO_ARCH_MBED)
// For RPI Pico using Arduino Mbed RP2040 core
// SCK: GPIO2, MOSI: GPIO3, MISO: GPIO4, SS/CS: GPIO5
#define USE_THIS_SS_PIN 17
#if defined(BOARD_NAME)
#undef BOARD_NAME
#endif
#if defined(ARDUINO_RASPBERRY_PI_PICO)
#define BOARD_TYPE "MBED RASPBERRY_PI_PICO"
#elif defined(ARDUINO_ADAFRUIT_FEATHER_RP2040)
#define BOARD_TYPE "MBED DAFRUIT_FEATHER_RP2040"
#elif defined(ARDUINO_GENERIC_RP2040)
#define BOARD_TYPE "MBED GENERIC_RP2040"
#else
#define BOARD_TYPE "MBED Unknown RP2040"
#endif
#else
// For RPI Pico using E. Philhower RP2040 core
#if (USING_SPI2)
// SCK: GPIO14, MOSI: GPIO15, MISO: GPIO12, SS/CS: GPIO13 for SPI1
#define USE_THIS_SS_PIN 13
#else
// SCK: GPIO18, MOSI: GPIO19, MISO: GPIO16, SS/CS: GPIO17 for SPI0
#define USE_THIS_SS_PIN 17
#endif
#endif
#define SS_PIN_DEFAULT USE_THIS_SS_PIN
// For RPI Pico
#warning Use RPI-Pico RP2040 architecture
#else
// For Mega
// Default pin 10 to SS/CS
#define USE_THIS_SS_PIN 10
// Reduce size for Mega
#define SENDCONTENT_P_BUFFER_SZ 512
#define BOARD_TYPE "AVR Mega"
#endif
#ifndef BOARD_NAME
#define BOARD_NAME BOARD_TYPE
#endif
#include <SPI.h>
// Use true for ENC28J60 and UIPEthernet library (https://github.com/UIPEthernet/UIPEthernet)
// Use false for W5x00 and Ethernetx library (https://www.arduino.cc/en/Reference/Ethernet)
//#define USE_UIP_ETHERNET true
#define USE_UIP_ETHERNET false
// Note: To rename ESP628266 Ethernet lib files to Ethernet_ESP8266.h and Ethernet_ESP8266.cpp
// In order to USE_ETHERNET_ESP8266
#if ( !defined(USE_UIP_ETHERNET) || !USE_UIP_ETHERNET )
// To override the default CS/SS pin. Don't use unless you know exactly which pin to use
// You can define here or customize for each board at same place with BOARD_TYPE
// Check @ defined(SEEED_XIAO_M0)
//#define USE_THIS_SS_PIN 22 //21 //5 //4 //2 //15
// Only one if the following to be true
#define USE_ETHERNET_GENERIC true
#define USE_ETHERNET_ESP8266 false
#define USE_ETHERNET_ENC false
#define USE_CUSTOM_ETHERNET false
////////////////////////////
#if ( USE_ETHERNET_GENERIC || USE_ETHERNET_ESP8266 || USE_ETHERNET_ENC || \
USE_NATIVE_ETHERNET || USE_ETHERNET_PORTENTA_H7 )
#ifdef USE_CUSTOM_ETHERNET
#undef USE_CUSTOM_ETHERNET
#endif
#define USE_CUSTOM_ETHERNET false
#endif
#if USE_ETHERNET_PORTENTA_H7
#include <Portenta_Ethernet.h>
#include <Ethernet.h>
#warning Using Portenta_Ethernet lib for Portenta_H7.
#define SHIELD_TYPE "Ethernet using Portenta_Ethernet Library"
#elif USE_NATIVE_ETHERNET
#include "NativeEthernet.h"
#warning Using NativeEthernet lib for Teensy 4.1. Must also use Teensy Packages Patch or error
#define SHIELD_TYPE "Custom Ethernet using Teensy 4.1 NativeEthernet Library"
#elif USE_ETHERNET_GENERIC
#if (ESP32)
#include <soc/spi_pins.h>
// Optional SPI2
//#define USING_SPI2 true
#if USING_SPI2
#define PIN_MISO HSPI_IOMUX_PIN_NUM_MISO
#define PIN_MOSI HSPI_IOMUX_PIN_NUM_MOSI
#define PIN_SCK HSPI_IOMUX_PIN_NUM_CLK
#define PIN_SS HSPI_IOMUX_PIN_NUM_CS
#define SHIELD_TYPE "W5x00 using Ethernet_Generic Library on SPI2"
#else
#define PIN_MISO MISO
#define PIN_MOSI MOSI
#define PIN_SCK SCK
#define PIN_SS SS
#define SHIELD_TYPE "W5x00 using Ethernet_Generic Library on SPI"
#endif
#else
#if USING_SPI2
#define SHIELD_TYPE "W5x00 using Ethernet_Generic Library on SPI1"
#else
#define SHIELD_TYPE "W5x00 using Ethernet_Generic Library on SPI0/SPI"
#endif
#endif
#define ETHERNET_LARGE_BUFFERS
#define _ETG_LOGLEVEL_ 1
#include "Ethernet_Generic.h"
#warning Using Ethernet_Generic lib
#elif USE_ETHERNET_ESP8266
#include "Ethernet_ESP8266.h"
#warning Using Ethernet_ESP8266 lib
#define SHIELD_TYPE "W5x00 using Ethernet_ESP8266 Library"
#elif USE_ETHERNET_ENC
#include "EthernetENC.h"
#warning Using EthernetENC lib
#define SHIELD_TYPE "ENC28J60 using EthernetENC Library"
#elif USE_CUSTOM_ETHERNET
//#include "Ethernet_XYZ.h"
#include "EthernetENC.h"
#warning Using Custom Ethernet library. You must include a library and initialize.
#define SHIELD_TYPE "Custom Ethernet using Ethernet_XYZ Library"
#else
#ifdef USE_ETHERNET_GENERIC
#undef USE_ETHERNET_GENERIC
#endif
#define USE_ETHERNET_GENERIC true
#include "Ethernet_Generic.h"
#warning Using default Ethernet_Generic lib
#define SHIELD_TYPE "W5x00 using default Ethernet_Generic Library"
#endif
// Ethernet_Shield_W5200, EtherCard, EtherSia not supported
// Select just 1 of the following #include if uncomment #define USE_CUSTOM_ETHERNET
// Otherwise, standard Ethernet library will be used for W5x00
////////////////////////////
#elif USE_UIP_ETHERNET
#include "UIPEthernet.h"
#warning Using UIPEthernet library
#define SHIELD_TYPE "ENC28J60 using UIPEthernet Library"
#endif // #if !USE_UIP_ETHERNET
#include <EthernetWebServer.h>
#ifndef SHIELD_TYPE
#define SHIELD_TYPE "Unknown Ethernet shield/library"
#endif
// Enter a MAC address and IP address for your controller below.
#define NUMBER_OF_MAC 20
byte mac[][NUMBER_OF_MAC] =
{
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x01 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x02 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x03 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x04 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x05 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x06 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x07 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x08 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x09 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0A },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0B },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0C },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0D },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0E },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0F },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x10 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x11 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x12 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x13 },
{ 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x14 },
};
// Select the IP address according to your local network
IPAddress ip(192, 168, 2, 222);
// Google DNS Server IP
IPAddress myDns(8, 8, 8, 8);
#endif //defines_h



Debug Terminal Output Samples

1. Ethernet_NTPClient_Advanced on Adafruit NRF52840_FEATHER_EXPRESS with ENC28J60 using EthernetENC Library

Following is the debug terminal output when running example Ethernet_NTPClient_Advanced on Adafruit NRF52840_FEATHER_EXPRESS with ENC28J60 using EthernetENC Library

Starting Ethernet_NTPClient_Advanced on NRF52840_FEATHER with ENC28J60 using EthernetENC Library
NTPClient_Generic v3.7.5
[EWS] =========================
[EWS] Default SPI pinout:
[EWS] MOSI: 25
[EWS] MISO: 24
[EWS] SCK: 26
[EWS] SS: 5
[EWS] =========================
[EWS] Board : NRF52840_FEATHER , setCsPin: 10
=========================
Currently Used SPI pinout:
MOSI:25
MISO:24
SCK:26
SS:5
=========================
Using mac index = 3
You're connected to the network, IP = 192.168.2.79
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

2. NINA_NTPClient_Advanced on Arduino SAMD21 SAMD_NANO_33_IOT with WiFiNINA using WiFiNINA_Generic Library

Following is the debug terminal output when running example NINA_NTPClient_Advanced on Arduino SAMD21 SAMD_NANO_33_IOT with WiFiNINA using WiFiNINA_Generic Library

Starting NINA_NTPClient_Advanced on SAMD_NANO_33_IOT with WiFiNINA using WiFiNINA_Generic Library
NTPClient_Generic v3.7.5
Connecting to: HueNet1

NTPClient_Advanced started @ IP address: 192.168.2.98
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

3. TZ_NTP_WorldClock_Ethernet on Adafruit NRF52840_FEATHER_EXPRESS with W5500 using Ethernet_Generic Library

Following is the debug terminal output when running example TZ_NTP_WorldClock_Ethernet on Adafruit NRF52840_FEATHER_EXPRESS with W5500 using Ethernet_Generic Library

Start TZ_NTP_WorldClock_Ethernet on NRF52840_FEATHER with W5x00 using Ethernet_Generic Library
NTPClient_Generic v3.7.5
[EWS] =========== USE_ETHERNET_GENERIC ===========
[EWS] Default SPI pinout:
[EWS] MOSI: 25
[EWS] MISO: 24
[EWS] SCK: 26
[EWS] SS: 5
[EWS] =========================
[EWS] Board : NRF52840_FEATHER , setCsPin: 10
=========================
Currently Used SPI pinout:
MOSI:25
MISO:24
SCK:26
SS:5
=========================
Using mac index = 17
You're connected to the network, IP = 192.168.2.80
********UPDATED********
Time updated. Next update in seconds : 3600

04:05:18 Sun 10 Apr 2022 AEST Sydney
21:05:18 Sat 09 Apr 2022 MSK  Moscow
20:05:18 Sat 09 Apr 2022 CEST Paris
19:05:18 Sat 09 Apr 2022 BST  London
18:05:18 Sat 09 Apr 2022 UTC  Universal Coordinated Time
14:05:18 Sat 09 Apr 2022 EDT  New York
13:05:18 Sat 09 Apr 2022 CDT  Chicago
12:05:18 Sat 09 Apr 2022 MDT  Denver
11:05:18 Sat 09 Apr 2022 MST  Phoenix
11:05:18 Sat 09 Apr 2022 PDT  Los Angeles

4. TZ_NTP_WorldClock_STM32_Ethernet on STM32F7 Nucleo-144 NUCLEO_F767ZI with LAN8742A using STM32Ethernet Library

Following is the debug terminal output when running example TZ_NTP_WorldClock_STM32_Ethernet on STM32F7 Nucleo-144 NUCLEO_F767ZI with LAN8742A using STM32Ethernet Library

Start TZ_NTP_WorldClock_STM32_Ethernet on NUCLEO_F767ZI, using LAN8742A Ethernet & STM32Ethernet Library
EthernetWebServer_STM32 v1.5.0
NTPClient_Generic v3.7.5
You're connected to the network, IP = 192.168.2.96
Retry Time update in seconds : 3
********UPDATED********
Time updated. Next update in seconds : 3600

04:05:18 Sun 10 Apr 2022 AEST Sydney
21:05:18 Sat 09 Apr 2022 MSK  Moscow
20:05:18 Sat 09 Apr 2022 CEST Paris
19:05:18 Sat 09 Apr 2022 BST  London
18:05:18 Sat 09 Apr 2022 UTC  Universal Coordinated Time
14:05:18 Sat 09 Apr 2022 EDT  New York
13:05:18 Sat 09 Apr 2022 CDT  Chicago
12:05:18 Sat 09 Apr 2022 MDT  Denver
11:05:18 Sat 09 Apr 2022 MST  Phoenix
11:05:18 Sat 09 Apr 2022 PDT  Los Angeles

5. RTC_Ethernet_NTPClient on Adafruit NRF52840_FEATHER_EXPRESS with ENC28J60 using EthernetENC Library

Following is the debug terminal output when running example RTC_Ethernet_NTPClient on Adafruit NRF52840_FEATHER_EXPRESS with ENC28J60 using EthernetENC Library

Start RTC_Ethernet_NTPClient on NRF52840_FEATHER with ENC28J60 using EthernetENC Library
NTPClient_Generic v3.7.5
[EWS] =========================
[EWS] Default SPI pinout:
[EWS] MOSI: 25
[EWS] MISO: 24
[EWS] SCK: 26
[EWS] SS: 5
[EWS] =========================
[EWS] Board : NRF52840_FEATHER , setCsPin: 10
=========================
Currently Used SPI pinout:
MOSI:25
MISO:24
SCK:26
SS:5
=========================
Using mac index = 0
You're connected to the network, IP = 192.168.2.94
============================
18:15:32 Sat 09 Apr 2022 UTC
14:15:32 Sat 09 Apr 2022 EDT
********UPDATED********
RTC updated. Next update in seconds : 3600
============================
18:15:41 Sat 09 Apr 2022 UTC
14:15:41 Sat 09 Apr 2022 EDT
============================
18:15:50 Sat 09 Apr 2022 UTC
14:15:50 Sat 09 Apr 2022 EDT
============================

6. RTC_Ethernet_NTPClient_STM32 on STM32F7 Nucleo-144 NUCLEO_F767ZI with LAN8742A using STM32Ethernet Library

Following is the debug terminal output when running example RTC_Ethernet_NTPClient_STM32 on STM32F7 Nucleo-144 NUCLEO_F767ZI with LAN8742A using STM32Ethernet Library

Start RTC_Ethernet_NTPClient_STM32 on NUCLEO_F767ZI, using LAN8742A Ethernet & STM32Ethernet Library
EthernetWebServer_STM32 v1.5.0
NTPClient_Generic v3.7.5
You're connected to the network, IP = 192.168.2.105
Retry RTC update in seconds : 3
********UPDATED********
RTC updated. Next update in seconds : 3600
============================
22:17:23 Wed 27 Apr 2022 UTC
18:17:23 Wed 27 Apr 2022 EDT
============================
22:17:33 Wed 27 Apr 2022 UTC
18:17:33 Wed 27 Apr 2022 EDT

7. ESP_NTPClient_Advanced on ESP8266_NODEMCU_ESP12E

Following is the debug terminal output when running example ESP_NTPClient_Advanced on ESP8266_NODEMCU_ESP12E.

Starting ESP_NTPClient_Advanced on ESP8266_NODEMCU_ESP12E
NTPClient_Generic v3.7.5
Connecting to: HueNet1
....
ESP_NTPClient_Advanced started @ IP address: 192.168.2.69
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

8. ESP_NTPClient_Advanced on ESP32_DEV

Following is the debug terminal output when running example ESP_NTPClient_Advanced on ESP32_DEV.

Starting ESP_NTPClient_Advanced on ESP32_DEV
NTPClient_Generic v3.7.5
Connecting to: HueNet1
....
ESP_NTPClient_Advanced started @ IP address: 192.168.2.101
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

9. Ethernet_NTPClient_Advanced on SAM DUE with W5100 using Ethernet_Generic Library

Following is the debug terminal output when running example Ethernet_NTPClient_Advanced on SAM DUE with W5100 using Ethernet_Generic Library

Starting Ethernet_NTPClient_Advanced on SAM DUE with W5x00 using Ethernet_Generic Library
NTPClient_Generic v3.7.5
[EWS] =========== USE_ETHERNET_GENERIC ===========
[EWS] Default SPI pinout:
[EWS] MOSI: 75
[EWS] MISO: 74
[EWS] SCK: 76
[EWS] SS: 10
[EWS] =========================
[EWS] Board : SAM DUE , setCsPin: 10
_pinCS = 0
W5100 init, using SS_PIN_DEFAULT = 10, new ss_pin = 10, W5100Class::ss_pin = 10
W5100::init: W5100, SSIZE =4096
=========================
Currently Used SPI pinout:
MOSI:75
MISO:74
SCK:76
SS:10
=========================
Using mac index = 6
You're connected to the network, IP = 192.168.2.71
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

10. BI_RTC_Ethernet_NTPClient_STM32 on STM32F7 Nucleo-144 NUCLEO_F767ZI with LAN8742A using STM32Ethernet Library

Following is the debug terminal output when running example BI_RTC_Ethernet_NTPClient_STM32 on STM32F7 Nucleo-144 NUCLEO_F767ZI with LAN8742A using STM32Ethernet Library to demonstrate the usage of STM32 built-in RTC

Start BI_RTC_Ethernet_NTPClient_STM32 on NUCLEO_F767ZI, using LAN8742A Ethernet & STM32Ethernet Library
EthernetWebServer_STM32 v1.5.0
NTPClient_Generic v3.7.5
You're connected to the network, IP = 192.168.2.96
Retry RTC update in seconds : 3

Updating Time for STM32 RTC
********UPDATED********
RTC updated. Next update in seconds : 3600
============================
18:15:41 Sat 09 Apr 2022 UTC
14:15:41 Sat 09 Apr 2022 EDT
============================
18:15:50 Sat 09 Apr 2022 UTC
14:15:50 Sat 09 Apr 2022 EDT

11. BI_RTC_Ethernet_NTPClient_STM32 on STM32F7 Nucleo-144 NUCLEO_F767ZI with ENC28J60 using EthernetENC Library

Following is the debug terminal output when running example BI_RTC_Ethernet_NTPClient_STM32 on STM32F7 Nucleo-144 NUCLEO_F767ZI with ENC28J60 using EthernetENC Library to demonstrate the usage of STM32 built-in RTC

Start BI_RTC_Ethernet_NTPClient_STM32 on NUCLEO_F767ZI, using ENC28J60 & EthernetENC Library
NTPClient_Generic v3.7.5
[EWS] Board : NUCLEO_F767ZI , setCsPin: 10
[EWS] Default SPI pinout:
[EWS] MOSI: 11
[EWS] MISO: 12
[EWS] SCK: 13
[EWS] SS: 10
[EWS] =========================
BYou're connected to the network, IP = 192.168.2.97

Updating Time for STM32 RTC
********UPDATED********
RTC updated. Next update in seconds : 3600
============================
22:18:43 Wed 27 Apr 2022 UTC
18:18:43 Wed 27 Apr 2022 EDT
============================
22:18:53 Wed 27 Apr 2022 UTC
18:18:53 Wed 27 Apr 2022 EDT

12. BI_RTC_Alarm_Ethernet_NTPClient_STM32 on STM32F7 Nucleo-144 NUCLEO_F767ZI with LAN8742A using STM32Ethernet Library

Following is the debug terminal output when running example BI_RTC_Alarm_Ethernet_NTPClient_STM32 on STM32F7 Nucleo-144 NUCLEO_F767ZI with LAN8742A using STM32Ethernet Library to demonstrate the usage of STM32 built-in RTC Alarm function

Start BI_RTC_Alarm_Ethernet_NTPClient_STM32 on NUCLEO_F767ZI with LAN8742A Ethernet & STM32Ethernet Library
EthernetWebServer_STM32 v1.5.0
NTPClient_Generic v3.7.5
You're connected to the network, IP = 192.168.2.88
Retry RTC update in seconds : 3

Updating Time for STM32 RTC
********UPDATED********
=======RTC ALARM SET========
18:13:52 Sat 09 Apr 2022 UTC
14:13:52 Sat 09 Apr 2022 EDT
============================
RTC updated. Next update in seconds : 3600
============================
18:13:28 Sat 09 Apr 2022 UTC
14:13:28 Sat 09 Apr 2022 EDT
============================
18:13:37 Sat 09 Apr 2022 UTC
14:13:37 Sat 09 Apr 2022 EDT
============================
18:13:47 Sat 09 Apr 2022 UTC
14:13:47 Sat 09 Apr 2022 EDT
*****RTC ALARM ACTIVATED*****
*****RTC ALARM ACTIVATED*****
============================
18:13:56 Sat 09 Apr 2022 UTC
14:13:56 Sat 09 Apr 2022 EDT
============================
18:14:05 Sat 09 Apr 2022 UTC
14:14:05 Sat 09 Apr 2022 EDT

13. NINA_NTPClient_Basic on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic Library

Following is the debug terminal output when running example NINA_NTPClient_Basic on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic Library

Starting NINA_NTPClient_Basic on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic Library
NTPClient_Generic v3.7.5
Connecting to: HueNet1

NINA_NTPClient_Basic started @ IP address: 192.168.2.153
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

14. Ethernet_NTPClient_Advanced on RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library

Following is the debug terminal output when running example Ethernet_NTPClient_Advanced on RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library

Starting Ethernet_NTPClient_Advanced on RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library
NTPClient_Generic v3.7.5
[EWS] =========== USE_ETHERNET_GENERIC ===========
[EWS] Default SPI pinout:
[EWS] MOSI: 19
[EWS] MISO: 16
[EWS] SCK: 18
[EWS] SS: 17
[EWS] =========================
[EWS] RPIPICO setCsPin: 17
=========================
Currently Used SPI pinout:
MOSI:19
MISO:16
SCK:18
SS:17
========
=========================
Using mac index = 10
You're connected to the network, IP = 192.168.2.94
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

15. Ethernet_NTPClient_Advanced on MBED RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library

Following is the debug terminal output when running example Ethernet_NTPClient_Advanced on MBED RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library

Starting Ethernet_NTPClient_Advanced on MBED RASPBERRY_PI_PICO with W5x00 using Ethernet_Generic Library
NTPClient_Generic v3.7.5
[EWS] =========== USE_ETHERNET_GENERIC ===========
[EWS] Default SPI pinout:
[EWS] MOSI: 19
[EWS] MISO: 16
[EWS] SCK: 18
[EWS] SS: 17
[EWS] =========================
[EWS] RPIPICO setCsPin: 17
=========================
Currently Used SPI pinout:
MOSI:19
MISO:16
SCK:18
SS:17
=========================
Using mac index = 5
You're connected to the network, IP = 192.168.2.123
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

16. NINA_TZ_NTP_WorldClock on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic Library

Following is the debug terminal output when running example NINA_TZ_NTP_WorldClock on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic Library

Starting NINA_TZ_NTP_WorldClock on MBED NANO_RP2040_CONNECT with WiFiNINA using WiFiNINA_Generic Library
NTPClient_Generic v3.7.5
Connecting to WPA SSID: HueNet1
You're connected to the network, IP = 192.168.2.153
********UPDATED********
Time updated. Next update in seconds : 3600

04:05:18 Sun 10 Apr 2022 AEST Sydney
21:05:18 Sat 09 Apr 2022 MSK  Moscow
20:05:18 Sat 09 Apr 2022 CEST Paris
19:05:18 Sat 09 Apr 2022 BST  London
18:05:18 Sat 09 Apr 2022 UTC  Universal Coordinated Time
14:05:18 Sat 09 Apr 2022 EDT  New York
13:05:18 Sat 09 Apr 2022 CDT  Chicago
12:05:18 Sat 09 Apr 2022 MDT  Denver
11:05:18 Sat 09 Apr 2022 MST  Phoenix
11:05:18 Sat 09 Apr 2022 PDT  Los Angeles

17. WT32_ETH01_TZ_NTP_WorldClock on ESP32_DEV with ETH_PHY_LAN8720

Following is the debug terminal output when running example WT32_ETH01_TZ_NTP_WorldClock on ESP32_DEV with ETH_PHY_LAN8720

Starting WT32_ETH01_TZ_NTP_WorldClock on ESP32_DEV with ETH_PHY_LAN8720
WebServer_WT32_ETH01 v1.5.1
NTPClient_Generic v3.7.5
ETH MAC: A8:03:2A:A1:61:73, IPv4: 192.168.2.232
FULL_DUPLEX, 100Mbps
WT32_ETH01_TZ_NTP_WorldClock started @ IP address: 192.168.2.232
********UPDATED********
Time updated. Next update in seconds : 3600

04:05:18 Sun 10 Apr 2022 AEST Sydney
21:05:18 Sat 09 Apr 2022 MSK  Moscow
20:05:18 Sat 09 Apr 2022 CEST Paris
19:05:18 Sat 09 Apr 2022 BST  London
18:05:18 Sat 09 Apr 2022 UTC  Universal Coordinated Time
14:05:18 Sat 09 Apr 2022 EDT  New York
13:05:18 Sat 09 Apr 2022 CDT  Chicago
12:05:18 Sat 09 Apr 2022 MDT  Denver
11:05:18 Sat 09 Apr 2022 MST  Phoenix
11:05:18 Sat 09 Apr 2022 PDT  Los Angeles

18. WT32_ETH01_NTPClient_Advanced on ESP32_DEV with ETH_PHY_LAN8720

Following is the debug terminal output when running example WT32_ETH01_NTPClient_Advanced on ESP32_DEV with ETH_PHY_LAN8720

Starting WT32_ETH01_NTPClient_Advanced on ESP32_DEV with ETH_PHY_LAN8720
WebServer_WT32_ETH01 v1.5.1
NTPClient_Generic v3.7.5
ETH MAC: A8:03:2A:A1:61:73, IPv4: 192.168.2.232
FULL_DUPLEX, 100Mbps
WT32_ETH01_NTPClient_Advanced started @ IP address: 192.168.2.232
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

19. RTL8720DN_TZ_NTP_WorldClock on Rtlduino RTL8720DN

Following is the debug terminal output when running example RTL8720DN_TZ_NTP_WorldClock on Rtlduino RTL8720DN

Starting RTL8720DN_TZ_NTP_WorldClock on Rtlduino RTL8720DN
WiFiWebServer_RTL8720 v1.1.1
NTPClient_Generic v3.7.5
Current Firmware Version = 1.0.0
Attempting to connect to SSID: HueNet_5G
TZ_NTP_Clock_RTL8720DN started @ IP address: 192.168.2.111
Retry Time update in seconds : 3
********UPDATED********
Time updated. Next update in seconds : 3600

04:05:18 Sun 10 Apr 2022 AEST Sydney
21:05:18 Sat 09 Apr 2022 MSK  Moscow
20:05:18 Sat 09 Apr 2022 CEST Paris
19:05:18 Sat 09 Apr 2022 BST  London
18:05:18 Sat 09 Apr 2022 UTC  Universal Coordinated Time
14:05:18 Sat 09 Apr 2022 EDT  New York
13:05:18 Sat 09 Apr 2022 CDT  Chicago
12:05:18 Sat 09 Apr 2022 MDT  Denver
11:05:18 Sat 09 Apr 2022 MST  Phoenix
11:05:18 Sat 09 Apr 2022 PDT  Los Angeles

20. Portenta_H7_NTPClient_Advanced on PORTENTA_H7_M7 with WiFi

Following is the debug terminal output when running example Portenta_H7_NTPClient_Advanced on on PORTENTA_H7_M7 with Murata WiFi

Starting Portenta_H7_NTPClient_Advanced on PORTENTA_H7_M7
NTPClient_Generic v3.7.5
Connecting to: HueNet1
Portenta_H7_NTPClient_Advanced started @ IP address: 192.168.2.104
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

21. Portenta_H7_NTPClient_Advanced on PORTENTA_H7_M7 with Ethernet

Following is the debug terminal output when running example Portenta_H7_NTPClient_Advanced on on PORTENTA_H7_M7 with Vision-shield Ethernet

Starting Portenta_H7_NTPClient_Advanced using Ethernet on PORTENTA_H7_M7
NTPClient_Generic v3.7.5
Portenta_H7_NTPClient_Basic started @ IP address: 192.168.2.111
Using NTP Server 0.ca.pool.ntp.org
******NOT UPDATED******
UTC : 00:00:01
UTC :  0: 0: 1 Thu  1 Jan 1970
LOC : 02:28:17
LOC :  2:28:17 Sun  7 Feb 2106
UTC EPOCH : 1
LOC EPOCH : 4294952897
UTC : 0:0:1 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:01 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:17 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:17 Sun 7/2/2106 or 7 Feb 2106
********UPDATED********
UTC : 17:51:56
UTC : 17:51:56 Sat  9 Apr 2022
LOC : 13:51:56
LOC : 13:51:56 Sat  9 Apr 2022
UTC EPOCH : 1649526716
LOC EPOCH : 1649512316
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
UTC : 17:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022
LOC : 13:51:56 Sat 9/4/2022 or 9 Apr 2022

22. ESP_WiFi_ETH_NTPClient_Advanced on ESP32_DEV with W5x00 using Ethernet_Generic Library

Following is the debug terminal output when running example ESP_WiFi_ETH_NTPClient_Advanced on ESP32_DEV with W5x00 using Ethernet_Generic Library to demonstrate how to to use the new setUDP() function for auto-switching between WiFi and Ethernet UDP to update NTP time.

Starting ESP_WiFi_ETH_NTPClient_Advanced on ESP32_DEV with W5x00 using Ethernet_Generic Library
EthernetWebServer v2.2.3
NTPClient_Generic v3.7.5
Connecting to: HueNet1
...................
WiFi failed to connect      <=====  Start without WiFi to use Ethernet UDP
.[EWS] =========== USE_ETHERNET_GENERIC ===========
[EWS] Default SPI pinout:
[EWS] MOSI: 23
[EWS] MISO: 19
[EWS] SCK: 18
[EWS] SS: 5
[EWS] =========================
[EWS] ESP32 setCsPin: 22
_pinCS = 0
W5100 init, using SS_PIN_DEFAULT = 22, new ss_pin = 10, W5100Class::ss_pin = 22
W5100::init: W5500, SSIZE =8192
=========================
Currently Used SPI pinout:
MOSI:23
MISO:19
SCK:18
CS/SS:22
=========================
Using mac index = 11
Connected! IP address: 192.168.2.125
Using NTP Server 0.ca.pool.ntp.org
****WIFI Status****
WiFi Failed
******NOT UPDATED******
UTC : 00:00:13
UTC :  0: 0:13 Thu  1 Jan 1970
LOC : 02:28:29
LOC :  2:28:29 Sun  7 Feb 2106
UTC EPOCH : 13
LOC EPOCH : 4294952909
UTC : 0:0:13 Thu 1/1/1970 or 1 Jan 1970
UTC : 00:00:13 Thu 1/1/1970 or 1 Jan 1970
LOC : 2:28:29 Sun 7/2/2106 or 7 Feb 2106
LOC : 02:28:29 Sun 7/2/2106 or 7 Feb 2106
****WIFI Status****
WiFi Failed
********UPDATED********       <=====  Updated using Ethernet UDP
UTC : 04:14:00
UTC :  4:14: 0 Thu 24 Feb 2022
LOC : 00:14:00
LOC :  0:14: 0 Thu 24 Feb 2022
UTC EPOCH : 1645676040
LOC EPOCH : 1645661640
UTC : 4:14:0 Thu 24/2/2022 or 24 Feb 2022
UTC : 04:14:00 Thu 24/2/2022 or 24 Feb 2022
LOC : 0:14:0 Thu 24/2/2022 or 24 Feb 2022
LOC : 00:14:00 Thu 24/2/2022 or 24 Feb 2022
****WIFI Status****
WiFi Failed
****WIFI Status****
WiFi Failed
****WIFI Status****
WiFi Failed
****WIFI Status****
WiFi Failed
****WIFI Status****
WiFi Failed
********UPDATED********
UTC : 04:15:00
UTC :  4:15: 0 Thu 24 Feb 2022
LOC : 00:15:00
LOC :  0:15: 0 Thu 24 Feb 2022
UTC EPOCH : 1645676100
LOC EPOCH : 1645661700
UTC : 4:15:0 Thu 24/2/2022 or 24 Feb 2022
UTC : 04:15:00 Thu 24/2/2022 or 24 Feb 2022
LOC : 0:15:0 Thu 24/2/2022 or 24 Feb 2022
LOC : 00:15:00 Thu 24/2/2022 or 24 Feb 2022
****WIFI Status****
WiFi OK
NTP => WiFi          <=====  Switch back to use WiFi UDP as WiFi is OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
********UPDATED********    <=====  Updated using WiFi UDP
UTC : 04:16:00
UTC :  4:16: 0 Thu 24 Feb 2022
LOC : 00:16:00
LOC :  0:16: 0 Thu 24 Feb 2022
UTC EPOCH : 1645676160
LOC EPOCH : 1645661760
UTC : 4:16:0 Thu 24/2/2022 or 24 Feb 2022
UTC : 04:16:00 Thu 24/2/2022 or 24 Feb 2022
LOC : 0:16:0 Thu 24/2/2022 or 24 Feb 2022
LOC : 00:16:00 Thu 24/2/2022 or 24 Feb 2022
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
********UPDATED********
UTC : 04:16:10
UTC :  4:16:10 Thu 24 Feb 2022
LOC : 00:16:10
LOC :  0:16:10 Thu 24 Feb 2022
UTC EPOCH : 1645676170
LOC EPOCH : 1645661770
UTC : 4:16:10 Thu 24/2/2022 or 24 Feb 2022
UTC : 04:16:10 Thu 24/2/2022 or 24 Feb 2022
LOC : 0:16:10 Thu 24/2/2022 or 24 Feb 2022
LOC : 00:16:10 Thu 24/2/2022 or 24 Feb 2022
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
********UPDATED********
UTC : 04:17:10
UTC :  4:17:10 Thu 24 Feb 2022
LOC : 00:17:10
LOC :  0:17:10 Thu 24 Feb 2022
UTC EPOCH : 1645676230
LOC EPOCH : 1645661830
UTC : 4:17:10 Thu 24/2/2022 or 24 Feb 2022
UTC : 04:17:10 Thu 24/2/2022 or 24 Feb 2022
LOC : 0:17:10 Thu 24/2/2022 or 24 Feb 2022
LOC : 00:17:10 Thu 24/2/2022 or 24 Feb 2022
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK
********UPDATED********
UTC : 04:18:10
UTC :  4:18:10 Thu 24 Feb 2022
LOC : 00:18:10
LOC :  0:18:10 Thu 24 Feb 2022
UTC EPOCH : 1645676290
LOC EPOCH : 1645661890
UTC : 4:18:10 Thu 24/2/2022 or 24 Feb 2022
UTC : 04:18:10 Thu 24/2/2022 or 24 Feb 2022
LOC : 0:18:10 Thu 24/2/2022 or 24 Feb 2022
LOC : 00:18:10 Thu 24/2/2022 or 24 Feb 2022
****WIFI Status****
WiFi OK
****WIFI Status****
WiFi OK


Debug

Debug is enabled by default on Serial. To disable, add at the beginning of sketch

/* Comment this out to disable prints and save space */
#define NTP_DBG_PORT                Serial

// Debug Level from 0 to 4
#define _NTP_LOGLEVEL_              0

Troubleshooting

If you get compilation errors, more often than not, you may need to install a newer version of the board's core, dependent libraries or this library version.

Sometimes, the library will only work if you update the core to the newer or older version because some function compatibility.



Issues

Submit issues to: NTPClient_Generic issues



TO DO

  1. Bug Searching and Killing
  2. Add more examples

DONE

  1. Add support to Arduino SAMD21 (ZERO, MKR, NANO_33_IOT, etc.) and FlashStorage
  2. Add support to Adafruit SAMD21 (Itsy-Bitsy M0, Metro M0, Feather M0 Express, etc.) and FlashStorage.
  3. Add support to Adafruit SAMD51 (Itsy-Bitsy M4, Metro M4, Grand Central M4, Feather M4 Express, etc.) and FlashStorage.
  4. Add support to Adafruit nRF52 ( Feather nRF52832, nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, NINA_B302_ublox, NINA_B112_ublox, etc. and LittleFS.
  5. Add support to SAM DUE.
  6. Add support to Ethernet W5x00, using either Ethernet, Ethernet2, or EthernetLarge library
  7. Add support to Ethernet ENC28J60, using UIPEthernet library
  8. Add support to Seeeduino SAMD21/SAMD51: LoRaWAN, Zero, Femto M0, XIAO M0, Wio GPS Board, Wio Terminal, Grove UI Wireless and FlashStorage.
  9. Add support to EthernetENC
  10. Add support to AVR Mega, UNO, Nano.
  11. Add support to Arduino Nano_RP2040_Connect using Arduino mbed OS for Nano boards.
  12. Add support to RP2040-based boards, such as RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, using Earle Philhower's arduino-pico core.
  13. Add support to RP2040-based boards, such as RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, using Arduino-mbed RP2040 core
  14. Add Version String and Table-of-Contents
  15. Add support to WT32_ETH01 boards using ESP32-based boards and LAN8720 Ethernet
  16. Add support to RTL8720DN, RTL8722DM, RTL8722CSM, etc. boards
  17. Add support to Add support to Potenta_H7 using Murata WiFi of Vision-Shield Ethernet
  18. Fix multiple-definitions linker error.
  19. Fix getUTCEpochMillis() bug
  20. Add setUDP() function to enable auto-switching between WiFi and Ethernet UDP instances.
  21. Add new examples ESP_WiFi_ETH_NTPClient_Advanced and WT32_WiFi_ETH01_NTPClient_Advanced to use the new setUDP() function for auto-switching between WiFi and Ethernet UDP to update NTP time.
  22. Use Ethernet_Generic library as default for W5x00 Ethernet.
  23. Support SPI2 for ESP32
  24. Add support to SPI1 for RP2040 using arduino-pico core
  25. Add example multiFileProject to demo how to avoid multiple-definitions linker error for multiple-file project
  26. Sync with NTPClient releases v3.2.1
  27. Fix bug causing time jumping back or forth when network has problem


Contributions and Thanks

Many thanks for everyone for bug reporting, new feature suggesting, testing and contributing to the development of this library.

  1. Based on and modified from the Fabrice Weinberg's NTPClient Library.
  2. Thanks to good work of Miguel Alexandre Wisintainer for initiating, inspriring, working with, developing, debugging and testing.
  3. Thanks to bmcdonnell to make PR in Add packet validity checks #4 leading to v3.3.0
  4. Thanks to DavidSteinmann to report the getUTCEpochMillis() bug and propose the bug fix in getUTCEpochMillis() not returning correct value #7 leading to v3.7.1
  5. Thanks to argo9 to make PR in added setUDP function #8 leading to v3.7.2
  6. Thanks to iBuilderBY to report the bug with steps to duplicate in Time jumping back when connection is lost and forward when up #9 leading to v3.7.5
FWeinb
⭐️ Fabrice Weinberg

tcpipchip
Miguel Wisintainer

bmcdonnell
bmcdonnell

DavidSteinmann
DavidSteinmann

argo9
argo9

iBuilderBY
iBuilderBY


Contributing

If you want to contribute to this project:

  • Report bugs and errors
  • Ask for enhancements
  • Create issues and pull requests
  • Tell other people about this library

License

  • The library is licensed under MIT

Copyright

  • Copyright 2015- Fabrice Weinberg

  • Copyright 2020- Khoi Hoang

About

Library for NTPClient to connect to an NTP time-server. Get time from a NTP time-server and keep it in sync. For ESP8266/ESP32, nRF52, SAMD21/SAMD51, STM32F/L/H/G/WB/MP1, Teensy, etc. besides AVR, using ESP WiFi, WiFiNINA, Ethernet W5x00, ENC28J60, LAN8742A, ESP8266/ESP32 AT-command WiFi.

License:MIT License


Languages

Language:C++ 64.5%Language:C 35.2%Language:Shell 0.3%