CLI: Add firmware version

Author: nseidle

Firmware/RTK_Everywhere/menuCommands.ino

@@ -263,7 +263,7 @@ t_cliResult processCommand(char *cmdBuffer)
                 // Apply factory defaults, then reset
                 commandSendExecuteOkResponse(tokens[0], tokens[1]);
                 factoryReset(false); // We do not have the SD semaphore
-                return (CLI_OK); //We should never get this far.
+                return (CLI_OK);     // We should never get this far.
             }
             else
             {
@@ -1516,9 +1516,7 @@ void createSettingsString(char *newSettings)
     strncpy(apPlatformPrefix, platformPrefixTable[productVariant], sizeof(apPlatformPrefix));
     stringRecord(newSettings, "platformPrefix", apPlatformPrefix);
 
-    char apRtkFirmwareVersion[86];
-    firmwareVersionGet(apRtkFirmwareVersion, sizeof(apRtkFirmwareVersion), true);
-    stringRecord(newSettings, "rtkFirmwareVersion", apRtkFirmwareVersion);
+    stringRecord(newSettings, "rtkFirmwareVersion", (char *)printRtkFirmwareVersion());
 
     char apGNSSFirmwareVersion[80];
     if (present.gnss_zedf9p)
@@ -2921,13 +2919,19 @@ SettingValueResponse getSettingValue(bool inCommands, const char *settingName, c
     else if (knownSetting == true)
         return (SETTING_KNOWN);
 
-    // Report deviceID over CLI - Useful for label generation
+    // Report special human-machine-interface settings
     if (strcmp(settingName, "deviceId") == 0)
     {
         writeToString(settingValueStr, (char *)printDeviceId());
         knownSetting = true;
         settingIsString = true;
     }
+    else if (strcmp(settingName, "rtkFirmwareVersion") == 0)
+    {
+        writeToString(settingValueStr, (char *)printRtkFirmwareVersion());
+        knownSetting = true;
+        settingIsString = true;
+    }
 
     // Special actions
     else if (strcmp(settingName, "enableRCFirmware") == 0)
@@ -3507,8 +3511,16 @@ const char *commandGetName(int stringIndex, int rtkIndex)
     else if (rtkIndex == COMMAND_PROFILE_NUMBER)
         return "profileNumber";
 
+    // Display the current firmware version number
+    else if (rtkIndex == COMMAND_FIRMWARE_VERSION)
+        return "rtkFirmwareVersion";
+
     // Display the device ID - used in PointPerfect
-    return "deviceId";
+    else if (rtkIndex == COMMAND_DEVICE_ID)
+        return "deviceId";
+
+    systemPrintln("commandGetName Error: Uncaught command type");
+    return "unknown";
 }
 
 // Determine if the setting is available on this platform
@@ -3658,7 +3670,7 @@ bool commandIndexFill(bool usePossibleSettings)
         }
     }
 
-    // Add the man-machine interface commands to the list
+    // Add the human-machine-interface commands to the list
     for (i = 1; i < COMMAND_COUNT; i++)
         commandIndex[commandCount++] = -i;
 
@@ -3667,8 +3679,10 @@ 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...
 
-    if (settings.debugSettings)
+    if (settings.debugSettings || settings.debugCLI)
     {
+        systemPrintf("commandCount %d\r\n", commandCount);
+
         if (prioritySettingsEnd > 0)
             systemPrintf("endOfPrioritySettings found at entry %d\r\n", prioritySettingsEnd);
         else
@@ -3714,7 +3728,7 @@ void printAvailableSettings()
                 commandList(false, commandIndex[i]);
         }
 
-        // Below are commands formed specifically for the Man-Machine-Interface
+        // Below are commands formed specifically for the Human-Machine-Interface
         // Display the profile name - used in Profiles
         else if (commandIndex[i] >= -MAX_PROFILE_COUNT)
         {
@@ -3736,6 +3750,16 @@ void printAvailableSettings()
             commandSendExecuteListResponse("profileNumber", "uint8_t", settingValue);
         }
 
+        // Display the current RTK Firmware version
+        else if (commandIndex[i] == COMMAND_FIRMWARE_VERSION)
+        {
+            // Create the settingType based on the length of the firmware version
+            char settingType[100];
+            snprintf(settingType, sizeof(settingType), "char[%d]", strlen(printRtkFirmwareVersion()));
+
+            commandSendExecuteListResponse("rtkFirmwareVersion", settingType, printRtkFirmwareVersion());
+        }
+
         // Display the device ID - used in PointPerfect
         else if (commandIndex[i] == COMMAND_DEVICE_ID)
         {

Firmware/RTK_Everywhere/menuFirmware.ino

@@ -166,6 +166,16 @@ void firmwareVersionGet(char *buffer, int bufferLength, bool includeDate)
     firmwareVersionFormat(FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR, buffer, bufferLength, includeDate);
 }
 
+// Returns string containing the current version number - ie "v2.0"
+const char *printRtkFirmwareVersion()
+{
+    // Create the firmware version string
+    static char rtkFirmwareVersion[86];
+    firmwareVersionGet(rtkFirmwareVersion, sizeof(rtkFirmwareVersion), true);
+
+    return ((const char *)rtkFirmwareVersion);
+}
+
 //----------------------------------------
 // Returns true if otaReportedVersion is newer than currentVersion
 // Version number comes in as v2.7-Jan 5 2023
@@ -885,7 +895,7 @@ void otaUpdate()
                     if (otaRequestFirmwareVersionCheck == true)
                     {
                         otaRequestFirmwareVersionCheck = false;
-                        
+
                         if (websocketConnected)
                         {
                             char newVersionCSV[40];

Firmware/RTK_Everywhere/settings.h

@@ -1209,9 +1209,10 @@ typedef struct
 
 #define COMMAND_PROFILE_0_INDEX     -1
 #define COMMAND_PROFILE_NUMBER      (COMMAND_PROFILE_0_INDEX - MAX_PROFILE_COUNT) // -1 - 8 = -9
-#define COMMAND_DEVICE_ID           (COMMAND_PROFILE_NUMBER - 1) // -9 - 1 = -10
-#define COMMAND_UNKNOWN             (COMMAND_DEVICE_ID - 1) // -10 - 1 = -11
-#define COMMAND_COUNT               (-(COMMAND_UNKNOWN)) // 11
+#define COMMAND_FIRMWARE_VERSION    (COMMAND_PROFILE_NUMBER - 1) // -9 - 1 = -10
+#define COMMAND_DEVICE_ID           (COMMAND_FIRMWARE_VERSION - 1) // -10 - 1 = -11
+#define COMMAND_UNKNOWN             (COMMAND_DEVICE_ID - 1) // -11 - 1 = -12
+#define COMMAND_COUNT               (-(COMMAND_UNKNOWN)) // 12
 
 // Exit types for processCommand
 typedef enum