robot arm demo team / NTPClient

Time server client - copy from iothub sample

NTPClient.h@0:9a7b8df5fad7, 2015-12-23 (annotated)

Committer:
henryrawas
Date:
Wed Dec 23 18:33:25 2015 +0000
Revision:
0:9a7b8df5fad7
add to robotarm;

Who changed what in which revision?

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