| commit | author | age | ||
| d6b4a7 | 1 | ## coreSNTP Library |
| G | 2 | |
| 3 | This repository contains the coreSNTP library, a client library to use Simple Network Time Protocol (SNTP) to synchronize device clocks with internet time. This library implements the SNTPv4 specification defined in [RFC 4330](https://tools.ietf.org/html/rfc4330). | |
| 4 | ||
| 5 | An SNTP client can request time from both NTP and SNTP servers. According to the SNTPv4 specification, "_To an NTP or SNTP server, NTP and SNTP clients are indistinguishable; to an NTP or SNTP client, NTP and SNTP servers are indistinguishable._", thereby, allowing SNTP clients to request time from NTP servers. | |
| 6 | ||
| 7 | **coreSNTP v1.2.0 [source code](https://github.com/FreeRTOS/coreSNTP/tree/v1.2.0/source) is part of the [FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) release.** | |
| 8 | ||
| 9 | ## Documentation | |
| 10 | ||
| 11 | The API reference documentation for the coreSNTP library version released in [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS) can be viewed from the [freertos.org website](https://freertos.org/coresntp/index.html). | |
| 12 | ||
| 13 | ## Cloning this repository | |
| 14 | This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components. | |
| 15 | ||
| 16 | To clone using HTTPS: | |
| 17 | ``` | |
| 18 | git clone https://github.com/FreeRTOS/coreSNTP.git --recurse-submodules | |
| 19 | ``` | |
| 20 | Using SSH: | |
| 21 | ``` | |
| 22 | git clone git@github.com:FreeRTOS/coreSNTP.git --recurse-submodules | |
| 23 | ``` | |
| 24 | ||
| 25 | If you have downloaded the repo without using the `--recurse-submodules` argument, you need to run: | |
| 26 | ``` | |
| 27 | git submodule update --init --recursive | |
| 28 | ``` | |
