Yann Garcia / Mbed 2 deprecated DS130x_I2CApp

This short program illustrates how to use the DS130x_I2C library. My objective is to share the same RTC with Microchip 18F MCU.

Dependencies:   mbed DebugLibrary

NetServices/services/ntp/NTPClient.h@1:995212d326ca, 2011-02-11 (annotated)

Committer:
Yann
Date:
Fri Feb 11 10:17:20 2011 +0000
Revision:
1:995212d326ca
Parent:
0:f30e2135b0db 
V0.0.0.2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Yann 0:f30e2135b0db 1
Yann 0:f30e2135b0db 2 /*
Yann 0:f30e2135b0db 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Yann 0:f30e2135b0db 4
Yann 0:f30e2135b0db 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Yann 0:f30e2135b0db 6 of this software and associated documentation files (the "Software"), to deal
Yann 0:f30e2135b0db 7 in the Software without restriction, including without limitation the rights
Yann 0:f30e2135b0db 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Yann 0:f30e2135b0db 9 copies of the Software, and to permit persons to whom the Software is
Yann 0:f30e2135b0db 10 furnished to do so, subject to the following conditions:
Yann 0:f30e2135b0db 11
Yann 0:f30e2135b0db 12 The above copyright notice and this permission notice shall be included in
Yann 0:f30e2135b0db 13 all copies or substantial portions of the Software.
Yann 0:f30e2135b0db 14
Yann 0:f30e2135b0db 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Yann 0:f30e2135b0db 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Yann 0:f30e2135b0db 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Yann 0:f30e2135b0db 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Yann 0:f30e2135b0db 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Yann 0:f30e2135b0db 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Yann 0:f30e2135b0db 21 THE SOFTWARE.
Yann 0:f30e2135b0db 22 */
Yann 0:f30e2135b0db 23
Yann 0:f30e2135b0db 24 /** \file
Yann 0:f30e2135b0db 25 NTP Client header file
Yann 0:f30e2135b0db 26 */
Yann 0:f30e2135b0db 27
Yann 0:f30e2135b0db 28 #ifndef NTP_CLIENT_H
Yann 0:f30e2135b0db 29 #define NTP_CLIENT_H
Yann 0:f30e2135b0db 30
Yann 0:f30e2135b0db 31 #include "core/net.h"
Yann 0:f30e2135b0db 32 #include "core/netservice.h"
Yann 0:f30e2135b0db 33 #include "api/UDPSocket.h"
Yann 0:f30e2135b0db 34 #include "api/DNSRequest.h"
Yann 0:f30e2135b0db 35 #include "mbed.h"
Yann 0:f30e2135b0db 36
Yann 0:f30e2135b0db 37 ///NTP Client results
Yann 0:f30e2135b0db 38 enum NTPResult
Yann 0:f30e2135b0db 39 {
Yann 0:f30e2135b0db 40 NTP_OK, ///<Success
Yann 0:f30e2135b0db 41 NTP_PROCESSING, ///<Processing
Yann 0:f30e2135b0db 42 NTP_PRTCL, ///<Protocol error
Yann 0:f30e2135b0db 43 NTP_TIMEOUT, ///<Connection timeout
Yann 0:f30e2135b0db 44 NTP_DNS ///<Could not resolve DNS hostname
Yann 0:f30e2135b0db 45 };
Yann 0:f30e2135b0db 46
Yann 0:f30e2135b0db 47 ///A NTP Client
Yann 0:f30e2135b0db 48 /**
Yann 0:f30e2135b0db 49 The NTP client is a simple UDP client that will update the mbed's RTC
Yann 0:f30e2135b0db 50 */
Yann 0:f30e2135b0db 51 class NTPClient : protected NetService
Yann 0:f30e2135b0db 52 {
Yann 0:f30e2135b0db 53 public:
Yann 0:f30e2135b0db 54 /**
Yann 0:f30e2135b0db 55 Instantiates the NTP client
Yann 0:f30e2135b0db 56 */
Yann 0:f30e2135b0db 57 NTPClient();
Yann 0:f30e2135b0db 58 virtual ~NTPClient();
Yann 0:f30e2135b0db 59
Yann 0:f30e2135b0db 60 //High level setup functions
Yann 0:f30e2135b0db 61
Yann 0:f30e2135b0db 62 ///Gets current time (blocking)
Yann 0:f30e2135b0db 63 /**
Yann 0:f30e2135b0db 64 Updates the time using the server host
Yann 0:f30e2135b0db 65 Blocks until completion
Yann 0:f30e2135b0db 66 @param host : NTP server
Yann 0:f30e2135b0db 67 */
Yann 0:f30e2135b0db 68 NTPResult setTime(const Host& host); //Blocking
Yann 0:f30e2135b0db 69
Yann 0:f30e2135b0db 70 ///Gets current time (non-blocking)
Yann 0:f30e2135b0db 71 /**
Yann 0:f30e2135b0db 72 Updates the time using the server host
Yann 0:f30e2135b0db 73 The function returns immediately and calls the callback on completion or error
Yann 0:f30e2135b0db 74 @param host : NTP server
Yann 0:f30e2135b0db 75 @param pMethod : callback function
Yann 0:f30e2135b0db 76 */
Yann 0:f30e2135b0db 77 NTPResult setTime(const Host& host, void (*pMethod)(NTPResult)); //Non blocking
Yann 0:f30e2135b0db 78
Yann 0:f30e2135b0db 79 ///Gets current time (non-blocking)
Yann 0:f30e2135b0db 80 /**
Yann 0:f30e2135b0db 81 Updates the time
Yann 0:f30e2135b0db 82 @param host : NTP server
Yann 0:f30e2135b0db 83 @param pItem : instance of class on which to execute the callback method
Yann 0:f30e2135b0db 84 @param pMethod : callback method
Yann 0:f30e2135b0db 85 The function returns immediately and calls the callback on completion or error
Yann 0:f30e2135b0db 86 */
Yann 0:f30e2135b0db 87 template<class T>
Yann 0:f30e2135b0db 88 NTPResult setTime(const Host& host, T* pItem, void (T::*pMethod)(NTPResult)) //Non blocking
Yann 0:f30e2135b0db 89 {
Yann 0:f30e2135b0db 90 setOnResult(pItem, pMethod);
Yann 0:f30e2135b0db 91 doSetTime(host);
Yann 0:f30e2135b0db 92 return NTP_PROCESSING;
Yann 0:f30e2135b0db 93 }
Yann 0:f30e2135b0db 94
Yann 0:f30e2135b0db 95 ///Gets current time (non-blocking)
Yann 0:f30e2135b0db 96 /**
Yann 0:f30e2135b0db 97 Updates the time using the server host
Yann 0:f30e2135b0db 98 The function returns immediately and calls the previously set callback on completion or error
Yann 0:f30e2135b0db 99 @param host : NTP server
Yann 0:f30e2135b0db 100 */
Yann 0:f30e2135b0db 101 void doSetTime(const Host& host);
Yann 0:f30e2135b0db 102
Yann 0:f30e2135b0db 103 ///Setups the result callback
Yann 0:f30e2135b0db 104 /**
Yann 0:f30e2135b0db 105 @param pMethod : callback function
Yann 0:f30e2135b0db 106 */
Yann 0:f30e2135b0db 107 void setOnResult( void (*pMethod)(NTPResult) );
Yann 0:f30e2135b0db 108
Yann 0:f30e2135b0db 109 ///Setups the result callback
Yann 0:f30e2135b0db 110 /**
Yann 0:f30e2135b0db 111 @param pItem : instance of class on which to execute the callback method
Yann 0:f30e2135b0db 112 @param pMethod : callback method
Yann 0:f30e2135b0db 113 */
Yann 0:f30e2135b0db 114 class CDummy;
Yann 0:f30e2135b0db 115 template<class T>
Yann 0:f30e2135b0db 116 void setOnResult( T* pItem, void (T::*pMethod)(NTPResult) )
Yann 0:f30e2135b0db 117 {
Yann 0:f30e2135b0db 118 m_pCbItem = (CDummy*) pItem;
Yann 0:f30e2135b0db 119 m_pCbMeth = (void (CDummy::*)(NTPResult)) pMethod;
Yann 0:f30e2135b0db 120 }
Yann 0:f30e2135b0db 121
Yann 0:f30e2135b0db 122 void close();
Yann 0:f30e2135b0db 123
Yann 0:f30e2135b0db 124 protected:
Yann 0:f30e2135b0db 125 virtual void poll(); //Called by NetServices
Yann 0:f30e2135b0db 126
Yann 0:f30e2135b0db 127 private:
Yann 0:f30e2135b0db 128 void init();
Yann 0:f30e2135b0db 129 void open();
Yann 0:f30e2135b0db 130
Yann 0:f30e2135b0db 131 __packed struct NTPPacket //See RFC 4330 for Simple NTP
Yann 0:f30e2135b0db 132 {
Yann 0:f30e2135b0db 133 //WARN: We are in LE! Network is BE!
Yann 0:f30e2135b0db 134 //LSb first
Yann 0:f30e2135b0db 135 unsigned mode : 3;
Yann 0:f30e2135b0db 136 unsigned vn : 3;
Yann 0:f30e2135b0db 137 unsigned li : 2;
Yann 0:f30e2135b0db 138
Yann 0:f30e2135b0db 139 uint8_t stratum;
Yann 0:f30e2135b0db 140 uint8_t poll;
Yann 0:f30e2135b0db 141 uint8_t precision;
Yann 0:f30e2135b0db 142 //32 bits header
Yann 0:f30e2135b0db 143
Yann 0:f30e2135b0db 144 uint32_t rootDelay;
Yann 0:f30e2135b0db 145 uint32_t rootDispersion;
Yann 0:f30e2135b0db 146 uint32_t refId;
Yann 0:f30e2135b0db 147
Yann 0:f30e2135b0db 148 uint32_t refTm_s;
Yann 0:f30e2135b0db 149 uint32_t refTm_f;
Yann 0:f30e2135b0db 150 uint32_t origTm_s;
Yann 0:f30e2135b0db 151 uint32_t origTm_f;
Yann 0:f30e2135b0db 152 uint32_t rxTm_s;
Yann 0:f30e2135b0db 153 uint32_t rxTm_f;
Yann 0:f30e2135b0db 154 uint32_t txTm_s;
Yann 0:f30e2135b0db 155 uint32_t txTm_f;
Yann 0:f30e2135b0db 156 };
Yann 0:f30e2135b0db 157
Yann 0:f30e2135b0db 158 void process(); //Main state-machine
Yann 0:f30e2135b0db 159
Yann 0:f30e2135b0db 160 void setTimeout(int ms);
Yann 0:f30e2135b0db 161 void resetTimeout();
Yann 0:f30e2135b0db 162
Yann 0:f30e2135b0db 163 void onTimeout(); //Connection has timed out
Yann 0:f30e2135b0db 164 void onDNSReply(DNSReply r);
Yann 0:f30e2135b0db 165 void onUDPSocketEvent(UDPSocketEvent e);
Yann 0:f30e2135b0db 166 void onResult(NTPResult r); //Called when exchange completed or on failure
Yann 0:f30e2135b0db 167
Yann 0:f30e2135b0db 168 NTPResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available
Yann 0:f30e2135b0db 169
Yann 0:f30e2135b0db 170 UDPSocket* m_pUDPSocket;
Yann 0:f30e2135b0db 171
Yann 0:f30e2135b0db 172 enum NTPStep
Yann 0:f30e2135b0db 173 {
Yann 0:f30e2135b0db 174 NTP_PING,
Yann 0:f30e2135b0db 175 NTP_PONG
Yann 0:f30e2135b0db 176 };
Yann 0:f30e2135b0db 177
Yann 0:f30e2135b0db 178 NTPStep m_state;
Yann 0:f30e2135b0db 179
Yann 0:f30e2135b0db 180 NTPPacket m_pkt;
Yann 0:f30e2135b0db 181
Yann 0:f30e2135b0db 182 CDummy* m_pCbItem;
Yann 0:f30e2135b0db 183 void (CDummy::*m_pCbMeth)(NTPResult);
Yann 0:f30e2135b0db 184
Yann 0:f30e2135b0db 185 void (*m_pCb)(NTPResult);
Yann 0:f30e2135b0db 186
Yann 0:f30e2135b0db 187 Timer m_watchdog;
Yann 0:f30e2135b0db 188 int m_timeout;
Yann 0:f30e2135b0db 189
Yann 0:f30e2135b0db 190 bool m_closed;
Yann 0:f30e2135b0db 191
Yann 0:f30e2135b0db 192 Host m_host;
Yann 0:f30e2135b0db 193
Yann 0:f30e2135b0db 194 DNSRequest* m_pDnsReq;
Yann 0:f30e2135b0db 195
Yann 0:f30e2135b0db 196 NTPResult m_blockingResult; //Result if blocking mode
Yann 0:f30e2135b0db 197
Yann 0:f30e2135b0db 198 };
Yann 0:f30e2135b0db 199
Yann 0:f30e2135b0db 200 #endif