Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for the functions #122

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,24 @@ void loop() {
```

## Function documentation
`getEpochTime` returns the unix epoch, which are the seconds elapsed since 00:00:00 UTC on 1 January 1970 (leap seconds are ignored, every day is treated as having 86400 seconds). **Attention**: If you have set a time offset this time offset will be added to your epoch timestamp.

#### Constructor: NTPClient(UDP& udp, const char* poolServerName, long timeOffset, unsigned long updateInterval)
- `udp` : WiFiUDP object.
- `poolSeverName` (optional): NTP Server Name. Use the nearest server to your loaction. The server list can be found [here](https://www.ntppool.org/en/). The default is pool.ntp.org (global).
- `timeOffset` (optional): Time offset with GMT for your location in seconds. The deafut is 0.
- `updateInterval` (optional): Refresh Interval im milliseconds. Default is 60000 millisecond or 1 minute.

#### getEpochTime()
Returns the unix epoch, which are the seconds elapsed since 00:00:00 UTC on 1 January 1970 (leap seconds are ignored, every day is treated as having 86400 seconds). **Attention**: If you have set a time offset this time offset will be added to your epoch timestamp.

#### getFormattedTime()
Returns the formatted current time string in hh:mm:ss format.

#### getHours()
Returns the current "hour" in 24 hour format (0-23).

#### getMinutes()
Returns the current "minute" integer.

#### getSeconds()
Returns the current "second" integer.