NTP working

Author: PaulZC

Firmware/RTK_Everywhere/NTP.ino

@@ -113,6 +113,9 @@ void menuNTP()
         systemPrint("5) Reference ID: ");
         systemPrintln(settings.ntpReferenceId);
 
+        systemPrint("6) NTP Port: ");
+        systemPrintln(settings.ethernetNtpPort);
+
         systemPrintln("x) Exit");
 
         byte incoming = getUserInputCharacterNumber();
@@ -168,6 +171,15 @@ void menuNTP()
             else
                 systemPrintln("Error: invalid Reference ID");
         }
+        else if (incoming == 6)
+        {
+            systemPrint("Enter new NTP port: ");
+            long newVal = getUserInputNumber();
+            if ((newVal >= 0) && (newVal <= 65535))
+                settings.ethernetNtpPort = newVal;
+            else
+                systemPrintln("Error: port number out of range");
+        }
         else if (incoming == 'x')
             break;
         else if (incoming == INPUT_RESPONSE_GETCHARACTERNUMBER_EMPTY)
@@ -484,15 +496,14 @@ bool ntpProcessOneRequest(bool process, const timeval *recTv, const timeval *syn
     if (ntpDiag != nullptr)
         *ntpDiag = 0; // Clear any existing diagnostics
 
-    gettimeofday((timeval *)&ethernetNtpTv, nullptr); // Record the possible time of the NTP request
-
-    int packetDataSize = 0;
+    ntpServer->parsePacket();
 
-    if (ntpServer->available() > 0)
-        packetDataSize = ntpServer->parsePacket();
+    int packetDataSize = ntpServer->available();
 
-    if (packetDataSize >= NTPpacket::NTPpacketSize)
+    if (packetDataSize > 0)
     {
+        gettimeofday((timeval *)&ethernetNtpTv, nullptr); // Record the possible time of the NTP request
+
         IPAddress remoteIP = ntpServer->remoteIP();
         uint16_t remotePort = ntpServer->remotePort();
 
@@ -502,149 +513,161 @@ bool ntpProcessOneRequest(bool process, const timeval *recTv, const timeval *syn
                     remoteIP[1], remoteIP[2], remoteIP[3], remotePort);
         }
 
-        // Read the NTP packet
-        NTPpacket packet;
+        if (packetDataSize >= NTPpacket::NTPpacketSize)
+        {
+            // Read the NTP packet
+            NTPpacket packet;
 
-        ntpServer->read((char *)&packet.packet, NTPpacket::NTPpacketSize); // Copy the NTP data into our packet
+            ntpServer->read((char *)&packet.packet, NTPpacket::NTPpacketSize); // Copy the NTP data into our packet
 
-        // If process is false, return now
-        if (!process)
-        {
-            char tmpbuf[128];
-            snprintf(tmpbuf, sizeof(tmpbuf),
-                     "NTP request ignored. Time has not been synchronized - or not in NTP mode.\r\n");
-            strlcat(ntpDiag, tmpbuf, ntpDiagSize);
-            return false;
-        }
+            // If process is false, return now
+            if (!process)
+            {
+                char tmpbuf[128];
+                snprintf(tmpbuf, sizeof(tmpbuf),
+                        "NTP request ignored. Time has not been synchronized - or not in NTP mode.\r\n");
+                strlcat(ntpDiag, tmpbuf, ntpDiagSize);
+                return false;
+            }
 
-        packet.extract(); // Extract the raw data into fields
-
-        packet.LI(packet.defaultLeapInd);       // Clear the leap second adjustment. TODO: set this correctly using
-                                                // getLeapSecondEvent from the GNSS
-        packet.VN(packet.defaultVersion);       // Set the version number
-        packet.mode(packet.defaultMode);        // Set the mode
-        packet.stratum = packet.defaultStratum; // Set the stratum
-        packet.pollExponent = settings.ntpPollExponent;                                  // Set the poll interval
-        packet.precision = settings.ntpPrecision;                                        // Set the precision
-        packet.rootDelay = packet.convertMicrosToSecsAndFraction(settings.ntpRootDelay); // Set the Root Delay
-        packet.rootDispersion =
-            packet.convertMicrosToSecsAndFraction(settings.ntpRootDispersion); // Set the Root Dispersion
-        for (uint8_t i = 0; i < packet.referenceIdLen; i++)
-            packet.referenceId[i] = settings.ntpReferenceId[i]; // Set the reference Id
-
-        // REF: http://support.ntp.org/bin/view/Support/DraftRfc2030
-        // '.. the client sets the Transmit Timestamp field in the request
-        // to the time of day according to the client clock in NTP timestamp format.'
-        // '.. The server copies this field to the originate timestamp in the reply and
-        // sets the Receive Timestamp and Transmit Timestamp fields to the time of day
-        // according to the server clock in NTP timestamp format.'
-
-        // Important note: the NTP Era started January 1st 1900.
-        // tv will contain the time based on the Unix epoch (January 1st 1970)
-        // We need to adjust...
-
-        // First, add the client transmit timestamp to our diagnostics
-        if (ntpDiag != nullptr)
-        {
-            char tmpbuf[128];
-            snprintf(tmpbuf, sizeof(tmpbuf), "Originate Timestamp (Client Transmit): %u.%06u\r\n",
-                     packet.transmitTimestampSeconds, packet.convertFractionToMicros(packet.transmitTimestampFraction));
-            strlcat(ntpDiag, tmpbuf, ntpDiagSize);
-        }
+            packet.extract(); // Extract the raw data into fields
+
+            packet.LI(packet.defaultLeapInd);       // Clear the leap second adjustment. TODO: set this correctly using
+                                                    // getLeapSecondEvent from the GNSS
+            packet.VN(packet.defaultVersion);       // Set the version number
+            packet.mode(packet.defaultMode);        // Set the mode
+            packet.stratum = packet.defaultStratum; // Set the stratum
+            packet.pollExponent = settings.ntpPollExponent;                                  // Set the poll interval
+            packet.precision = settings.ntpPrecision;                                        // Set the precision
+            packet.rootDelay = packet.convertMicrosToSecsAndFraction(settings.ntpRootDelay); // Set the Root Delay
+            packet.rootDispersion =
+                packet.convertMicrosToSecsAndFraction(settings.ntpRootDispersion); // Set the Root Dispersion
+            for (uint8_t i = 0; i < packet.referenceIdLen; i++)
+                packet.referenceId[i] = settings.ntpReferenceId[i]; // Set the reference Id
+
+            // REF: http://support.ntp.org/bin/view/Support/DraftRfc2030
+            // '.. the client sets the Transmit Timestamp field in the request
+            // to the time of day according to the client clock in NTP timestamp format.'
+            // '.. The server copies this field to the originate timestamp in the reply and
+            // sets the Receive Timestamp and Transmit Timestamp fields to the time of day
+            // according to the server clock in NTP timestamp format.'
+
+            // Important note: the NTP Era started January 1st 1900.
+            // tv will contain the time based on the Unix epoch (January 1st 1970)
+            // We need to adjust...
+
+            // First, add the client transmit timestamp to our diagnostics
+            if (ntpDiag != nullptr)
+            {
+                char tmpbuf[128];
+                snprintf(tmpbuf, sizeof(tmpbuf), "Originate Timestamp (Client Transmit): %u.%06u\r\n",
+                        packet.transmitTimestampSeconds, packet.convertFractionToMicros(packet.transmitTimestampFraction));
+                strlcat(ntpDiag, tmpbuf, ntpDiagSize);
+            }
 
-        // Copy the client transmit timestamp into the originate timestamp
-        packet.originateTimestampSeconds = packet.transmitTimestampSeconds;
-        packet.originateTimestampFraction = packet.transmitTimestampFraction;
+            // Copy the client transmit timestamp into the originate timestamp
+            packet.originateTimestampSeconds = packet.transmitTimestampSeconds;
+            packet.originateTimestampFraction = packet.transmitTimestampFraction;
 
-        // Set the receive timestamp to the time we received the packet (logged by the W5500 interrupt)
-        uint32_t recUnixSeconds = recTv->tv_sec;
-        recUnixSeconds -= settings.timeZoneSeconds; // Subtract the time zone offset to convert recTv to Unix time
-        recUnixSeconds -= settings.timeZoneMinutes * 60;
-        recUnixSeconds -= settings.timeZoneHours * 60 * 60;
-        packet.receiveTimestampSeconds = packet.convertUnixSecondsToNTP(recUnixSeconds);  // Unix -> NTP
-        packet.receiveTimestampFraction = packet.convertMicrosToFraction(recTv->tv_usec); // Micros to 1/2^32
+            // Set the receive timestamp to the time we received the packet (logged by the W5500 interrupt)
+            uint32_t recUnixSeconds = recTv->tv_sec;
+            recUnixSeconds -= settings.timeZoneSeconds; // Subtract the time zone offset to convert recTv to Unix time
+            recUnixSeconds -= settings.timeZoneMinutes * 60;
+            recUnixSeconds -= settings.timeZoneHours * 60 * 60;
+            packet.receiveTimestampSeconds = packet.convertUnixSecondsToNTP(recUnixSeconds);  // Unix -> NTP
+            packet.receiveTimestampFraction = packet.convertMicrosToFraction(recTv->tv_usec); // Micros to 1/2^32
 
-        // Add the receive timestamp to the diagnostics
-        if (ntpDiag != nullptr)
-        {
-            char tmpbuf[128];
-            snprintf(tmpbuf, sizeof(tmpbuf), "Received Timestamp:                    %u.%06u\r\n",
-                     packet.receiveTimestampSeconds, packet.convertFractionToMicros(packet.receiveTimestampFraction));
-            strlcat(ntpDiag, tmpbuf, ntpDiagSize);
-        }
+            // Add the receive timestamp to the diagnostics
+            if (ntpDiag != nullptr)
+            {
+                char tmpbuf[128];
+                snprintf(tmpbuf, sizeof(tmpbuf), "Received Timestamp:                    %u.%06u\r\n",
+                        packet.receiveTimestampSeconds, packet.convertFractionToMicros(packet.receiveTimestampFraction));
+                strlcat(ntpDiag, tmpbuf, ntpDiagSize);
+            }
 
-        // Add when our clock was last sync'd
-        uint32_t syncUnixSeconds = syncTv->tv_sec;
-        syncUnixSeconds -= settings.timeZoneSeconds; // Subtract the time zone offset to convert recTv to Unix time
-        syncUnixSeconds -= settings.timeZoneMinutes * 60;
-        syncUnixSeconds -= settings.timeZoneHours * 60 * 60;
-        packet.referenceTimestampSeconds = packet.convertUnixSecondsToNTP(syncUnixSeconds);  // Unix -> NTP
-        packet.referenceTimestampFraction = packet.convertMicrosToFraction(syncTv->tv_usec); // Micros to 1/2^32
+            // Add when our clock was last sync'd
+            uint32_t syncUnixSeconds = syncTv->tv_sec;
+            syncUnixSeconds -= settings.timeZoneSeconds; // Subtract the time zone offset to convert recTv to Unix time
+            syncUnixSeconds -= settings.timeZoneMinutes * 60;
+            syncUnixSeconds -= settings.timeZoneHours * 60 * 60;
+            packet.referenceTimestampSeconds = packet.convertUnixSecondsToNTP(syncUnixSeconds);  // Unix -> NTP
+            packet.referenceTimestampFraction = packet.convertMicrosToFraction(syncTv->tv_usec); // Micros to 1/2^32
 
-        // Add that to the diagnostics
-        if (ntpDiag != nullptr)
-        {
+            // Add that to the diagnostics
+            if (ntpDiag != nullptr)
+            {
+                char tmpbuf[128];
+                snprintf(tmpbuf, sizeof(tmpbuf), "Reference Timestamp (Last Sync):       %u.%06u\r\n",
+                        packet.referenceTimestampSeconds,
+                        packet.convertFractionToMicros(packet.referenceTimestampFraction));
+                strlcat(ntpDiag, tmpbuf, ntpDiagSize);
+            }
+
+            // Add the transmit time - i.e. now!
+            timeval txTime;
+            gettimeofday(&txTime, nullptr);
+            uint32_t nowUnixSeconds = txTime.tv_sec;
+            nowUnixSeconds -= settings.timeZoneSeconds; // Subtract the time zone offset to convert recTv to Unix time
+            nowUnixSeconds -= settings.timeZoneMinutes * 60;
+            nowUnixSeconds -= settings.timeZoneHours * 60 * 60;
+            packet.transmitTimestampSeconds = packet.convertUnixSecondsToNTP(nowUnixSeconds);  // Unix -> NTP
+            packet.transmitTimestampFraction = packet.convertMicrosToFraction(txTime.tv_usec); // Micros to 1/2^32
+
+            packet.insert(); // Copy the data fields back into the buffer
+
+            // Now transmit the response to the client.
+            ntpServer->beginPacket(remoteIP, remotePort);
+            ntpServer->write(packet.packet, NTPpacket::NTPpacketSize);
+            int result = ntpServer->endPacket();
+            processed = true;
+
+            // Add our server transmit time to the diagnostics
+            if (ntpDiag != nullptr)
+            {
+                char tmpbuf[128];
+                snprintf(tmpbuf, sizeof(tmpbuf), "Transmit Timestamp:                    %u.%06u\r\n",
+                        packet.transmitTimestampSeconds, packet.convertFractionToMicros(packet.transmitTimestampFraction));
+                strlcat(ntpDiag, tmpbuf, ntpDiagSize);
+            }
+
+            /*
+            // Add the socketSendUDP result to the diagnostics
+            if (ntpDiag != nullptr)
+            {
             char tmpbuf[128];
-            snprintf(tmpbuf, sizeof(tmpbuf), "Reference Timestamp (Last Sync):       %u.%06u\r\n",
-                     packet.referenceTimestampSeconds,
-                     packet.convertFractionToMicros(packet.referenceTimestampFraction));
+            snprintf(tmpbuf, sizeof(tmpbuf), "socketSendUDP result: %d\r\n", result);
             strlcat(ntpDiag, tmpbuf, ntpDiagSize);
-        }
+            }
+            */
 
-        // Add the transmit time - i.e. now!
-        timeval txTime;
-        gettimeofday(&txTime, nullptr);
-        uint32_t nowUnixSeconds = txTime.tv_sec;
-        nowUnixSeconds -= settings.timeZoneSeconds; // Subtract the time zone offset to convert recTv to Unix time
-        nowUnixSeconds -= settings.timeZoneMinutes * 60;
-        nowUnixSeconds -= settings.timeZoneHours * 60 * 60;
-        packet.transmitTimestampSeconds = packet.convertUnixSecondsToNTP(nowUnixSeconds);  // Unix -> NTP
-        packet.transmitTimestampFraction = packet.convertMicrosToFraction(txTime.tv_usec); // Micros to 1/2^32
-
-        packet.insert(); // Copy the data fields back into the buffer
-
-        // Now transmit the response to the client.
-        ntpServer->beginPacket(remoteIP, remotePort);
-        ntpServer->write(packet.packet, NTPpacket::NTPpacketSize);
-        // int result = ntpServer->endPacket();
-        processed = true;
-
-        // Add our server transmit time to the diagnostics
-        if (ntpDiag != nullptr)
-        {
+            /*
+            // Add the packet to the diagnostics
+            if (ntpDiag != nullptr)
+            {
             char tmpbuf[128];
-            snprintf(tmpbuf, sizeof(tmpbuf), "Transmit Timestamp:                    %u.%06u\r\n",
-                     packet.transmitTimestampSeconds, packet.convertFractionToMicros(packet.transmitTimestampFraction));
+            snprintf(tmpbuf, sizeof(tmpbuf), "Packet: ");
             strlcat(ntpDiag, tmpbuf, ntpDiagSize);
+            for (int i = 0; i < NTPpacket::NTPpacketSize; i++)
+            {
+                snprintf(tmpbuf, sizeof(tmpbuf), "%02X ", packet.packet[i]);
+                strlcat(ntpDiag, tmpbuf, ntpDiagSize);
+            }
+            snprintf(tmpbuf, sizeof(tmpbuf), "\r\n");
+            strlcat(ntpDiag, tmpbuf, ntpDiagSize);
+            }
+            */
         }
-
-        /*
-          // Add the socketSendUDP result to the diagnostics
-          if (ntpDiag != nullptr)
-          {
-          char tmpbuf[128];
-          snprintf(tmpbuf, sizeof(tmpbuf), "socketSendUDP result: %d\r\n", result);
-          strlcat(ntpDiag, tmpbuf, ntpDiagSize);
-          }
-        */
-
-        /*
-          // Add the packet to the diagnostics
-          if (ntpDiag != nullptr)
-          {
-          char tmpbuf[128];
-          snprintf(tmpbuf, sizeof(tmpbuf), "Packet: ");
-          strlcat(ntpDiag, tmpbuf, ntpDiagSize);
-          for (int i = 0; i < NTPpacket::NTPpacketSize; i++)
-          {
-            snprintf(tmpbuf, sizeof(tmpbuf), "%02X ", packet.packet[i]);
+        else
+        {
+            char tmpbuf[64];
+            snprintf(tmpbuf, sizeof(tmpbuf), "Invalid size: %d\r\n", packetDataSize);
             strlcat(ntpDiag, tmpbuf, ntpDiagSize);
-          }
-          snprintf(tmpbuf, sizeof(tmpbuf), "\r\n");
-          strlcat(ntpDiag, tmpbuf, ntpDiagSize);
-          }
-        */
+        }
     }
+
+    ntpServer->clear();
+
     return processed;
 }
 
@@ -872,15 +895,16 @@ void ntpServerUpdate()
             // Check for new NTP requests - if the time has been sync'd
             bool processed = ntpProcessOneRequest(systemState == STATE_NTPSERVER_SYNC, (const timeval *)&ethernetNtpTv,
                                                   (const timeval *)&gnssSyncTv, ntpDiag, sizeof(ntpDiag));
-            if (processed)
+
+            // Print the diagnostics - if enabled
+            if ((settings.debugNtp || PERIODIC_DISPLAY(PD_NTP_SERVER_DATA)) && (strlen(ntpDiag) > 0) && (!inMainMenu))
             {
-                // Print the diagnostics - if enabled
-                if ((settings.debugNtp || PERIODIC_DISPLAY(PD_NTP_SERVER_DATA)) && (!inMainMenu))
-                {
-                    PERIODIC_CLEAR(PD_NTP_SERVER_DATA);
-                    systemPrint(ntpDiag);
-                }
+                PERIODIC_CLEAR(PD_NTP_SERVER_DATA);
+                systemPrint(ntpDiag);
+            }
 
+            if (processed)
+            {
                 // Log the NTP request to file - if enabled
                 if (settings.enableNTPFile)
                 {