Merge pull request #720 from sparkfun/pcUpdates

pcUpdates -> release_candidate

Author: nseidle

Firmware/RTK_Everywhere/Begin.ino

@@ -1529,10 +1529,6 @@ void beginSystemState()
 
         // Return to either Base or Rover Not Started. The last state previous to power down.
         systemState = settings.lastState;
-
-        // If the setting is not set, override with default
-        if (settings.antennaPhaseCenter_mm == 0.0)
-            settings.antennaPhaseCenter_mm = present.antennaPhaseCenter_mm;
     }
     else if (productVariant == RTK_POSTCARD)
     {

Firmware/RTK_Everywhere/GNSS_UM980.ino

@@ -252,8 +252,8 @@ bool GNSS_UM980::configureOnce()
     response &= _um980->setPortBaudrate("COM2", 115200); // COM2 is connected to the IMU
     response &= _um980->setPortBaudrate("COM3", 115200); // COM3 is connected to the switch, then ESP32
 
-    // For now, let's not change the baud rate of the interface. We'll be using the default 115200 for now.
-    response &= setBaudRateCOM3(settings.dataPortBaud); // COM3 is connected to ESP UART2
+    //  // For now, let's not change the baud rate of the interface. We'll be using the default 115200 for now.
+    //  response &= setBaudRateCOM3(settings.dataPortBaud); // COM3 is connected to ESP UART2
 
     // Enable PPS signal with a width of 200ms, and a period of 1 second
     response &= _um980->enablePPS(200000, 1000); // widthMicroseconds, periodMilliseconds

Firmware/RTK_Everywhere/System.ino

@@ -391,6 +391,9 @@ void settingsToDefaults()
 {
     static const Settings defaultSettings;
     settings = defaultSettings;
+
+    checkArrayDefaults(); // This does not call recordSystemSettings
+    checkGNSSArrayDefaults(); // This calls recordSystemSettings if any GNSS defaults are applied
 }
 
 // Periodically print information if enabled

Firmware/RTK_Everywhere/WebServer.ino

@@ -63,8 +63,8 @@ static int last_ws_fd;
 
 static TaskHandle_t updateWebServerTaskHandle;
 static const uint8_t updateWebServerTaskPriority = 0; // 3 being the highest, and 0 being the lowest
-static const int webServerTaskStackSize = 1024 * 4;
-static const int webSocketStackSize = 1024 * 20; // Needs to be large enough to hold the file manager file list
+static const int webServerTaskStackSize = 1024 * 4; // Needs to be large enough to hold the file manager file list
+static const int webSocketStackSize = 1024 * 20; // Needs to be large enough to hold the full settingsCSV
 
 // Inspired by:
 // https://github.com/espressif/arduino-esp32/blob/master/libraries/WebServer/examples/MultiHomedServers/MultiHomedServers.ino
@@ -1375,6 +1375,34 @@ static const httpd_uri_t ws = {.uri = "/ws",
 //----------------------------------------
 void httpdDisplayConfig(struct httpd_config *config)
 {
+    /*
+    httpd_config object:
+            5: task_priority
+        20480: stack_size
+    2147483647: core_id
+            81: server_port
+        32768: ctrl_port
+            7: max_open_sockets
+            8: max_uri_handlers
+            8: max_resp_headers
+            5: backlog_conn
+        false: lru_purge_enable
+            5: recv_wait_timeout
+            5: send_wait_timeout
+    0x0: global_user_ctx
+    0x0: global_user_ctx_free_fn
+    0x0: global_transport_ctx
+    0x0: global_transport_ctx_free_fn
+        false: enable_so_linger
+            0: linger_timeout
+        false: keep_alive_enable
+            0: keep_alive_idle
+            0: keep_alive_interval
+            0: keep_alive_count
+    0x0: open_fn
+    0x0: close_fn
+    0x0: uri_match_fn
+    */
     systemPrintf("httpd_config object:\r\n");
     systemPrintf("%10d: task_priority\r\n", config->task_priority);
     systemPrintf("%10d: stack_size\r\n", config->stack_size);
@@ -1416,7 +1444,7 @@ bool websocketServerStart(void)
     // Use different ports for websocket and webServer - use port 81 for the websocket - also defined in main.js
     config.server_port = 81;
 
-    // Increase the stack size from 4K to handle page processing
+    // Increase the stack size from 4K to handle page processing (settingsCSV)
     config.stack_size = webSocketStackSize;
 
     // Start the httpd server

Firmware/RTK_Everywhere/menuCommands.ino

@@ -2016,9 +2016,6 @@ void createSettingsString(char *newSettings)
     }
     stringRecord(newSettings, "lastState", lastState);
 
-    stringRecord(
-        newSettings, "profileName",
-        profileNames[profileNumber]); // Must come before profile number so AP config page JS has name before number
     stringRecord(newSettings, "profileNumber", profileNumber);
     for (int index = 0; index < MAX_PROFILE_COUNT; index++)
     {

Firmware/RTK_Everywhere/menuMessages.ino

@@ -655,6 +655,13 @@ void checkGNSSArrayDefaults()
 #ifdef COMPILE_UM980
     else if (present.gnss_um980)
     {
+        if (settings.dataPortBaud != 115200)
+        {
+            // Belt and suspenders... Let's make really sure COM3 only ever runs at 115200
+            defaultsApplied = true;
+            settings.dataPortBaud = 115200;
+        }
+
         if (settings.dynamicModel == 254)
         {
             defaultsApplied = true;
@@ -829,19 +836,25 @@ void checkGNSSArrayDefaults()
     }
 #endif  // COMPILE_LG290P
 
+    // If defaults have been applied, override antennaPhaseCenter_mm with default
+    // (This was in beginSystemState - for the Torch / UM980 only. Weird...)
+    if (defaultsApplied)
+    {
+        settings.antennaPhaseCenter_mm = present.antennaPhaseCenter_mm;
+    }
 
     // If defaults were applied, also default the non-array settings for this particular GNSS receiver
     if (defaultsApplied == true)
     {
         if (present.gnss_um980)
         {
-            settings.minCNO = 10;                    // Default 10 degrees
+            settings.minCNO = 10;                    // Default 10 dBHz
             settings.surveyInStartingAccuracy = 2.0; // Default 2m
             settings.measurementRateMs = 500;        // Default 2Hz.
         }
         else if (present.gnss_zedf9p)
         {
-            settings.minCNO = 6;                     // Default 6 degrees
+            settings.minCNO = 6;                     // Default 6 dBHz
             settings.surveyInStartingAccuracy = 1.0; // Default 1m
             settings.measurementRateMs = 250;        // Default 4Hz.
         }

Firmware/RTK_Everywhere/settings.h

@@ -926,7 +926,7 @@ struct Settings
     // Rover operation
     uint8_t dynamicModel = 254; // Default will be applied by checkGNSSArrayDefaults
     bool enablePrintRoverAccuracy = true;
-    int16_t minCNO = 6;                 // Minimum satellite signal level for navigation. ZED-F9P default is 6 dBHz
+    int16_t minCNO = 6;   // Minimum satellite signal level for navigation. ZED-F9P default is 6 dBHz
     uint8_t minElev = 10; // Minimum elevation (in deg) for a GNSS satellite to be used in NAV
 
     // RTC (Real Time Clock)
@@ -1593,7 +1593,7 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
     // Rover operation
     { 1, 1, 0, 1, 1, 1, 1, 1, 0, ALL, _uint8_t,  0, & settings.dynamicModel, "dynamicModel",  },
     { 0, 0, 0, 1, 1, 1, 1, 1, 1, ALL, _bool,     0, & settings.enablePrintRoverAccuracy, "enablePrintRoverAccuracy",  },
-    { 1, 1, 0, 1, 1, 1, 1, 1, 1, ALL, _int16_t,  0, & settings.minCNO, "minCNO",  },
+    { 0, 1, 0, 1, 1, 1, 1, 1, 1, ALL, _int16_t,  0, & settings.minCNO, "minCNO",  }, // Not inWebConfig - createSettingsString gets from GNSS
     { 1, 1, 0, 1, 1, 1, 1, 1, 1, ALL, _uint8_t,  0, & settings.minElev, "minElev",  },
 
     // RTC (Real Time Clock)
@@ -1649,7 +1649,7 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
     // State
     { 0, 0, 0, 1, 1, 1, 1, 1, 1, ALL, _bool,     0, & settings.enablePrintDuplicateStates, "enablePrintDuplicateStates",  },
     { 0, 0, 0, 1, 1, 1, 1, 1, 1, ALL, _bool,     0, & settings.enablePrintStates, "enablePrintStates",  },
-    { 1, 1, 0, 1, 1, 1, 1, 1, 1, ALL, tSysState, 0, & settings.lastState, "lastState",  },
+    { 0, 1, 0, 1, 1, 1, 1, 1, 1, ALL, tSysState, 0, & settings.lastState, "lastState",  }, // Not inWebConfig - must be changed to 0:3 by createSettingsString
 
     // TCP Client
     { 0, 0, 0, 1, 1, 1, 1, 1, 1, ALL, _bool,     0, & settings.debugTcpClient, "debugTcpClient",  },

Firmware/Tools/Settings_Diff.py

@@ -0,0 +1,118 @@
+# Performs a 'diff' on two RTK (Everywhere) Firmware settings CSV files
+#
+# E.g. the settings CSVs passed between the firmware and the web config javascript
+# The order of the settings going in one direction is very different to the other direction,
+# making it tricky to compare them directly
+# This code performs an exhaustive diff: looking for differences between the two;
+# any duplicates; and finding any settings present in one but not the other
+
+import sys
+import os
+
+class RTK_Settings_Diff():
+
+    def __init__(self, File1:str = None, File2:str = None):
+        self.filename1 = File1
+        self.filename2 = File2
+
+    def setFilename1(self, File:str):
+        self.filename1 = File
+
+    def setFilename2(self, File:str):
+        self.filename2 = File
+
+    def readByte(self, fi):
+        fileBytes = fi.read(1)
+        if (len(fileBytes) == 0):
+            return None
+        #print(chr(fileBytes[0]))
+        return chr(fileBytes[0])
+    
+    def readFile(self, filename):
+        print('Processing',filename)
+        print()
+        filesize = os.path.getsize(filename) # Record the file size
+
+        # Try to open file for reading
+        try:
+            fi = open(filename,"rb")
+        except:
+            raise Exception('Invalid file!')
+        
+        # Read the file
+        firstThing = ''
+        secondThing = ''
+        isFirstThing = True
+        things = {}
+
+        while filesize > 0:
+            c = self.readByte(fi)
+            if c == None:
+                fi.close()
+                return things
+            elif c == ',':
+                isFirstThing = not isFirstThing
+                if isFirstThing:
+                    if firstThing in things.keys(): # Seen it before?
+                        print('Duplicate setting: {},{} : {}'.format(firstThing, things[firstThing], secondThing))
+                    things[firstThing] = secondThing
+                    firstThing = ''
+                    secondThing = ''
+                    #print(firstThing, secondThing)
+            elif c == '\r':
+                pass
+            elif c == '\n':
+                pass
+            else:
+                if isFirstThing:
+                    firstThing = firstThing + str(c)
+                else:
+                    secondThing = secondThing + str(c)
+            filesize = filesize - 1
+        
+        fi.close()
+        return things
+
+    def diff(self):
+
+        print()
+
+        things1 = self.readFile(self.filename1)
+        #print(things1)
+
+        print()
+
+        things2 = self.readFile(self.filename2)
+        #print(things2)
+
+        print()
+
+        for thing1 in things1.keys():
+            if thing1 not in things2.keys():
+                print('Only found in file 1 : {},{}'.format(thing1,things1[thing1]))
+
+        print()
+
+        for thing2 in things2.keys():
+            if thing2 not in things1.keys():
+                print('Only found in file 2 : {},{}'.format(thing2,things2[thing2]))
+
+        print()
+
+        for thing1 in things1.keys():
+            if thing1 in things2.keys():
+                if things1[thing1] != things2[thing1]:
+                    print('Diff: {},{} : {}'.format(thing1,things1[thing1],things2[thing1]))
+
+if __name__ == '__main__':
+
+    import argparse
+
+    parser = argparse.ArgumentParser(description='SparkFun RTK Firmware Settings CSV Diff')
+    parser.add_argument('File1', metavar='File1', type=str, help='The path to the first settings CSV file')
+    parser.add_argument('File2', metavar='File2', type=str, help='The path to the second settings CSV file')
+    args = parser.parse_args()
+
+    diff = RTK_Settings_Diff(args.File1, args.File2)
+
+    diff.diff()