From 39bbf0d352fca0735643b53518646341b7fef67c Mon Sep 17 00:00:00 2001
From: Ben Meadors <benmmeadors@gmail.com>
Date: Sun, 21 Apr 2024 14:40:47 -0500
Subject: [PATCH] Added more clear RTC handling and quality logging (#3691)

* Also refresh timestamp for "timeonly" fixed position nodes

* Added more clear RTC quality handling

* Fix clock drift from Phone GPS / NTP too
---
 src/gps/RTC.cpp                | 28 ++++++++++++++++++++++++----
 src/gps/RTC.h                  |  3 +++
 src/modules/PositionModule.cpp | 18 +++++++++++-------
 src/modules/PositionModule.h   |  1 +
 4 files changed, 39 insertions(+), 11 deletions(-)

diff --git a/src/gps/RTC.cpp b/src/gps/RTC.cpp
index 26af7cac2..85931900f 100644
--- a/src/gps/RTC.cpp
+++ b/src/gps/RTC.cpp
@@ -104,13 +104,15 @@ bool perhapsSetRTC(RTCQuality q, const struct timeval *tv)
     bool shouldSet;
     if (q > currentQuality) {
         shouldSet = true;
-        LOG_DEBUG("Upgrading time to quality %d\n", q);
-    } else if (q == RTCQualityGPS && (now - lastSetMsec) > (12 * 60 * 60 * 1000UL)) {
-        // Every 12 hrs we will slam in a new GPS time, to correct for local RTC clock drift
+        LOG_DEBUG("Upgrading time to quality %s\n", RtcName(q));
+    } else if (q >= RTCQualityNTP && (now - lastSetMsec) > (12 * 60 * 60 * 1000UL)) {
+        // Every 12 hrs we will slam in a new GPS or Phone GPS / NTP time, to correct for local RTC clock drift
         shouldSet = true;
         LOG_DEBUG("Reapplying external time to correct clock drift %ld secs\n", tv->tv_sec);
-    } else
+    } else {
         shouldSet = false;
+        LOG_DEBUG("Current RTC quality: %s. Ignoring time of RTC quality of %s\n", RtcName(currentQuality), RtcName(q));
+    }
 
     if (shouldSet) {
         currentQuality = q;
@@ -162,6 +164,24 @@ bool perhapsSetRTC(RTCQuality q, const struct timeval *tv)
     }
 }
 
+const char *RtcName(RTCQuality quality)
+{
+    switch (quality) {
+    case RTCQualityNone:
+        return "None";
+    case RTCQualityDevice:
+        return "Device";
+    case RTCQualityFromNet:
+        return "Net";
+    case RTCQualityNTP:
+        return "NTP";
+    case RTCQualityGPS:
+        return "GPS";
+    default:
+        return "Unknown";
+    }
+}
+
 /**
  * Sets the RTC time if the provided time is of higher quality than the current RTC time.
  *
diff --git a/src/gps/RTC.h b/src/gps/RTC.h
index 0561819bd..1d609f136 100644
--- a/src/gps/RTC.h
+++ b/src/gps/RTC.h
@@ -28,6 +28,9 @@ RTCQuality getRTCQuality();
 bool perhapsSetRTC(RTCQuality q, const struct timeval *tv);
 bool perhapsSetRTC(RTCQuality q, struct tm &t);
 
+/// Return a string name for the quality
+const char *RtcName(RTCQuality quality);
+
 /// Return time since 1970 in secs.  While quality is RTCQualityNone we will be returning time based at zero
 uint32_t getTime(bool local = false);
 
diff --git a/src/modules/PositionModule.cpp b/src/modules/PositionModule.cpp
index 250daec57..658b8b5a7 100644
--- a/src/modules/PositionModule.cpp
+++ b/src/modules/PositionModule.cpp
@@ -71,14 +71,8 @@ bool PositionModule::handleReceivedProtobuf(const meshtastic_MeshPacket &mp, mes
               p.time);
 
     if (p.time && channels.getByIndex(mp.channel).role == meshtastic_Channel_Role_PRIMARY) {
-        struct timeval tv;
-        uint32_t secs = p.time;
-
-        tv.tv_sec = secs;
-        tv.tv_usec = 0;
-
         // Set from phone RTC Quality to RTCQualityNTP since it should be approximately so
-        perhapsSetRTC(isLocal ? RTCQualityNTP : RTCQualityFromNet, &tv);
+        trySetRtc(p, isLocal);
     }
 
     nodeDB->updatePosition(getFrom(&mp), p);
@@ -93,6 +87,16 @@ bool PositionModule::handleReceivedProtobuf(const meshtastic_MeshPacket &mp, mes
     return false; // Let others look at this message also if they want
 }
 
+void PositionModule::trySetRtc(meshtastic_Position p, bool isLocal)
+{
+    struct timeval tv;
+    uint32_t secs = p.time;
+
+    tv.tv_sec = secs;
+    tv.tv_usec = 0;
+    perhapsSetRTC(isLocal ? RTCQualityNTP : RTCQualityFromNet, &tv);
+}
+
 meshtastic_MeshPacket *PositionModule::allocReply()
 {
     if (precision == 0) {
diff --git a/src/modules/PositionModule.h b/src/modules/PositionModule.h
index 0e24e3a9e..89ff50c64 100644
--- a/src/modules/PositionModule.h
+++ b/src/modules/PositionModule.h
@@ -52,6 +52,7 @@ class PositionModule : public ProtobufModule<meshtastic_Position>, private concu
   private:
     struct SmartPosition getDistanceTraveledSinceLastSend(meshtastic_PositionLite currentPosition);
     meshtastic_MeshPacket *allocAtakPli();
+    void trySetRtc(meshtastic_Position p, bool isLocal);
     uint32_t precision;
     void sendLostAndFoundText();