Add OTA support for Ethernet

Author: LeeLeahy2

Firmware/RTK_Everywhere/menuFirmware.ino

@@ -11,8 +11,8 @@ menuFirmware.ino
 #ifdef COMPILE_OTA_AUTO
 
 static const char *const otaStateNames[] = {"OTA_STATE_OFF",
-                                            "OTA_STATE_START_WIFI",
-                                            "OTA_STATE_WAIT_FOR_WIFI",
+                                            "OTA_STATE_START_NETWORK",
+                                            "OTA_STATE_WAIT_FOR_NETWORK",
                                             "OTA_STATE_GET_FIRMWARE_VERSION",
                                             "OTA_STATE_CHECK_FIRMWARE_VERSION",
                                             "OTA_STATE_UPDATE_FIRMWARE"};
@@ -468,74 +468,87 @@ const char *otaGetUrl()
 bool otaCheckVersion(char *versionAvailable, uint8_t versionAvailableLength)
 {
     bool gotVersion = false;
-#ifdef COMPILE_WIFI
+#ifdef COMPILE_NETWORK
     bool previouslyConnected = wifiIsConnected();
 
     bool wasInAPmode;
 
-    if (wifiConnect(settings.wifiConnectTimeoutMs, true, &wasInAPmode) == true) // Use WIFI_AP_STA if already in WIFI_AP mode
+    uint8_t networkType = networkGetActiveType();
+    if ((networkType == NETWORK_TYPE_WIFI)
+        && (wifiNetworkCount() == 0))
+    {
+        systemPrintln("Error: Please enter at least one SSID before getting keys");
+    }
+    else
     {
-        char versionString[21];
-        getFirmwareVersion(versionString, sizeof(versionString), enableRCFirmware);
-        systemPrintf("Current firmware version: %s\r\n", versionString);
+        if ((networkType != NETWORK_TYPE_WIFI)
+            || (wifiConnect(settings.wifiConnectTimeoutMs, true, &wasInAPmode) == true)) // Use WIFI_AP_STA if already in WIFI_AP mode
+        {
+            char versionString[21];
+            getFirmwareVersion(versionString, sizeof(versionString), enableRCFirmware);
+            systemPrintf("Current firmware version: %s\r\n", versionString);
 
-        const char *url = otaGetUrl();
-        systemPrintf("Checking to see if an update is available from %s\r\n", url);
+            const char *url = otaGetUrl();
+            systemPrintf("Checking to see if an update is available from %s\r\n", url);
 
-        ESP32OTAPull ota;
+            ESP32OTAPull ota;
 
-        int response = ota.CheckForOTAUpdate(url, versionString, ESP32OTAPull::DONT_DO_UPDATE);
+            int response = ota.CheckForOTAUpdate(url, versionString, ESP32OTAPull::DONT_DO_UPDATE);
 
-        // We don't care if the library thinks the available firmware is newer, we just need a successful JSON parse
-        if (response == ESP32OTAPull::UPDATE_AVAILABLE || response == ESP32OTAPull::NO_UPDATE_AVAILABLE)
-        {
-            gotVersion = true;
+            // We don't care if the library thinks the available firmware is newer, we just need a successful JSON parse
+            if (response == ESP32OTAPull::UPDATE_AVAILABLE || response == ESP32OTAPull::NO_UPDATE_AVAILABLE)
+            {
+                gotVersion = true;
 
-            // Call getVersion after original inquiry
-            String otaVersion = ota.GetVersion();
-            otaVersion.toCharArray(versionAvailable, versionAvailableLength);
-        }
-        else if (response == ESP32OTAPull::HTTP_FAILED)
-        {
-            systemPrintln("Firmware server not available");
+                // Call getVersion after original inquiry
+                String otaVersion = ota.GetVersion();
+                otaVersion.toCharArray(versionAvailable, versionAvailableLength);
+            }
+            else if (response == ESP32OTAPull::HTTP_FAILED)
+            {
+                systemPrintln("Firmware server not available");
+            }
+            else
+            {
+                systemPrintln("OTA failed");
+            }
+
+            if (networkType == NETWORK_TYPE_WIFI)
+            {
+                // If we were in WIFI_AP mode, return to WIFI_AP mode
+                // There may be some overlap with systemState STATE_WIFI_CONFIG ? Not sure...
+                if (wasInAPmode)
+                    WiFi.mode(WIFI_AP);
+
+                if (systemState != STATE_WIFI_CONFIG)
+                {
+                    // WIFI_STOP() turns off the entire radio including the webserver. We need to turn off Station mode only.
+                    // For now, unit exits AP mode via reset so if we are in AP config mode, leave WiFi Station running.
+
+                    // If WiFi was originally off, turn it off again
+                    if (previouslyConnected == false)
+                        WIFI_STOP();
+                }
+            }
         }
         else
         {
-            systemPrintln("OTA failed");
+            systemPrintln("Network not available for OTA!");
         }
     }
-    else
-    {
-        systemPrintln("WiFi not available.");
-    }
-
-    // If we were in WIFI_AP mode, return to WIFI_AP mode
-    // There may be some overlap with systemState STATE_WIFI_CONFIG ? Not sure...
-    if (wasInAPmode)
-        WiFi.mode(WIFI_AP);
-
-    if (systemState != STATE_WIFI_CONFIG)
-    {
-        // WIFI_STOP() turns off the entire radio including the webserver. We need to turn off Station mode only.
-        // For now, unit exits AP mode via reset so if we are in AP config mode, leave WiFi Station running.
-
-        // If WiFi was originally off, turn it off again
-        if (previouslyConnected == false)
-            WIFI_STOP();
-    }
 
     if (gotVersion == true)
         log_d("Available OTA firmware version: %s\r\n", versionAvailable);
 
-#endif // COMPILE_WIFI
+#endif // COMPILE_NETWORK
     return (gotVersion);
 }
 
 // Force updates firmware using OTA pull
 // Exits by either updating firmware and resetting, or failing to connect
 void overTheAirUpdate()
 {
-#ifdef COMPILE_WIFI
+#ifdef COMPILE_NETWORK
     char versionString[9];
     formatFirmwareVersion(0, 0, versionString, sizeof(versionString), false);
 
@@ -566,13 +579,13 @@ void overTheAirUpdate()
         systemPrintln("OTA Update: Firmware server not available");
     else
         systemPrintln("OTA Update: OTA failed");
-#endif
+#endif  // COMPILE_NETWORK
 }
 
 // Start WiFi and perform the over-the-air update
 void otaUpdate()
 {
-#ifdef COMPILE_WIFI
+#ifdef COMPILE_NETWORK
     bool previouslyConnected = wifiIsConnected();
 
     bool wasInAPmode;
@@ -588,7 +601,7 @@ void otaUpdate()
     if (previouslyConnected == false)
         WIFI_STOP();
 
-#endif // COMPILE_WIFI
+#endif // COMPILE_NETWORK
 }
 
 // Called while the OTA Pull update is happening
@@ -633,7 +646,7 @@ void otaDisplayPercentage(int bytesWritten, int totalLength, bool alwaysDisplay)
 
 const char *otaPullErrorText(int code)
 {
-#ifdef COMPILE_WIFI
+#ifdef COMPILE_NETWORK
     switch (code)
     {
     case ESP32OTAPull::UPDATE_AVAILABLE:
@@ -657,7 +670,7 @@ const char *otaPullErrorText(int code)
             return "Unexpected HTTP response code";
         break;
     }
-#endif // COMPILE_WIFI
+#endif // COMPILE_NETWORK
     return "Unknown error";
 }
 
@@ -871,7 +884,7 @@ void otaAutoUpdate()
         if ((millis() - otaLastUpdateCheck) >= checkIntervalMillis)
         {
             otaLastUpdateCheck = millis();
-            otaSetState(OTA_STATE_START_WIFI);
+            otaSetState(OTA_STATE_START_NETWORK);
         }
     }
 
@@ -892,20 +905,20 @@ void otaAutoUpdate()
             break;
 
         // Start the WiFi network
-        case OTA_STATE_START_WIFI:
+        case OTA_STATE_START_NETWORK:
             if (settings.debugFirmwareUpdate)
                 systemPrintln("Firmware update starting WiFi");
-            if (!networkUserOpen(NETWORK_USER_OTA_AUTO_UPDATE, NETWORK_TYPE_WIFI))
+            if (!networkUserOpen(NETWORK_USER_OTA_AUTO_UPDATE, NETWORK_TYPE_ACTIVE))
             {
                 systemPrintln("Firmware update failed, unable to start WiFi");
                 otaAutoUpdateStop();
             }
             else
-                otaSetState(OTA_STATE_WAIT_FOR_WIFI);
+                otaSetState(OTA_STATE_WAIT_FOR_NETWORK);
             break;
 
         // Wait for connection to the access point
-        case OTA_STATE_WAIT_FOR_WIFI:
+        case OTA_STATE_WAIT_FOR_NETWORK:
             // Determine if the network has failed
             if (networkIsShuttingDown(NETWORK_USER_OTA_AUTO_UPDATE))
                 otaAutoUpdateStop();

Firmware/RTK_Everywhere/settings.h

@@ -955,8 +955,8 @@ const ubxCmd ubxCommands[] = {
 enum OtaState
 {
     OTA_STATE_OFF = 0,
-    OTA_STATE_START_WIFI,
-    OTA_STATE_WAIT_FOR_WIFI,
+    OTA_STATE_START_NETWORK,
+    OTA_STATE_WAIT_FOR_NETWORK,
     OTA_STATE_GET_FIRMWARE_VERSION,
     OTA_STATE_CHECK_FIRMWARE_VERSION,
     OTA_STATE_UPDATE_FIRMWARE,