https://github.com/aharshac/easyntpclient
Library to read time from Network Time Protocol (NTP) servers.
https://github.com/aharshac/easyntpclient
arduino arduino-library embedded esp8266 esp8266-arduino espressif iot nodemcu nodemcu-arduino ntp ntp-client ntp-library ntp-parser
Last synced: 8 months ago
JSON representation
Library to read time from Network Time Protocol (NTP) servers.
- Host: GitHub
- URL: https://github.com/aharshac/easyntpclient
- Owner: aharshac
- License: mit
- Created: 2017-06-29T08:58:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-04-07T12:16:19.000Z (over 4 years ago)
- Last Synced: 2025-04-01T11:50:37.874Z (8 months ago)
- Topics: arduino, arduino-library, embedded, esp8266, esp8266-arduino, espressif, iot, nodemcu, nodemcu-arduino, ntp, ntp-client, ntp-library, ntp-parser
- Language: C++
- Size: 11.7 KB
- Stars: 25
- Watchers: 3
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EasyNTPClient
[](https://www.collaborizm.com/)
[](https://travis-ci.org/aharshac/EasyNTPClient)
Arduino library to read time from Network Time Protocol (NTP) servers.
## Features
- Handles all heavy lifting involved with managing connections to and parsing time from an NTP server.
- As easy as providing a **UDP** object to the constructor during initialization.
- Works on **Arduino** and **ESP8266**.
## Examples
1. **NodeMCU**
Using EasyNTPClient on a NodeMCU (ESP8266)
2. **ArduinoEspWifiShield**
Using EasyNTPClient on an Arduino UNO with an ESP-01 (ESP8266) WiFi module.
By [**Claran Martis**](https://www.collaborizm.com/profile/SJne7FcMg)
## Reference
### Class **EasyNTPClient**
#### 1. Initialization ####
1. No frills
```c
EasyNTPClient(UDP &udp)
Parameters:
udp: Reference to an UDP object.
Returns:
EasyNTPClient object.
```
2. Custom server pool
```c
EasyNTPClient(UDP& udp, const char* serverPool)
Parameters:
udp: Reference to an UDP object.
serverPool: NTP server pool. Default = "pool.ntp.org"
Returns:
EasyNTPClient object.
```
3. Time offset
```c
EasyNTPClient(UDP& udp, const char* serverPool, int offset);
Parameters:
udp: Reference to an UDP object.
serverPool: NTP server pool domain name. Default = "pool.ntp.org"
offset: Difference from UTC in seconds. Default = 0
Returns:
EasyNTPClient object.
```
#### 2. Methods ###
1. Get time offset
```c
int getTimeOffset()
Returns:
EasyNTPClient object.
```
2. Set time offset
```c
void setTimeOffset(int offset);
Parameters:
offset: Difference from UTC in seconds.
```
3. Get time in UNIX format
```c
unsigned long getUnixTime();
Returns:
UTC time in UNIX time format (seconds)
```