Add settings.alignedLogFiles - resolves #630

Author: PaulZC

Firmware/RTK_Everywhere/AP-Config/index.html

@@ -2016,7 +2016,7 @@
                             <label for="maxLogTime" class="box-margin40 col-sm-3 col-7 col-form-label">Max Logging
                                 Time (min):
                                 <span class="tt" data-bs-placement="right"
-                                    title="Once the max log time is achieved, logging will cease. This is useful for limiting long term, overnight, static surveys to a certain length of time. Default: 1440 minutes. Limits: 1 to 2880 minutes.">
+                                    title="Once the max log time is achieved, logging will cease. This is useful for limiting long term, overnight, static surveys to a certain length of time. Default: 1440 minutes. Limits: 0 to 1,051,200 minutes. 0 = no limit.">
                                     <span class="icon-info-circle text-primary ms-2"></span>
                                 </span>
                             </label>
@@ -2027,15 +2027,23 @@
                         <div class="form-group row">
                             <label for="maxLogLength" class="box-margin40 col-sm-3 col-7 col-form-label">Max Log
                                 File Length (min):<span class="tt" data-bs-placement="right"
-                                    title="Once this length of time is achieved, a new log will be created. This is useful for creating multiple logs over a long survey. Default: 1440 minutes. Limits: 1 to 2880 minutes.">
+                                    title="Once this length of time is achieved, a new log will be created. This is useful for creating multiple logs over a long survey. Default: 1440 minutes. Limits: 0 to 2880 minutes. 0 = no limit.">
                                     <span class="icon-info-circle text-primary ms-2"></span>
                                 </span>
                             </label>
-
                             <input type="number" class="form-control box-small" id="maxLogLength">
                             <p id="maxLogLengthError" class="inlineError"></p>
                         </div>
 
+                        <div class="form-check mt-1 box-margin20">
+                            <label class="form-check-label" for="alignedLogFiles">Aligned Log Files</label>
+                            <input class="form-check-input" type="checkbox" value="" id="alignedLogFiles" unchecked>
+                            <span class="tt" data-bs-placement="right"
+                                title="If enabled, log files will be aligned to the Max Log File Length. Only possible if the Max Log Length is an integral fraction of 24 hours.">
+                                <span class="icon-info-circle text-primary ms-2"></span>
+                            </span>
+                        </div>
+
                         <div id="logFile" class="row">
                             <div class="mb-2">
                                 <label for="logFile" class="form-group box-margin20">Log file name: <span

Firmware/RTK_Everywhere/AP-Config/src/main.js

@@ -1004,8 +1004,8 @@ function validateFields() {
 
     //System Config
     if (ge("enableLogging").checked == true) {
-        checkElementValue("maxLogTime", 1, 1051200, "Must be 1 to 1,051,200", "collapseSystemConfig");
-        checkElementValue("maxLogLength", 1, 1051200, "Must be 1 to 1,051,200", "collapseSystemConfig");
+        checkElementValue("maxLogTime", 0, 1051200, "Must be 0 to 1,051,200", "collapseSystemConfig");
+        checkElementValue("maxLogLength", 0, 2880, "Must be 0 to 2880", "collapseSystemConfig");
     }
     else {
         clearElement("maxLogTime", 60 * 24);

Firmware/RTK_Everywhere/RTK_Everywhere.ino

@@ -325,9 +325,8 @@ SdFat *sd;
 
 SdFile *logFile;                  // File that all GNSS messages sentences are written to
 unsigned long lastUBXLogSyncTime; // Used to record to SD every half second
-int startLogTime_minutes;         // Mark when we start any logging so we can stop logging after maxLogTime_minutes
-int startCurrentLogTime_minutes;
-// Mark when we start this specific log file so we can close it after x minutes and start a new one
+int startLogTime_minutes;         // Mark when we (re)start any logging so we can stop logging after maxLogTime_minutes
+unsigned long nextLogTime_ms;     // Open the next log file at this many millis()
 
 // System crashes if two tasks access a file at the same time
 // So we use a semaphore to see if the file system is available
@@ -1474,7 +1473,10 @@ bool logLengthExceeded() // Limit individual files to maxLogLength_minutes
     if (settings.maxLogLength_minutes == 0) // No limit if maxLogLength_minutes is zero
         return false;
 
-    return ((systemTime_minutes - startCurrentLogTime_minutes) >= settings.maxLogLength_minutes);
+    if (nextLogTime_ms == 0) // Keep logging if nextLogTime_ms has not been set
+        return false;
+    
+    return (millis() >= nextLogTime_ms); // Note: this will roll over every ~50 days...
 }
 
 // Create or close files as needed (startup or as the user changes settings)

Firmware/RTK_Everywhere/menuMessages.ino

@@ -98,6 +98,9 @@ void menuLog()
         else if (incoming == 2 && settings.enableLogging == true)
         {
             // Arbitrary 2 year limit. See https://github.com/sparkfun/SparkFun_RTK_Firmware/issues/86
+            // Note: the 2 year limit is fine. But systemTime_minutes is based on millis(), and millis()
+            //       will roll over every 2^32ms = ~50 days...
+            //       TODO: use the GNSS epoch (uint32_t seconds plus uint32_t microseconds) to resolve this.
             getNewSetting("Enter max minutes before logging stops", 0, 60 * 24 * 365 * 2, &settings.maxLogTime_minutes);
         }
         else if (incoming == 3 && settings.enableLogging == true)
@@ -288,7 +291,24 @@ bool beginLogging(const char *customFileName)
 
                 sdUpdateFileCreateTimestamp(logFile); // Update the file to create time & date
 
-                startCurrentLogTime_minutes = millis() / 1000L / 60; // Mark now as start of logging
+                // Calculate the time of the next log file change
+                nextLogTime_ms = 0; // Default to no limit
+                if ((settings.alignedLogFiles) && (settings.maxLogLength_minutes > 0))
+                {
+                    // Aligned logging is only possible if the interval is an integral fraction of 24 hours
+                    if ((24 * 60 * 2) % settings.maxLogLength_minutes == 0)
+                    {
+                        // Calculate when the next log file should be opened - in millis()
+                        unsigned long hoursAsMillis = rtc.getMillis() + (rtc.getSecond() * 1000)
+                                                      + (rtc.getMinute() * 1000 * 60) + (rtc.getHour(true) * 1000 * 60 * 60);
+                        unsigned long maxLogLength_ms = (unsigned long)settings.maxLogLength_minutes * 60 * 1000;
+                        unsigned long millisFromPreviousLog = hoursAsMillis % maxLogLength_ms;
+                        unsigned long millisToNextLog = maxLogLength_ms - millisFromPreviousLog;
+                        nextLogTime_ms = millis() + millisToNextLog;
+                    }
+                }
+                if ((nextLogTime_ms == 0) && (settings.maxLogLength_minutes > 0)) // Non-aligned logging
+                    nextLogTime_ms = millis() + ((unsigned long)settings.maxLogLength_minutes * 60 * 1000);
 
                 // Add NMEA txt message with restart reason
                 char rstReason[30];

Firmware/RTK_Everywhere/settings.h

@@ -726,7 +726,8 @@ struct Settings
     bool debugHttpClientState = false; // Debug the HTTP Client state machine
 
     // Log file
-    bool enableLogging = true;         // If an SD card is present, log default sentences
+    bool alignedLogFiles = false; // If true, align log files as per #630
+    bool enableLogging = true;    // If an SD card is present, log default sentences
     bool enablePrintLogFileMessages = false;
     bool enablePrintLogFileStatus = true;
     int maxLogLength_minutes = 60 * 24; // Default to 24 hours
@@ -1338,6 +1339,7 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
 //    g  s  x  k  2  c  h  d  d  Type    Qual  Variable                  Name
 
     // Log file
+    { 1, 1, 0, 1, 1, 1, 0, 1, 1, _bool,     0, & settings.alignedLogFiles, "alignedLogFiles",  },
     { 1, 1, 0, 1, 1, 1, 0, 1, 1, _bool,     0, & settings.enableLogging, "enableLogging",  },
     { 0, 0, 0, 1, 1, 1, 0, 1, 1, _bool,     0, & settings.enablePrintLogFileMessages, "enablePrintLogFileMessages",  },
     { 0, 0, 0, 1, 1, 1, 0, 1, 1, _bool,     0, & settings.enablePrintLogFileStatus, "enablePrintLogFileStatus",  },