Dan Minear / Mbed 2 deprecated Sprinkler_Controller

A sprinkler controller that takes HTTP command for zone and duration.

Dependencies:   EthernetNetIf mbed HTTPServer

ntp/NTPClient.cpp@1:91c2c52b4691, 2011-03-09 (annotated)

Committer:
dminear
Date:
Wed Mar 09 03:44:43 2011 +0000
Revision:
1:91c2c52b4691
Parent:
0:810ec1936452 
Fixed constant setting of time via NTP.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dminear 0:810ec1936452 1
dminear 0:810ec1936452 2 /*
dminear 0:810ec1936452 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
dminear 0:810ec1936452 4
dminear 0:810ec1936452 5 Permission is hereby granted, free of charge, to any person obtaining a copy
dminear 0:810ec1936452 6 of this software and associated documentation files (the "Software"), to deal
dminear 0:810ec1936452 7 in the Software without restriction, including without limitation the rights
dminear 0:810ec1936452 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
dminear 0:810ec1936452 9 copies of the Software, and to permit persons to whom the Software is
dminear 0:810ec1936452 10 furnished to do so, subject to the following conditions:
dminear 0:810ec1936452 11
dminear 0:810ec1936452 12 The above copyright notice and this permission notice shall be included in
dminear 0:810ec1936452 13 all copies or substantial portions of the Software.
dminear 0:810ec1936452 14
dminear 0:810ec1936452 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
dminear 0:810ec1936452 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
dminear 0:810ec1936452 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
dminear 0:810ec1936452 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
dminear 0:810ec1936452 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
dminear 0:810ec1936452 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
dminear 0:810ec1936452 21 THE SOFTWARE.
dminear 0:810ec1936452 22 */
dminear 0:810ec1936452 23
dminear 0:810ec1936452 24 #include "NTPClient.h"
dminear 0:810ec1936452 25
dminear 0:810ec1936452 26 #include <stdio.h>
dminear 0:810ec1936452 27
dminear 0:810ec1936452 28 //#define __DEBUG
dminear 0:810ec1936452 29 #include "dbg/dbg.h"
dminear 0:810ec1936452 30
dminear 0:810ec1936452 31 #define NTP_PORT 123
dminear 0:810ec1936452 32 #define NTP_CLIENT_PORT 0//50420 //Random port
dminear 0:810ec1936452 33 #define NTP_REQUEST_TIMEOUT 15000
dminear 0:810ec1936452 34 #define NTP_TIMESTAMP_DELTA 2208988800ull //Diff btw a UNIX timestamp (Starting Jan, 1st 1970) and a NTP timestamp (Starting Jan, 1st 1900)
dminear 0:810ec1936452 35
dminear 0:810ec1936452 36 #define htons( x ) ( (( x << 8 ) & 0xFF00) | (( x >> 8 ) & 0x00FF) )
dminear 0:810ec1936452 37 #define ntohs( x ) (htons(x))
dminear 0:810ec1936452 38
dminear 0:810ec1936452 39 #define htonl( x ) ( (( x << 24 ) & 0xFF000000) \
dminear 0:810ec1936452 40 | (( x << 8 ) & 0x00FF0000) \
dminear 0:810ec1936452 41 | (( x >> 8 ) & 0x0000FF00) \
dminear 0:810ec1936452 42 | (( x >> 24 ) & 0x000000FF) )
dminear 0:810ec1936452 43 #define ntohl( x ) (htonl(x))
dminear 0:810ec1936452 44
dminear 0:810ec1936452 45 NTPClient::NTPClient() : NetService(false), m_state(NTP_PING), m_pCbItem(NULL), m_pCbMeth(NULL), m_pCb(NULL),
dminear 0:810ec1936452 46 m_watchdog(), m_timeout(0), m_closed(true), m_host(), m_pDnsReq(NULL), m_blockingResult(NTP_PROCESSING)
dminear 0:810ec1936452 47 {
dminear 0:810ec1936452 48 setTimeout(NTP_REQUEST_TIMEOUT);
dminear 0:810ec1936452 49 DBG("\r\nNew NTPClient %p\r\n",this);
dminear 0:810ec1936452 50 }
dminear 0:810ec1936452 51
dminear 0:810ec1936452 52 NTPClient::~NTPClient()
dminear 0:810ec1936452 53 {
dminear 0:810ec1936452 54 close();
dminear 0:810ec1936452 55 }
dminear 0:810ec1936452 56
dminear 0:810ec1936452 57 //High level setup functions
dminear 0:810ec1936452 58 NTPResult NTPClient::setTime(const Host& host) //Blocking
dminear 0:810ec1936452 59 {
dminear 0:810ec1936452 60 doSetTime(host);
dminear 0:810ec1936452 61 return blockingProcess();
dminear 0:810ec1936452 62 }
dminear 0:810ec1936452 63
dminear 0:810ec1936452 64 NTPResult NTPClient::setTime(const Host& host, void (*pMethod)(NTPResult)) //Non blocking
dminear 0:810ec1936452 65 {
dminear 0:810ec1936452 66 setOnResult(pMethod);
dminear 0:810ec1936452 67 doSetTime(host);
dminear 0:810ec1936452 68 return NTP_PROCESSING;
dminear 0:810ec1936452 69 }
dminear 0:810ec1936452 70
dminear 0:810ec1936452 71 #if 0 //For doc only
dminear 0:810ec1936452 72 template<class T>
dminear 0:810ec1936452 73 NTPResult NTPClient::setTime(const Host& host, T* pItem, void (T::*pMethod)(NTPResult)) //Non blocking
dminear 0:810ec1936452 74 {
dminear 0:810ec1936452 75 setOnResult(pItem, pMethod);
dminear 0:810ec1936452 76 doSetTime(host);
dminear 0:810ec1936452 77 return NTP_PROCESSING;
dminear 0:810ec1936452 78 }
dminear 0:810ec1936452 79 #endif
dminear 0:810ec1936452 80
dminear 0:810ec1936452 81 void NTPClient::doSetTime(const Host& host)
dminear 0:810ec1936452 82 {
dminear 0:810ec1936452 83 init();
dminear 0:810ec1936452 84 resetTimeout();
dminear 0:810ec1936452 85 m_host = host;
dminear 0:810ec1936452 86 if(!m_host.getPort())
dminear 0:810ec1936452 87 {
dminear 0:810ec1936452 88 m_host.setPort(NTP_PORT);
dminear 0:810ec1936452 89 }
dminear 0:810ec1936452 90 if(m_host.getIp().isNull())
dminear 0:810ec1936452 91 {
dminear 0:810ec1936452 92 //DNS query required
dminear 0:810ec1936452 93 m_pDnsReq = new DNSRequest();
dminear 0:810ec1936452 94 DBG("\r\nNTPClient : DNSRequest %p\r\n", m_pDnsReq);
dminear 0:810ec1936452 95 m_pDnsReq->setOnReply(this, &NTPClient::onDNSReply);
dminear 0:810ec1936452 96 m_pDnsReq->resolve(&m_host);
dminear 0:810ec1936452 97 return;
dminear 0:810ec1936452 98 }
dminear 0:810ec1936452 99 open();
dminear 0:810ec1936452 100 }
dminear 0:810ec1936452 101
dminear 0:810ec1936452 102 void NTPClient::setOnResult( void (*pMethod)(NTPResult) )
dminear 0:810ec1936452 103 {
dminear 0:810ec1936452 104 m_pCb = pMethod;
dminear 0:810ec1936452 105 }
dminear 0:810ec1936452 106
dminear 0:810ec1936452 107 void NTPClient::close()
dminear 0:810ec1936452 108 {
dminear 0:810ec1936452 109 if(m_closed)
dminear 0:810ec1936452 110 return;
dminear 0:810ec1936452 111 m_closed = true; //Prevent recursive calling or calling on an object being destructed by someone else
dminear 0:810ec1936452 112 m_watchdog.stop();
dminear 0:810ec1936452 113 m_pUDPSocket->resetOnEvent();
dminear 0:810ec1936452 114 m_pUDPSocket->close();
dminear 0:810ec1936452 115 delete m_pUDPSocket;
dminear 0:810ec1936452 116 if( m_pDnsReq )
dminear 0:810ec1936452 117 {
dminear 0:810ec1936452 118 m_pDnsReq->close();
dminear 0:810ec1936452 119 delete m_pDnsReq;
dminear 0:810ec1936452 120 m_pDnsReq = NULL;
dminear 0:810ec1936452 121 }
dminear 0:810ec1936452 122 }
dminear 0:810ec1936452 123
dminear 0:810ec1936452 124 void NTPClient::poll() //Called by NetServices
dminear 0:810ec1936452 125 {
dminear 0:810ec1936452 126 if( (!m_closed) && (m_watchdog.read_ms() >= m_timeout) )
dminear 0:810ec1936452 127 {
dminear 0:810ec1936452 128 onTimeout();
dminear 0:810ec1936452 129 }
dminear 0:810ec1936452 130 }
dminear 0:810ec1936452 131
dminear 0:810ec1936452 132 void NTPClient::init() //Create and setup socket if needed
dminear 0:810ec1936452 133 {
dminear 0:810ec1936452 134 if(!m_closed) //Already opened
dminear 0:810ec1936452 135 return;
dminear 0:810ec1936452 136 m_state = NTP_PING;
dminear 0:810ec1936452 137 m_pUDPSocket = new UDPSocket;
dminear 0:810ec1936452 138 m_pUDPSocket->setOnEvent(this, &NTPClient::onUDPSocketEvent);
dminear 0:810ec1936452 139 m_closed = false;
dminear 0:810ec1936452 140 DBG("NTPClient: Init OK\n");
dminear 0:810ec1936452 141 }
dminear 0:810ec1936452 142
dminear 0:810ec1936452 143 void NTPClient::open()
dminear 0:810ec1936452 144 {
dminear 0:810ec1936452 145 resetTimeout();
dminear 0:810ec1936452 146 DBG("Opening connection\n");
dminear 0:810ec1936452 147 m_state = NTP_PING;
dminear 0:810ec1936452 148 Host localhost(IpAddr(), NTP_CLIENT_PORT, "localhost"); //Any local address
dminear 0:810ec1936452 149 m_pUDPSocket->bind(localhost);
dminear 0:810ec1936452 150 set_time( 1280000000 ); //End of July 2010... just there to limit offset range
dminear 0:810ec1936452 151 process();
dminear 0:810ec1936452 152 }
dminear 0:810ec1936452 153
dminear 0:810ec1936452 154 #define MIN(a,b) ((a)<(b))?(a):(b)
dminear 0:810ec1936452 155 void NTPClient::process() //Main state-machine
dminear 0:810ec1936452 156 {
dminear 0:810ec1936452 157 int len;
dminear 0:810ec1936452 158 Host host;
dminear 0:810ec1936452 159
dminear 0:810ec1936452 160 switch(m_state)
dminear 0:810ec1936452 161 {
dminear 0:810ec1936452 162 case NTP_PING:
dminear 0:810ec1936452 163 DBG("\r\nPing\r\n");
dminear 0:810ec1936452 164 //Prepare NTP Packet:
dminear 0:810ec1936452 165 m_pkt.li = 0; //Leap Indicator : No warning
dminear 0:810ec1936452 166 m_pkt.vn = 4; //Version Number : 4
dminear 0:810ec1936452 167 m_pkt.mode = 3; //Client mode
dminear 0:810ec1936452 168 m_pkt.stratum = 0; //Not relevant here
dminear 0:810ec1936452 169 m_pkt.poll = 0; //Not significant as well
dminear 0:810ec1936452 170 m_pkt.precision = 0; //Neither this one is
dminear 0:810ec1936452 171
dminear 0:810ec1936452 172 m_pkt.rootDelay = 0; //Or this one
dminear 0:810ec1936452 173 m_pkt.rootDispersion = 0; //Or that one
dminear 0:810ec1936452 174 m_pkt.refId = 0; //...
dminear 0:810ec1936452 175
dminear 0:810ec1936452 176 m_pkt.refTm_s = 0;
dminear 0:810ec1936452 177 m_pkt.origTm_s = 0;
dminear 0:810ec1936452 178 m_pkt.rxTm_s = 0;
dminear 0:810ec1936452 179 m_pkt.txTm_s = htonl( NTP_TIMESTAMP_DELTA + time(NULL) ); //WARN: We are in LE format, network byte order is BE
dminear 0:810ec1936452 180
dminear 0:810ec1936452 181 m_pkt.refTm_f = m_pkt.origTm_f = m_pkt.rxTm_f = m_pkt.txTm_f = 0;
dminear 0:810ec1936452 182
dminear 0:810ec1936452 183 #ifdef __DEBUG
dminear 0:810ec1936452 184 //Hex Dump:
dminear 0:810ec1936452 185 DBG("\r\nDump Tx:\r\n");
dminear 0:810ec1936452 186 for(int i = 0; i< sizeof(NTPPacket); i++)
dminear 0:810ec1936452 187 {
dminear 0:810ec1936452 188 DBG("%02x ", *((char*)&m_pkt + i));
dminear 0:810ec1936452 189 }
dminear 0:810ec1936452 190 DBG("\r\n\r\n");
dminear 0:810ec1936452 191 #endif
dminear 0:810ec1936452 192
dminear 0:810ec1936452 193 len = m_pUDPSocket->sendto( (char*)&m_pkt, sizeof(NTPPacket), &m_host );
dminear 0:810ec1936452 194 if(len < sizeof(NTPPacket))
dminear 0:810ec1936452 195 { onResult(NTP_PRTCL); close(); return; }
dminear 0:810ec1936452 196
dminear 0:810ec1936452 197 m_state = NTP_PONG;
dminear 0:810ec1936452 198
dminear 0:810ec1936452 199 break;
dminear 0:810ec1936452 200
dminear 0:810ec1936452 201 case NTP_PONG:
dminear 0:810ec1936452 202 DBG("\r\nPong\r\n");
dminear 0:810ec1936452 203 while( len = m_pUDPSocket->recvfrom( (char*)&m_pkt, sizeof(NTPPacket), &host ) )
dminear 0:810ec1936452 204 {
dminear 0:810ec1936452 205 if( len <= 0 )
dminear 0:810ec1936452 206 break;
dminear 0:810ec1936452 207 if( !host.getIp().isEq(m_host.getIp()) )
dminear 0:810ec1936452 208 continue; //Not our packet
dminear 0:810ec1936452 209 if( len > 0 )
dminear 0:810ec1936452 210 break;
dminear 0:810ec1936452 211 }
dminear 0:810ec1936452 212
dminear 0:810ec1936452 213 if(len == 0)
dminear 0:810ec1936452 214 return; //Wait for the next packet
dminear 0:810ec1936452 215
dminear 0:810ec1936452 216 if(len < 0)
dminear 0:810ec1936452 217 { onResult(NTP_PRTCL); close(); return; }
dminear 0:810ec1936452 218
dminear 0:810ec1936452 219 if(len < sizeof(NTPPacket)) //TODO: Accept chunks
dminear 0:810ec1936452 220 { onResult(NTP_PRTCL); close(); return; }
dminear 0:810ec1936452 221
dminear 0:810ec1936452 222 #ifdef __DEBUG
dminear 0:810ec1936452 223 //Hex Dump:
dminear 0:810ec1936452 224 DBG("\r\nDump Rx:\r\n");
dminear 0:810ec1936452 225 for(int i = 0; i< sizeof(NTPPacket); i++)
dminear 0:810ec1936452 226 {
dminear 0:810ec1936452 227 DBG("%02x ", *((char*)&m_pkt + i));
dminear 0:810ec1936452 228 }
dminear 0:810ec1936452 229 DBG("\r\n\r\n");
dminear 0:810ec1936452 230 #endif
dminear 0:810ec1936452 231
dminear 0:810ec1936452 232 if( m_pkt.stratum == 0) //Kiss of death message : Not good !
dminear 0:810ec1936452 233 {
dminear 0:810ec1936452 234 onResult(NTP_PRTCL); close(); return;
dminear 0:810ec1936452 235 }
dminear 0:810ec1936452 236
dminear 0:810ec1936452 237 //Correct Endianness
dminear 0:810ec1936452 238 m_pkt.refTm_s = ntohl( m_pkt.refTm_s );
dminear 0:810ec1936452 239 m_pkt.refTm_f = ntohl( m_pkt.refTm_f );
dminear 0:810ec1936452 240 m_pkt.origTm_s = ntohl( m_pkt.origTm_s );
dminear 0:810ec1936452 241 m_pkt.origTm_f = ntohl( m_pkt.origTm_f );
dminear 0:810ec1936452 242 m_pkt.rxTm_s = ntohl( m_pkt.rxTm_s );
dminear 0:810ec1936452 243 m_pkt.rxTm_f = ntohl( m_pkt.rxTm_f );
dminear 0:810ec1936452 244 m_pkt.txTm_s = ntohl( m_pkt.txTm_s );
dminear 0:810ec1936452 245 m_pkt.txTm_f = ntohl( m_pkt.txTm_f );
dminear 0:810ec1936452 246
dminear 0:810ec1936452 247 //Compute offset, see RFC 4330 p.13
dminear 0:810ec1936452 248 uint32_t destTm_s = (NTP_TIMESTAMP_DELTA + time(NULL));
dminear 0:810ec1936452 249 //int32_t origTm = (int32_t) ((uint64_t) m_pkt.origTm - NTP_TIMESTAMP_DELTA); //Convert in local 32 bits timestamps
dminear 0:810ec1936452 250 //int32_t rxTm = (int32_t) ((uint64_t) m_pkt.rxTm - NTP_TIMESTAMP_DELTA); //Convert in local 32 bits timestamps
dminear 0:810ec1936452 251 //int32_t txTm = (int32_t) ((uint64_t) m_pkt.txTm - NTP_TIMESTAMP_DELTA); //Convert in local 32 bits timestamps
dminear 0:810ec1936452 252 // int64_t offset = ( ( ( m_pkt.rxTm_s - m_pkt.origTm_s ) + ( m_pkt.txTm_s - destTm_s ) ) << 32 + ( ( m_pkt.rxTm_f - m_pkt.origTm_f ) + ( m_pkt.txTm_f - 0 ) ) ) / 2;
dminear 0:810ec1936452 253 int64_t offset = ( (int64_t)( m_pkt.rxTm_s - m_pkt.origTm_s ) + (int64_t) ( m_pkt.txTm_s - destTm_s ) ) / 2; //Avoid overflow
dminear 0:810ec1936452 254 DBG("\r\nSent @%d\r\n", m_pkt.txTm_s);
dminear 0:810ec1936452 255 DBG("\r\nOffset: %d\r\n", offset);
dminear 0:810ec1936452 256 //Set time accordingly
dminear 0:810ec1936452 257 set_time( time(NULL) + (offset /*>> 32*/) );
dminear 0:810ec1936452 258
dminear 0:810ec1936452 259 onResult(NTP_OK);
dminear 0:810ec1936452 260 close();
dminear 0:810ec1936452 261
dminear 0:810ec1936452 262 break;
dminear 0:810ec1936452 263 }
dminear 0:810ec1936452 264 }
dminear 0:810ec1936452 265
dminear 0:810ec1936452 266 void NTPClient::setTimeout(int ms)
dminear 0:810ec1936452 267 {
dminear 0:810ec1936452 268 m_timeout = ms;
dminear 0:810ec1936452 269 }
dminear 0:810ec1936452 270
dminear 0:810ec1936452 271 void NTPClient::resetTimeout()
dminear 0:810ec1936452 272 {
dminear 0:810ec1936452 273 m_watchdog.reset();
dminear 0:810ec1936452 274 m_watchdog.start();
dminear 0:810ec1936452 275 }
dminear 0:810ec1936452 276
dminear 0:810ec1936452 277 void NTPClient::onTimeout() //Connection has timed out
dminear 0:810ec1936452 278 {
dminear 0:810ec1936452 279 close();
dminear 0:810ec1936452 280 onResult(NTP_TIMEOUT);
dminear 0:810ec1936452 281 }
dminear 0:810ec1936452 282
dminear 0:810ec1936452 283 void NTPClient::onDNSReply(DNSReply r)
dminear 0:810ec1936452 284 {
dminear 0:810ec1936452 285 if(m_closed)
dminear 0:810ec1936452 286 {
dminear 0:810ec1936452 287 DBG("\r\nWARN: Discarded\r\n");
dminear 0:810ec1936452 288 return;
dminear 0:810ec1936452 289 }
dminear 0:810ec1936452 290
dminear 0:810ec1936452 291 if( r != DNS_FOUND )
dminear 0:810ec1936452 292 {
dminear 0:810ec1936452 293 DBG("\r\nCould not resolve hostname.\r\n");
dminear 0:810ec1936452 294 onResult(NTP_DNS);
dminear 0:810ec1936452 295 close();
dminear 0:810ec1936452 296 return;
dminear 0:810ec1936452 297 }
dminear 0:810ec1936452 298 DBG("\r\nDNS resolved.\r\n");
dminear 0:810ec1936452 299 m_pDnsReq->close();
dminear 0:810ec1936452 300 delete m_pDnsReq;
dminear 0:810ec1936452 301 m_pDnsReq=NULL;
dminear 0:810ec1936452 302 open();
dminear 0:810ec1936452 303 }
dminear 0:810ec1936452 304
dminear 0:810ec1936452 305 void NTPClient::onUDPSocketEvent(UDPSocketEvent e)
dminear 0:810ec1936452 306 {
dminear 0:810ec1936452 307 resetTimeout();
dminear 0:810ec1936452 308 switch(e)
dminear 0:810ec1936452 309 {
dminear 0:810ec1936452 310 case UDPSOCKET_READABLE: //The only event for now
dminear 0:810ec1936452 311 resetTimeout();
dminear 0:810ec1936452 312 process();
dminear 0:810ec1936452 313 break;
dminear 0:810ec1936452 314 }
dminear 0:810ec1936452 315 }
dminear 0:810ec1936452 316
dminear 0:810ec1936452 317 void NTPClient::onResult(NTPResult r) //Must be called by impl when the request completes
dminear 0:810ec1936452 318 {
dminear 0:810ec1936452 319 if(m_pCbItem && m_pCbMeth)
dminear 0:810ec1936452 320 (m_pCbItem->*m_pCbMeth)(r);
dminear 0:810ec1936452 321 else if(m_pCb)
dminear 0:810ec1936452 322 m_pCb(r);
dminear 0:810ec1936452 323 m_blockingResult = r; //Blocking mode
dminear 0:810ec1936452 324 }
dminear 0:810ec1936452 325
dminear 0:810ec1936452 326 NTPResult NTPClient::blockingProcess() //Called in blocking mode, calls Net::poll() until return code is available
dminear 0:810ec1936452 327 {
dminear 0:810ec1936452 328 m_blockingResult = NTP_PROCESSING;
dminear 0:810ec1936452 329 do
dminear 0:810ec1936452 330 {
dminear 0:810ec1936452 331 Net::poll();
dminear 0:810ec1936452 332 } while(m_blockingResult == NTP_PROCESSING);
dminear 0:810ec1936452 333 Net::poll(); //Necessary for cleanup
dminear 0:810ec1936452 334 return m_blockingResult;
dminear 0:810ec1936452 335 }