Zoltan Hudak / NTPClient

NTP Client library to set local time using the Internet.

Dependents:   WebTimer DISCO-F746NG_light_control_system_tth

NTPClient.h@0:9282d46b9f92, 2020-11-11 (annotated)

Committer:
hudakz
Date:
Wed Nov 11 16:50:36 2020 +0000
Revision:
0:9282d46b9f92
NTP Client library to set local time using the Internet.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hudakz 0:9282d46b9f92 1 /* NTPClient.h */
hudakz 0:9282d46b9f92 2 /* Copyright (C) 2012 mbed.org, MIT License
hudakz 0:9282d46b9f92 3 *
hudakz 0:9282d46b9f92 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
hudakz 0:9282d46b9f92 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
hudakz 0:9282d46b9f92 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
hudakz 0:9282d46b9f92 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
hudakz 0:9282d46b9f92 8 * furnished to do so, subject to the following conditions:
hudakz 0:9282d46b9f92 9 *
hudakz 0:9282d46b9f92 10 * The above copyright notice and this permission notice shall be included in all copies or
hudakz 0:9282d46b9f92 11 * substantial portions of the Software.
hudakz 0:9282d46b9f92 12 *
hudakz 0:9282d46b9f92 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
hudakz 0:9282d46b9f92 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
hudakz 0:9282d46b9f92 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
hudakz 0:9282d46b9f92 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
hudakz 0:9282d46b9f92 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
hudakz 0:9282d46b9f92 18 */
hudakz 0:9282d46b9f92 19
hudakz 0:9282d46b9f92 20 /** \file
hudakz 0:9282d46b9f92 21 * NTP Client header file
hudakz 0:9282d46b9f92 22 */
hudakz 0:9282d46b9f92 23
hudakz 0:9282d46b9f92 24 #ifndef NTPCLIENT_H_
hudakz 0:9282d46b9f92 25 #define NTPCLIENT_H_
hudakz 0:9282d46b9f92 26
hudakz 0:9282d46b9f92 27 #include <stdint.h>
hudakz 0:9282d46b9f92 28 #include "UDPSocket.h"
hudakz 0:9282d46b9f92 29 #include "NetworkInterface.h"
hudakz 0:9282d46b9f92 30
hudakz 0:9282d46b9f92 31 #define NTP_DEFAULT_PORT 123
hudakz 0:9282d46b9f92 32 #define NTP_DEFAULT_TIMEOUT 4000
hudakz 0:9282d46b9f92 33
hudakz 0:9282d46b9f92 34 ///NTP client results
hudakz 0:9282d46b9f92 35 enum NTPResult
hudakz 0:9282d46b9f92 36 {
hudakz 0:9282d46b9f92 37 NTP_DNS, ///<Could not resolve name
hudakz 0:9282d46b9f92 38 NTP_PRTCL, ///<Protocol error
hudakz 0:9282d46b9f92 39 NTP_TIMEOUT, ///<Connection timeout
hudakz 0:9282d46b9f92 40 NTP_CONN, ///<Connection error
hudakz 0:9282d46b9f92 41 NTP_OK = 0, ///<Success
hudakz 0:9282d46b9f92 42 };
hudakz 0:9282d46b9f92 43
hudakz 0:9282d46b9f92 44 /** NTP Client to update the mbed's RTC using a remote time server
hudakz 0:9282d46b9f92 45 *
hudakz 0:9282d46b9f92 46 */
hudakz 0:9282d46b9f92 47 class NTPClient
hudakz 0:9282d46b9f92 48 {
hudakz 0:9282d46b9f92 49 public:
hudakz 0:9282d46b9f92 50 /**
hudakz 0:9282d46b9f92 51 * Instantiate the NTP client
hudakz 0:9282d46b9f92 52 */
hudakz 0:9282d46b9f92 53 NTPClient(NetworkInterface & _m_intf);
hudakz 0:9282d46b9f92 54
hudakz 0:9282d46b9f92 55 /**Get current time (blocking)
hudakz 0:9282d46b9f92 56 Update the time using the server host
hudakz 0:9282d46b9f92 57 Blocks until completion
hudakz 0:9282d46b9f92 58 @param host NTP server IPv4 address or hostname (will be resolved via DNS)
hudakz 0:9282d46b9f92 59 @param port port to use; defaults to 123
hudakz 0:9282d46b9f92 60 @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
hudakz 0:9282d46b9f92 61 @return 0 on success, NTP error code (<0) on failure
hudakz 0:9282d46b9f92 62 */
hudakz 0:9282d46b9f92 63 NTPResult setTime(const char* host, uint16_t port = NTP_DEFAULT_PORT, uint32_t timeout = NTP_DEFAULT_TIMEOUT);
hudakz 0:9282d46b9f92 64
hudakz 0:9282d46b9f92 65 private:
hudakz 0:9282d46b9f92 66 struct NTPPacket //See RFC 4330 for Simple NTP
hudakz 0:9282d46b9f92 67 {
hudakz 0:9282d46b9f92 68 //WARN: We are in Little Endian! Network is Big Endian!
hudakz 0:9282d46b9f92 69 //LSb first
hudakz 0:9282d46b9f92 70 unsigned mode : 3;
hudakz 0:9282d46b9f92 71 unsigned vn : 3;
hudakz 0:9282d46b9f92 72 unsigned li : 2;
hudakz 0:9282d46b9f92 73
hudakz 0:9282d46b9f92 74 uint8_t stratum;
hudakz 0:9282d46b9f92 75 uint8_t poll;
hudakz 0:9282d46b9f92 76 uint8_t precision;
hudakz 0:9282d46b9f92 77 //32 bits header
hudakz 0:9282d46b9f92 78
hudakz 0:9282d46b9f92 79 uint32_t rootDelay;
hudakz 0:9282d46b9f92 80 uint32_t rootDispersion;
hudakz 0:9282d46b9f92 81 uint32_t refId;
hudakz 0:9282d46b9f92 82
hudakz 0:9282d46b9f92 83 uint32_t refTm_s;
hudakz 0:9282d46b9f92 84 uint32_t refTm_f;
hudakz 0:9282d46b9f92 85 uint32_t origTm_s;
hudakz 0:9282d46b9f92 86 uint32_t origTm_f;
hudakz 0:9282d46b9f92 87 uint32_t rxTm_s;
hudakz 0:9282d46b9f92 88 uint32_t rxTm_f;
hudakz 0:9282d46b9f92 89 uint32_t txTm_s;
hudakz 0:9282d46b9f92 90 uint32_t txTm_f;
hudakz 0:9282d46b9f92 91 } __attribute__ ((packed));
hudakz 0:9282d46b9f92 92
hudakz 0:9282d46b9f92 93 NetworkInterface & m_intf;
hudakz 0:9282d46b9f92 94 UDPSocket m_sock;
hudakz 0:9282d46b9f92 95 };
hudakz 0:9282d46b9f92 96
hudakz 0:9282d46b9f92 97 #endif /* NTPCLIENT_H_ */