44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
# SNTP Module
|
|
| Since | Origin / Contributor | Maintainer | Source |
|
|
| :----- | :-------------------- | :---------- | :------ |
|
|
| 2015-06-30 | [DiUS](https://github.com/DiUS), [Johny Mattsson](https://github.com/jmattsson) | [Johny Mattsson](https://github.com/jmattsson) | [sntp.c](../../../app/modules/sntp.c)|
|
|
|
|
The SNTP module implements a [Simple Network Time Procotol](https://en.wikipedia.org/wiki/Network_Time_Protocol#SNTP) client. This includes support for the "anycast" [NTP](https://en.wikipedia.org/wiki/Network_Time_Protocol) mode where, if supported by the NTP server(s) in your network, it is not necessary to even know the IP address of the NTP server.
|
|
|
|
When compiled together with the [rtctime](rtctime.md) module it also offers seamless integration with it, potentially reducing the process of obtaining NTP synchronization to a simple `sntp.sync()` call without any arguments.
|
|
|
|
|
|
## sntp.sync()
|
|
|
|
Attempts to obtain time synchronization.
|
|
|
|
#### Syntax
|
|
`sntp.sync([server_ip], [callback], [errcallback])`
|
|
|
|
#### Parameters
|
|
- `server_ip` if non-`nil`, that server is used. If `nil`, then the last contacted server is used. This ties in with the NTP anycast mode, where the first responding server is remembered for future synchronization requests. The easiest way to use anycast is to always pass nil for the server argument.
|
|
- `callback` Iif provided it will be invoked on a successful synchronization, with three parameters: seconds, microseconds, and server. Note that when the [rtctime](rtctime.md) module is available, there is no need to explicitly call [`rtctime.set()`](rtctime.md#rtctimeset) - this module takes care of doing so internally automatically, for best accuracy.
|
|
- `errcallback` failure callback with no parameters. The module automatically performs a number of retries before giving up and reporting the error.
|
|
|
|
#### Returns
|
|
`nil`
|
|
|
|
#### Example
|
|
```lua
|
|
-- Best effort, use the last known NTP server (or the NTP "anycast" address 224.0.1.1 initially)
|
|
sntp.sync()
|
|
```
|
|
```lua
|
|
-- Sync time with 192.168.0.1 and print the result, or that it failed
|
|
sntp.sync('192.168.0.1',
|
|
function(sec,usec,server)
|
|
print('sync', sec, usec, server)
|
|
end,
|
|
function()
|
|
print('failed!')
|
|
end
|
|
)
|
|
```
|
|
#### See also
|
|
[`rtctime.set()`](rtctime.md#rtctimeset)
|