CLI: Add rtkRemoteFirmwareVersion and UPDATEFIRMWARE commands

Author: nseidle

Firmware/RTK_Everywhere/menuCommands.ino

@@ -1,3 +1,5 @@
+char otaOutcome[21] = {0}; // Modified by otaUpdate(), used to respond to rtkRemoteFirmwareVersion commands
+
 void menuCommands()
 {
     char cmdBuffer[200];
@@ -270,6 +272,16 @@ t_cliResult processCommand(char *cmdBuffer)
                 factoryReset(false); // We do not have the SD semaphore
                 return (CLI_OK);     // We should never get this far.
             }
+            else if (strcmp(tokens[1], "UPDATEFIRMWARE") == 0)
+            {
+                // Begin a firmware update. WiFi networks and enableRCFirmware should previously be set.
+                commandSendExecuteOkResponse(tokens[0], tokens[1]);
+                otaRequestFirmwareUpdate = true;
+
+                // Force exit all config menus and/or command modes to allow OTA state machine to run
+                btPrintEchoExit = true;
+                return (CLI_EXIT); // Exit the CLI to allow OTA state machine to run
+            }
             else
             {
                 commandSendErrorResponse(tokens[0], tokens[1], (char *)"Unknown command");
@@ -427,6 +439,7 @@ void commandSendErrorResponse(const char *command, const char *settingName, cons
     snprintf(innerBuffer, sizeof(innerBuffer), "%s,%s,,ERROR,%s", command, settingName, errorVerbose);
     commandSendResponse(innerBuffer);
 }
+
 // Given a command, send structured ERROR response
 // Response format: $SPxET,,,ERROR,[Verbose error description]*FF<CR><LF>
 // Ex: SPGET, 'Incorrect number of arguments' = "$SPGET,ERROR,Incorrect number of arguments*1E"
@@ -2949,6 +2962,17 @@ SettingValueResponse getSettingValue(bool inCommands, const char *settingName, c
         knownSetting = true;
         settingIsString = true;
     }
+    else if (strcmp(settingName, "rtkRemoteFirmwareVersion") == 0)
+    {
+        // otaUpdate() is synchronous and called from loop() so we respond here with OK, then go check the firmware version
+        writeToString(settingValueStr, (char *)"OK");
+        knownSetting = true;
+
+        otaRequestFirmwareVersionCheck = true;
+
+        // Force exit all config menus and/or command modes to allow OTA state machine to run
+        btPrintEchoExit = true;
+    }
 
     // Special actions
     else if (strcmp(settingName, "enableRCFirmware") == 0)
@@ -3532,6 +3556,10 @@ const char *commandGetName(int stringIndex, int rtkIndex)
     else if (rtkIndex == COMMAND_FIRMWARE_VERSION)
         return "rtkFirmwareVersion";
 
+    // Connect to the internet and retrieve the remote firmware version
+    else if (rtkIndex == COMMAND_REMOTE_FIRMWARE_VERSION)
+        return "rtkRemoteFirmwareVersion";
+
     // Display the device ID - used in PointPerfect
     else if (rtkIndex == COMMAND_DEVICE_ID)
         return "deviceId";
@@ -3777,6 +3805,13 @@ void printAvailableSettings()
             commandSendExecuteListResponse("rtkFirmwareVersion", settingType, printRtkFirmwareVersion());
         }
 
+        // Display the current RTK Firmware version
+        else if (commandIndex[i] == COMMAND_REMOTE_FIRMWARE_VERSION)
+        {
+            // Report the avialable command but without data. That requires the user issue separate SPGET.
+            commandSendExecuteListResponse("rtkRemoteFirmwareVersion", "char[21]", "NotYetRetreived");
+        }
+
         // Display the device ID - used in PointPerfect
         else if (commandIndex[i] == COMMAND_DEVICE_ID)
         {

Firmware/RTK_Everywhere/menuFirmware.ino

@@ -581,8 +581,15 @@ void otaDisplayPercentage(int bytesWritten, int totalLength, bool alwaysDisplay)
         if (bytesWritten == totalLength)
             systemPrintln("]");
 
+        // Display progress on the display
         displayFirmwareUpdateProgress(percent);
 
+        // Report progress over the BLE Command Channel
+        char stringPercent[5];
+        snprintf(stringPercent, sizeof(stringPercent), "%d", percent);
+        commandSendStringOkResponse((char *)"SPEXE", (char *)"UPDATEPROGRESS", stringPercent);
+
+        // Report progress to the Web Config socket
         if (apConfigFirmwareUpdateInProcess == true)
         {
             char myProgress[50];
@@ -819,7 +826,7 @@ void otaUpdate()
             otaUpdateStop();
             break;
 
-        // Wait for a request from a user or from the scheduler
+        // Wait for a request from a user, the Web Config, CLI, or from the scheduler
         case OTA_STATE_OFF:
             if (otaRequestFirmwareVersionCheck || otaRequestFirmwareUpdate)
             {
@@ -849,14 +856,31 @@ void otaUpdate()
 
             else if ((millis() - connectTimer) > (10 * MILLISECONDS_IN_A_SECOND))
             {
-                // Report failed connection to web client
+                if (settings.debugFirmwareUpdate)
+                    systemPrintln("Firmware update failed to connect to network");
+
+                // If we are connected to the Web Config or BLE CLI, then we assume the user
+                // is requesting the firmware update via those interfaces, thus we attempt an update
+                // only once, stopping the state machine on failure
+
                 if (websocketConnected)
                 {
-                    if (settings.debugFirmwareUpdate)
-                        systemPrintln("Firmware update failed to connect to network");
+                    // Report failed connection to web client
                     sendStringToWebsocket((char *)"newFirmwareVersion,NO_INTERNET,");
                     otaUpdateStop();
                 }
+
+                if (bluetoothCommandIsConnected())
+                {
+                    // Report failure to  the CLI
+                    if(otaRequestFirmwareUpdate)
+                        commandSendExecuteErrorResponse((char *)"SPEXE", (char *)"UPDATEFIRMWARE", (char *)"No Internet");
+                    else if(otaRequestFirmwareVersionCheck)
+                        commandSendErrorResponse((char *)"SPGET", (char *)"rtkRemoteFirmwareVersion", (char *)"No Internet");
+                    otaUpdateStop();
+                }
+
+
             }
             break;
 
@@ -904,6 +928,12 @@ void otaUpdate()
                             sendStringToWebsocket(newVersionCSV);
                         }
 
+                        if (bluetoothCommandIsConnected())
+                        {
+                            // Report value over the CLI
+                            commandSendStringResponse((char *)"SPGET", (char *)"rtkRemoteVersion", otaReportedVersion);
+                        }
+
                         otaUpdateStop();
                         return;
                     }
@@ -927,6 +957,12 @@ void otaUpdate()
                 systemPrintln("Failed to get version number from server.");
                 if (websocketConnected)
                     sendStringToWebsocket((char *)"newFirmwareVersion,NO_SERVER,");
+
+                // Report failure over the CLI
+                if (bluetoothCommandIsConnected())
+                    commandSendExecuteErrorResponse((char *)"SPGET", (char *)"rtkRemoteFimrwareVersion",
+                                                    (char *)"No Server");
+
                 otaUpdateStop();
             }
             break;
@@ -940,6 +976,11 @@ void otaUpdate()
 
                 if (websocketConnected)
                     sendStringToWebsocket((char *)"gettingNewFirmware,ERROR,");
+
+                // Report failure over the CLI
+                if (bluetoothCommandIsConnected())
+                    commandSendExecuteErrorResponse((char *)"SPEXE", (char *)"UPDATEFIRMWARE",
+                                                    (char *)"Connection Error");
             }
             else
             {
@@ -950,6 +991,10 @@ void otaUpdate()
                 if (websocketConnected)
                     sendStringToWebsocket((char *)"gettingNewFirmware,ERROR,");
 
+                // Report failure over the CLI
+                if (bluetoothCommandIsConnected())
+                    commandSendExecuteErrorResponse((char *)"SPEXE", (char *)"UPDATEFIRMWARE", (char *)"OTA Error");
+
                 otaUpdateStop();
             }
             break;

Firmware/RTK_Everywhere/settings.h

@@ -1207,12 +1207,13 @@ typedef struct
     const char *name;
 } RTK_Settings_Entry;
 
-#define COMMAND_PROFILE_0_INDEX     -1
-#define COMMAND_PROFILE_NUMBER      (COMMAND_PROFILE_0_INDEX - MAX_PROFILE_COUNT) // -1 - 8 = -9
-#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
+#define COMMAND_PROFILE_0_INDEX            -1
+#define COMMAND_PROFILE_NUMBER             (COMMAND_PROFILE_0_INDEX - MAX_PROFILE_COUNT) // -1 - 8 = -9
+#define COMMAND_FIRMWARE_VERSION           (COMMAND_PROFILE_NUMBER - 1) // -9 - 1 = -10
+#define COMMAND_REMOTE_FIRMWARE_VERSION    (COMMAND_FIRMWARE_VERSION - 1) // -10 - 1 = -11
+#define COMMAND_DEVICE_ID                  (COMMAND_REMOTE_FIRMWARE_VERSION - 1) // -11 - 1 = -12
+#define COMMAND_UNKNOWN                    (COMMAND_DEVICE_ID - 1) // -12 - 1 = -13
+#define COMMAND_COUNT                      (-(COMMAND_UNKNOWN)) // 13
 
 // Exit types for processCommand
 typedef enum