Merge pull request #695 from LeeLeahy2/ota-auto-update

OtaClient: Automatic firmware download over WiFi

Author: nseidle

Firmware/RTK_Surveyor/Ethernet.ino

@@ -254,7 +254,8 @@ bool ethernetIsNeeded()
         return true;
 
     // Does PVT client or server need Ethernet?
-    if (settings.enablePvtClient || settings.enablePvtServer || settings.enablePvtUdpServer)
+    if (settings.enablePvtClient || settings.enablePvtServer
+        || settings.enablePvtUdpServer || settings.enableAutoFirmwareUpdate)
         return true;
 
     return false;

Firmware/RTK_Surveyor/Form.ino

@@ -757,6 +757,10 @@ void createSettingsString(char *newSettings)
     snprintf(ntpRefId, sizeof(ntpRefId), "%s", settings.ntpReferenceId);
     stringRecord(newSettings, "ntpReferenceId", ntpRefId);
 
+    // Automatic firmware update settings
+    stringRecord(newSettings, "enableAutoFirmwareUpdate", settings.enableAutoFirmwareUpdate);
+    stringRecord(newSettings, "autoFirmwareCheckMinutes", settings.autoFirmwareCheckMinutes);
+
     // Turn on SD display block last
     stringRecord(newSettings, "sdMounted", online.microSD);
 
@@ -1349,6 +1353,12 @@ void updateSettingWithValue(const char *settingName, const char *settingValueStr
     else if (strcmp(settingName, "mdnsEnable") == 0)
         settings.mdnsEnable = settingValueBool;
 
+    // Automatic firmware update settings
+    else if (strcmp(settingName, "enableAutoFirmwareUpdate") == 0)
+        settings.enableAutoFirmwareUpdate = settingValueBool;
+    else if (strcmp(settingName, "autoFirmwareCheckMinutes") == 0)
+        settings.autoFirmwareCheckMinutes = settingValueBool;
+
     // Unused variables - read to avoid errors
     else if (strcmp(settingName, "measurementRateSec") == 0)
     {

Firmware/RTK_Surveyor/NVM.ino

@@ -435,6 +435,11 @@ void recordSystemSettingsToFile(File *settingsFile)
     settingsFile->printf("%s=%d\r\n", "i2cInterruptsCore", settings.i2cInterruptsCore);
     settingsFile->printf("%s=%d\r\n", "rtcmTimeoutBeforeUsingLBand_s", settings.rtcmTimeoutBeforeUsingLBand_s);
 
+    // Automatic Firmware Update
+    settingsFile->printf("%s=%d\r\n", "autoFirmwareCheckMinutes", settings.autoFirmwareCheckMinutes);
+    settingsFile->printf("%s=%d\r\n", "debugFirmwareUpdate", settings.debugFirmwareUpdate);
+    settingsFile->printf("%s=%d\r\n", "enableAutoFirmwareUpdate", settings.enableAutoFirmwareUpdate);
+
     //Add new settings above
     //<------------------------------------------------------------>
 }
@@ -1344,6 +1349,14 @@ bool parseLine(char *str, Settings *settings)
     else if (strcmp(settingName, "rtcmTimeoutBeforeUsingLBand_s") == 0)
         settings->rtcmTimeoutBeforeUsingLBand_s = d;
 
+    // Automatic Firmware Update
+    else if (strcmp(settingName, "autoFirmwareCheckMinutes") == 0)
+        settings->autoFirmwareCheckMinutes = d;
+    else if (strcmp(settingName, "debugFirmwareUpdate") == 0)
+        settings->debugFirmwareUpdate = d;
+    else if (strcmp(settingName, "enableAutoFirmwareUpdate") == 0)
+        settings->enableAutoFirmwareUpdate = d;
+
     //Add new settings above
     //<------------------------------------------------------------>
 

Firmware/RTK_Surveyor/Network.ino

@@ -184,6 +184,7 @@ const char * const networkUser[] =
     "NTP Server",
     "NTRIP Client",
     "NTRIP Server",
+    "OTA Firmware Update",
     "PVT Client",
     "PVT Server",
     "PVT UDP Server",
@@ -893,6 +894,12 @@ void networkStop(uint8_t networkType)
                     ntripServerRestart();
                     break;
 
+                case NETWORK_USER_OTA_FIRMWARE_UPDATE:
+                    if (settings.debugNetworkLayer)
+                        systemPrintln("Network layer stopping OTA firmware update");
+                    otaStop();
+                    break;
+
                 case NETWORK_USER_PVT_CLIENT:
                     if (settings.debugNetworkLayer)
                         systemPrintln("Network layer stopping PVT client");
@@ -1159,6 +1166,7 @@ void networkUpdate()
         ntpServerUpdate();   // Process any received NTP requests
         ntripClientUpdate(); // Check the NTRIP client connection and move data NTRIP --> ZED
         ntripServerUpdate(); // Check the NTRIP server connection and move data ZED --> NTRIP
+        otaClientUpdate();   // Perform automatic over-the-air firmware updates
         pvtClientUpdate();   // Turn on the PVT client as needed
         pvtServerUpdate();   // Turn on the PVT server as needed
         pvtUdpServerUpdate();   // Turn on the PVT UDP server as needed