Correct use of prioritySettingsEnd - for Flex

Author: PaulZC

Firmware/RTK_Everywhere/menuCommands.ino

@@ -594,8 +594,8 @@ int commandLookupSettingNameSelective(bool inCommands, const char *settingName,
         prioritySettingsEnd = findEndOfPrioritySettings();
     // If "endOfPrioritySettings" is not found, prioritySettingsEnd will be zero
 
-    // Remove one because while rtkSettingsEntries[] contains detectedGnssReceiver, the command table does not
-    prioritySettingsEnd--;
+    // Adjust prioritySettingsEnd if needed - depending on platform type
+    prioritySettingsEnd = adjustEndOfPrioritySettings(prioritySettingsEnd);
 
     // Loop through the valid command entries - starting at prioritySettingsEnd
     for (int i = prioritySettingsEnd; i < commandCount; i++)
@@ -3783,6 +3783,23 @@ int findEndOfPrioritySettings()
     return prioritySettingsEnd;
 }
 
+int adjustEndOfPrioritySettings(int prioritySettingsEnd)
+{
+    // If prioritySettingsEnd is zero, don't adjust
+    if (prioritySettingsEnd == 0)
+        return 0;
+
+    // Check which of the priority settings are possible on this platform
+    // Deduct the ones which are not
+    for (int i = 0; i < prioritySettingsEnd; i++)
+    {
+        if (!settingPossibleOnPlatform(i))
+            prioritySettingsEnd--;
+    }
+
+    return prioritySettingsEnd;
+}
+
 // Allocate and fill the commandIndex table
 bool commandIndexFillPossible()
 {
@@ -3860,6 +3877,9 @@ bool commandIndexFill(bool usePossibleSettings)
     // If "endOfPrioritySettings" is not found, prioritySettingsEnd will be zero
     // and all settings will be sorted. Just like the good old days...
 
+    // Adjust prioritySettingsEnd if needed - depending on platform type
+    prioritySettingsEnd = adjustEndOfPrioritySettings(prioritySettingsEnd);
+
     if (settings.debugSettings || settings.debugCLI)
     {
         systemPrintf("commandCount %d\r\n", commandCount);

Firmware/RTK_Everywhere/settings.h

@@ -1260,7 +1260,12 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
 //    i  d  i  v  V  i  c  n  r  e    X
 //    g  s  x  k  2  c  h  d  d  x    2  Type       Qual                Variable                  Name
 
-    // Detected GNSS Receiver - for Flex. Save / load first so settingAvailableOnPlatform is correct on Flex
+
+    // =======================================================================================================
+    // Priority Settings which are not alphabetized in commandIndex
+    // =======================================================================================================
+
+    // Detected GNSS Receiver - only for Flex. Save / load first so settingAvailableOnPlatform is correct on Flex
     { 0, 0, 0, 0, 0, 0, 0, 0, 0, ALL, 0, tGnssReceiver,     0, & settings.detectedGnssReceiver, "detectedGnssReceiver",  },
 
     // Common settings which use the same name on multiple Flex platforms
@@ -1281,6 +1286,7 @@ const RTK_Settings_Entry rtkSettingsEntries[] =
 
     // <--- Insert any new essential "priority" (non-sorted) settings above this line --->
 
+    // endOfPrioritySettings is a special 'null' entry which does not appear in commandIndex
     { 0, 0, 0, 0, 0, 0, 0, 0, 0, NON, 0, _bool,     0, nullptr, "endOfPrioritySettings",  },
 
     // =======================================================================================================