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