NtpClock.h

/*
 * MIT License
 * Copyright (c) 2018 Brian T. Park
 */
 
#ifndef ACE_TIME_NTP_CLOCK_H
#define ACE_TIME_NTP_CLOCK_H
 
#if defined(ESP8266) || defined(ESP32) || defined(EPOXY_CORE_ESP8266)
 
#include <stdint.h>
#if defined(ESP8266) || defined(EPOXY_CORE_ESP8266)
  #include <ESP8266WiFi.h>
#else
  #include <WiFi.h>
#endif
#include <WiFiUdp.h>
#include "Clock.h"
 
#ifndef ACE_TIME_NTP_CLOCK_DEBUG
#define ACE_TIME_NTP_CLOCK_DEBUG 0
#endif
 
namespace ace_time {
namespace clock {
 
class NtpClock: public Clock {
  public:
    static const char kNtpServerName[];
 
    static const uint16_t kLocalPort = 2390;
 
    static const uint16_t kRequestTimeoutMillis = 1000;
 
    static const uint16_t kRequestTimeout = kRequestTimeoutMillis;
 
    static const uint16_t kConnectTimeoutMillis = 10000;
 
    explicit NtpClock(
            const char* server = kNtpServerName,
            uint16_t localPort = kLocalPort,
            uint16_t requestTimeout = kRequestTimeoutMillis):
        mServer(server),
        mLocalPort(localPort),
        mRequestTimeout(requestTimeout) {}
 
    void setup(
        const char* ssid = nullptr,
        const char* password = nullptr,
        uint16_t connectTimeoutMillis = kConnectTimeoutMillis);
 
    const char* getServer() const { return mServer; }
 
    bool isSetup() const { return mIsSetUp; }
 
    acetime_t getNow() const override;
 
    void sendRequest() const override;
 
    bool isResponseReady() const override;
 
    acetime_t readResponse() const override;
 
    static acetime_t convertNtpSecondsToAceTimeSeconds(uint32_t ntpSeconds);
 
  private:
    static const uint8_t kNtpPacketSize = 48;
 
    static const int32_t kDaysToInternalEpochFromNtpEpoch = 36524;
 
    void sendNtpPacket(const IPAddress& address) const;
 
  private:
    const char* const mServer;
    uint16_t const mLocalPort;
    uint16_t const mRequestTimeout;
 
    mutable WiFiUDP mUdp;
    // buffer to hold incoming & outgoing packets
    mutable uint8_t mPacketBuffer[kNtpPacketSize];
    bool mIsSetUp = false;
};
 
}
}
 
#endif
 
#endif