Chronos . / NTPClient

Forked to make it work with mbed-os 5.3

Dependents:   NTPClient_example mbed_vfd_ntp

Fork of NTPClient by Donatien Garnier

NTPClient.cpp@5:175284afeb38, 2017-01-06 (annotated)

Committer:
lmussier
Date:
Fri Jan 06 13:45:37 2017 +0000
Revision:
5:175284afeb38
Parent:
4:881559865a93 
Adapt for mbed-os 5.3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:04a82df0f587 1 /* NTPClient.cpp */
donatien 2:9a64a50df235 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 2:9a64a50df235 3 *
donatien 2:9a64a50df235 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 2:9a64a50df235 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 2:9a64a50df235 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 2:9a64a50df235 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 2:9a64a50df235 8 * furnished to do so, subject to the following conditions:
donatien 2:9a64a50df235 9 *
donatien 2:9a64a50df235 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 2:9a64a50df235 11 * substantial portions of the Software.
donatien 2:9a64a50df235 12 *
donatien 2:9a64a50df235 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 2:9a64a50df235 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 2:9a64a50df235 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 2:9a64a50df235 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 2:9a64a50df235 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 2:9a64a50df235 18 */
donatien 0:04a82df0f587 19
donatien 2:9a64a50df235 20 //Debug is disabled by default
lmussier 5:175284afeb38 21 #if 1
donatien 2:9a64a50df235 22 //Enable debug
donatien 2:9a64a50df235 23 #define __DEBUG__
donatien 2:9a64a50df235 24 #include <cstdio>
donatien 2:9a64a50df235 25 #define DBG(x, ...) std::printf("[NTPClient : DBG]"x"\r\n", ##__VA_ARGS__);
donatien 2:9a64a50df235 26 #define WARN(x, ...) std::printf("[NTPClient : WARN]"x"\r\n", ##__VA_ARGS__);
donatien 2:9a64a50df235 27 #define ERR(x, ...) std::printf("[NTPClient : ERR]"x"\r\n", ##__VA_ARGS__);
donatien 0:04a82df0f587 28
donatien 2:9a64a50df235 29 #else
donatien 2:9a64a50df235 30 //Disable debug
donatien 2:9a64a50df235 31 #define DBG(x, ...)
donatien 2:9a64a50df235 32 #define WARN(x, ...)
donatien 2:9a64a50df235 33 #define ERR(x, ...)
donatien 2:9a64a50df235 34
donatien 0:04a82df0f587 35 #endif
donatien 0:04a82df0f587 36
donatien 0:04a82df0f587 37 #include "NTPClient.h"
donatien 0:04a82df0f587 38
donatien 1:b221a8765b3f 39 #include "UDPSocket.h"
donatien 1:b221a8765b3f 40
donatien 0:04a82df0f587 41 #include "mbed.h" //time() and set_time()
lmussier 5:175284afeb38 42 #include "def.h"
donatien 0:04a82df0f587 43 #define NTP_PORT 123
donatien 0:04a82df0f587 44 #define NTP_CLIENT_PORT 0 //Random port
donatien 0:04a82df0f587 45 #define NTP_TIMESTAMP_DELTA 2208988800ull //Diff btw a UNIX timestamp (Starting Jan, 1st 1970) and a NTP timestamp (Starting Jan, 1st 1900)
donatien 0:04a82df0f587 46
lmussier 5:175284afeb38 47 NTPClient::NTPClient(NetworkInterface& p_networkInterface) : m_sock(), m_net(p_networkInterface) {
donatien 0:04a82df0f587 48 }
donatien 0:04a82df0f587 49
donatien 2:9a64a50df235 50 NTPResult NTPClient::setTime(const char* host, uint16_t port, uint32_t timeout)
donatien 0:04a82df0f587 51 {
donatien 2:9a64a50df235 52 #ifdef __DEBUG__
donatien 0:04a82df0f587 53 time_t ctTime;
donatien 0:04a82df0f587 54 ctTime = time(NULL);
donatien 2:9a64a50df235 55 DBG("Time is set to (UTC): %s", ctime(&ctTime));
donatien 0:04a82df0f587 56 #endif
donatien 0:04a82df0f587 57
lmussier 5:175284afeb38 58 if( m_sock.open(&m_net) != 0){ DBG("Open"); return NTP_CONN;}
lmussier 5:175284afeb38 59
donatien 1:b221a8765b3f 60 //Create & bind socket
donatien 2:9a64a50df235 61 DBG("Binding socket");
lmussier 5:175284afeb38 62 if( m_sock.bind(99) != 0){ DBG("Bind"); return NTP_CONN;}
donatien 0:04a82df0f587 63
donatien 0:04a82df0f587 64 struct NTPPacket pkt;
donatien 0:04a82df0f587 65
donatien 0:04a82df0f587 66 //Now ping the server and wait for response
donatien 0:04a82df0f587 67 DBG("Ping");
donatien 0:04a82df0f587 68 //Prepare NTP Packet:
donatien 0:04a82df0f587 69 pkt.li = 0; //Leap Indicator : No warning
donatien 0:04a82df0f587 70 pkt.vn = 4; //Version Number : 4
donatien 0:04a82df0f587 71 pkt.mode = 3; //Client mode
donatien 0:04a82df0f587 72 pkt.stratum = 0; //Not relevant here
donatien 0:04a82df0f587 73 pkt.poll = 0; //Not significant as well
donatien 0:04a82df0f587 74 pkt.precision = 0; //Neither this one is
donatien 0:04a82df0f587 75
donatien 0:04a82df0f587 76 pkt.rootDelay = 0; //Or this one
donatien 0:04a82df0f587 77 pkt.rootDispersion = 0; //Or that one
donatien 0:04a82df0f587 78 pkt.refId = 0; //...
donatien 0:04a82df0f587 79
donatien 0:04a82df0f587 80 pkt.refTm_s = 0;
donatien 0:04a82df0f587 81 pkt.origTm_s = 0;
donatien 0:04a82df0f587 82 pkt.rxTm_s = 0;
donatien 0:04a82df0f587 83 pkt.txTm_s = htonl( NTP_TIMESTAMP_DELTA + time(NULL) ); //WARN: We are in LE format, network byte order is BE
donatien 0:04a82df0f587 84
donatien 0:04a82df0f587 85 pkt.refTm_f = pkt.origTm_f = pkt.rxTm_f = pkt.txTm_f = 0;
donatien 0:04a82df0f587 86
lmussier 5:175284afeb38 87 SocketAddress outEndpoint (host, port);
lmussier 5:175284afeb38 88
donatien 0:04a82df0f587 89 //Set timeout, non-blocking and wait using select
lmussier 5:175284afeb38 90 int ret = m_sock.sendto(host, port, (char*)&pkt, sizeof(NTPPacket) );
donatien 2:9a64a50df235 91 if (ret < 0 )
donatien 0:04a82df0f587 92 {
lmussier 5:175284afeb38 93 ERR("Could not send packet (%d)", ret);
donatien 2:9a64a50df235 94 m_sock.close();
donatien 2:9a64a50df235 95 return NTP_CONN;
donatien 0:04a82df0f587 96 }
donatien 0:04a82df0f587 97
donatien 0:04a82df0f587 98 //Read response
lmussier 5:175284afeb38 99 SocketAddress inEndpoint;
donatien 2:9a64a50df235 100
donatien 0:04a82df0f587 101 DBG("Pong");
lmussier 5:175284afeb38 102 //do
lmussier 5:175284afeb38 103 //{
lmussier 5:175284afeb38 104 ret = m_sock.recvfrom( &inEndpoint, (char*)&pkt, sizeof(NTPPacket) ); //FIXME need a DNS Resolver to actually compare the incoming address with the DNS name
donatien 0:04a82df0f587 105 if(ret < 0)
donatien 0:04a82df0f587 106 {
lmussier 5:175284afeb38 107 ERR("Could not receive packet (%d)", ret);
donatien 2:9a64a50df235 108 m_sock.close();
donatien 2:9a64a50df235 109 return NTP_CONN;
donatien 0:04a82df0f587 110 }
lmussier 5:175284afeb38 111 //} while( strcmp(outEndpoint.get_ip_address(), inEndpoint.get_ip_address()) != 0 );
donatien 0:04a82df0f587 112
donatien 0:04a82df0f587 113 if(ret < sizeof(NTPPacket)) //TODO: Accept chunks
donatien 0:04a82df0f587 114 {
donatien 0:04a82df0f587 115 ERR("Receive packet size does not match");
donatien 2:9a64a50df235 116 m_sock.close();
donatien 2:9a64a50df235 117 return NTP_PRTCL;
donatien 0:04a82df0f587 118 }
donatien 0:04a82df0f587 119
donatien 0:04a82df0f587 120 if( pkt.stratum == 0) //Kiss of death message : Not good !
donatien 0:04a82df0f587 121 {
donatien 0:04a82df0f587 122 ERR("Kissed to death!");
donatien 2:9a64a50df235 123 m_sock.close();
donatien 2:9a64a50df235 124 return NTP_PRTCL;
donatien 0:04a82df0f587 125 }
donatien 0:04a82df0f587 126
donatien 0:04a82df0f587 127 //Correct Endianness
donatien 0:04a82df0f587 128 pkt.refTm_s = ntohl( pkt.refTm_s );
donatien 0:04a82df0f587 129 pkt.refTm_f = ntohl( pkt.refTm_f );
donatien 0:04a82df0f587 130 pkt.origTm_s = ntohl( pkt.origTm_s );
donatien 0:04a82df0f587 131 pkt.origTm_f = ntohl( pkt.origTm_f );
donatien 0:04a82df0f587 132 pkt.rxTm_s = ntohl( pkt.rxTm_s );
donatien 0:04a82df0f587 133 pkt.rxTm_f = ntohl( pkt.rxTm_f );
donatien 0:04a82df0f587 134 pkt.txTm_s = ntohl( pkt.txTm_s );
donatien 0:04a82df0f587 135 pkt.txTm_f = ntohl( pkt.txTm_f );
donatien 0:04a82df0f587 136
donatien 0:04a82df0f587 137 //Compute offset, see RFC 4330 p.13
donatien 0:04a82df0f587 138 uint32_t destTm_s = (NTP_TIMESTAMP_DELTA + time(NULL));
donatien 0:04a82df0f587 139 int64_t offset = ( (int64_t)( pkt.rxTm_s - pkt.origTm_s ) + (int64_t) ( pkt.txTm_s - destTm_s ) ) / 2; //Avoid overflow
donatien 0:04a82df0f587 140 DBG("Sent @%ul", pkt.txTm_s);
donatien 2:9a64a50df235 141 DBG("Offset: %lld", offset);
donatien 0:04a82df0f587 142 //Set time accordingly
donatien 0:04a82df0f587 143 set_time( time(NULL) + offset );
donatien 0:04a82df0f587 144
donatien 2:9a64a50df235 145 #ifdef __DEBUG__
donatien 0:04a82df0f587 146 ctTime = time(NULL);
donatien 2:9a64a50df235 147 DBG("Time is now (UTC): %s", ctime(&ctTime));
donatien 0:04a82df0f587 148 #endif
donatien 0:04a82df0f587 149
donatien 2:9a64a50df235 150 m_sock.close();
donatien 0:04a82df0f587 151
donatien 2:9a64a50df235 152 return NTP_OK;
donatien 0:04a82df0f587 153 }
donatien 0:04a82df0f587 154