https://github.com/sigmdel/gnats
GNAT'S Nearly Accurate Time Server
https://github.com/sigmdel/gnats
esp32-arduino gps ntp-server
Last synced: 8 months ago
JSON representation
GNAT'S Nearly Accurate Time Server
- Host: GitHub
- URL: https://github.com/sigmdel/gnats
- Owner: sigmdel
- License: 0bsd
- Created: 2023-06-13T04:12:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T22:59:23.000Z (almost 3 years ago)
- Last Synced: 2024-12-23T03:20:21.679Z (over 1 year ago)
- Topics: esp32-arduino, gps, ntp-server
- Language: C++
- Homepage: https://sigmdel.ca/michel/program/esp32/arduino/esp32_gps_time_server_en.html
- Size: 332 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# GNAT'S Nearly Accurate Time Server
*A tiny and very basic NTP server based on a GPS receiver.
Runs on the SeeedStudio XIAO ESP32C3 or XIAO ESP32S3*
## Changes
2023-08-03: Added the `ethernet-test` branch in which an ENC28J60 based Ethernet module is used to connect to the local area network instead of Wi-Fi.
2023-07-19: Added optional support for a DS3231 battery powered real time clock. The RTC is not a backup time source; it is only used to set the initial time until the correct time is acquired by the GPS receiver.
## Hardware used
- ESP32 development board such as XIAO ESP32C3 or XIAO ESP32S3
- GPS receiver supported by TinyGPSPlus such as the ATGM336H 5N-31
- DS3231 battery backed real time clock (optional)
- SSD1306 128x64 I2C OLED display (optional)
- [Shematic](img/schematic.jpg)
## Libraries
- [TinyGPSPlus](https://github.com/mikalhart/TinyGPSPlus.git) by Mikal Hart at [Arduiniana](http://arduiniana.org). The library reads the $GNRMC NMEA messages from the GPS receiver and makes available the date and time data, among many other bits of information. Licence: unknown.
- [ntp_server](lib/ntp_server/ntp_server.h) is a modified version of the NTP server (`ntp_server.h` and `ntp_server.cpp`) in the ElektorLabs [180662 mini NTP with ESP32](https://github.com/ElektorLabs/180662-mini-NTP-ESP32). There is a project description in the ElektorMag [mini-NTP server with GPS](https://www.elektormagazine.com/labs/mini-ntp-server-with-gps). Licence: GPLv3 or later at user choice.
- [OLED SSD1306 (ESP8266/ESP32/Mbed-OS)](https://github.com/ThingPulse/esp8266-oled-ssd1306)
by ThingPulse is used to print the date and time on a small OLED screen. Licence: MIT.
- [Rtc](https://github.com/Makuna/Rtc) by Michael Miller (Makuna) is used to read a battery-powered DS3231 real time clock which will provide the initial time to set the ESP real time clock until GPS time is available. Licence: LGPLv3
- [smalldebug](lib/smalldebug.h) just defines two macros: DBG(...) and DBG(...). These are used throughout the code instead of Serial.println(...) and Serial.printf(...). The advantage of using these macros is that all the print statements will be stripped from the compiled firmware when the ENABLE_DBG macro is set to 0. Licence: None.
## Further documentation
[GNATS, a Tiny Basic ESP32 GPS Based NTP Server](https://sigmdel.ca/michel/program/esp32/arduino/esp32_gps_time_server_en.html)
[Using a Local Network Time Server](https://sigmdel.ca/michel/program/esp32/arduino/local_timeserver_en.html)
## Warning
GNATS should not be used as the primary time source. However, it is accurate enough as a backup time source when access to better clocks is lost.
## Note
Edit [secrets.h.template](src/secrets.h.template) and save it as `secrets.h` in the `src` directory before compiling the firmware.
## Licence
The **BSD Zero Clause** ([SPDX](https://spdx.dev/): [0BSD](https://spdx.org/licenses/0BSD.html)) licence applies to all source not covered by another licence.