Adding ability to update firmware over WiFi

Author: nseidle

Binaries/For_SD_or_WiFi_Loading/RTK_Surveyor_Firmware_v1_10-RC-Feb15.bin

@@ -1129,9 +1129,8 @@ <h2>
                     </div>
                     <div class="col-sm-7 col-6 mt-2">
                         <div id="uploadNewFirmwareDiv" class="mb-2">
-                            <label class="form-check-label" for="uploadNewFirmware">Add Firmware:</label>
-                            <span class="tt" data-bs-placement="right"
-                                title="New firmware may be uploaded via WiFi to the SD card. Firmware is only loaded to the SD card and must then be loaded to the unit.">
+                            <label class="form-check-label" for="uploadNewFirmware">Update Firmware:</label>
+                            <span class="tt" data-bs-placement="right" title="Update the unit's firmware over WiFi.">
                                 <span class="icon-info-circle text-primary ms-2"></span>
                             </span>
                             <form id="uploadNewFirmware" enctype="multipart/form-data" method="post" action="/upload">
@@ -1160,7 +1159,8 @@ <h2>
                     <p id="saveBtnSuccess" class="inlineSuccess"></p>
                 </div>
                 <div align="center" class="col-sm-5 col-12">
-                    <button type="button" id="exitBtn" class="btn btn-outline-secondary" onclick="exitConfig()">Exit and Reset<span class="icon-remove text-secondary ms-1"></span></button>
+                    <button type="button" id="exitBtn" class="btn btn-outline-secondary" onclick="exitConfig()">Exit and
+                        Reset<span class="icon-remove text-secondary ms-1"></span></button>
                     <p id="exitBtnError" class="inlineSuccess"></p>
                     <p>&nbsp;</p>
                 </div>

Firmware/RTK_Surveyor/AP-Config/index.html

@@ -83,17 +83,6 @@ function parseIncoming(msg) {
         ) {
             ge(id).innerHTML = val;
         }
-        else if (id.includes("firmwareFileName")) {
-            show("firmwareAvailable"); //Turn on firmware area
-
-            ge(id).innerHTML = val;
-            if (id.includes("0")) show("firmwareFile0");
-            if (id.includes("1")) show("firmwareFile1");
-            if (id.includes("2")) show("firmwareFile2");
-            if (id.includes("3")) show("firmwareFile3");
-            if (id.includes("4")) show("firmwareFile4");
-            if (id.includes("5")) show("firmwareFile5");
-        }
 
         //Check boxes / radio buttons
         else if (val == "true") {
@@ -161,22 +150,6 @@ function sendData() {
     ws.send(settingCSV);
 }
 
-function sendFirmwareFile() {
-    var firmwareFileName = "firmwareFileName,";
-
-    //ID the firmware file radio
-    if (ge("file0").checked) firmwareFileName += ge("firmwareFileName0").innerHTML;
-    else if (ge("file1").checked) firmwareFileName += ge("firmwareFileName1").innerHTML;
-    else if (ge("file2").checked) firmwareFileName += ge("firmwareFileName2").innerHTML;
-    else if (ge("file3").checked) firmwareFileName += ge("firmwareFileName3").innerHTML;
-    else if (ge("file4").checked) firmwareFileName += ge("firmwareFileName4").innerHTML;
-    else if (ge("file5").checked) firmwareFileName += ge("firmwareFileName5").innerHTML;
-
-    firmwareFileName += ","
-    ws.send(firmwareFileName);
-    ge("firmwareUpdateMsg").innerHTML = 'Updating, please wait for system reset...';
-}
-
 function showError(id, errorText) {
     ge(id + 'Error').innerHTML = '<br>Error: ' + errorText;
 }
@@ -503,7 +476,7 @@ function exitConfig() {
 }
 
 function firmwareUploadWait() {
-    ge("firmwareUploadMsg").innerHTML = "<br>Uploading, please wait....";
+    ge("firmwareUploadMsg").innerHTML = "<br>Uploading, please wait...";
 }
 
 document.addEventListener("DOMContentLoaded", (event) => {
@@ -661,25 +634,6 @@ document.addEventListener("DOMContentLoaded", (event) => {
         }
     });
 
-    //Enable the check box
-    ge("firmwareFile0").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile1").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile2").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile3").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile4").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile5").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-
-    ge("enableFirmwareUpdate").addEventListener("change", function () {
-        if (ge("enableFirmwareUpdate").checked) {
-            //Enable button
-            ge("firmwareUpdate").disabled = false;
-        }
-        else {
-            //Disable button
-            ge("firmwareUpdate").disabled = true;
-        }
-    });
-
     ge("dataPortChannel").addEventListener("change", function () {
         if (ge("dataPortChannel").value == 0) {
             show("dataPortBaudDropdown");

Firmware/RTK_Surveyor/AP-Config/src/main.js

@@ -360,8 +360,10 @@ void beginGNSS()
       zedFirmwareVersionInt = 120;
     else if (strstr(zedFirmwareVersion, "1.21") != NULL) //Future F9R HPS v1.21
       zedFirmwareVersionInt = 121;
+    else if (strstr(zedFirmwareVersion, "1.30") != NULL) //ZED-F9P released Dec, 2021
+      zedFirmwareVersionInt = 130;
     else
-      Serial.printf("Unknown firmware version: %s", zedFirmwareVersion);
+      Serial.printf("Unknown firmware version: %s\n\r", zedFirmwareVersion);
 
     //Determine if we have a ZED-F9P (Express/Facet) or an ZED-F9R (Express Plus/Facet Plus)
     if (strstr(i2cGNSS.minfo.extension[3], "ZED-F9P") != NULL)

Firmware/RTK_Surveyor/Begin.ino

@@ -168,7 +168,7 @@ void startConfigAP()
     request->send(response);
   });
 
-  //Handler for the /update form POST
+  //Handler for the /upload form POST
   server.on("/upload", HTTP_POST, [](AsyncWebServerRequest * request) {
     request->send(200);
   }, handleFirmwareFileUpload);
@@ -183,65 +183,41 @@ void startConfigAP()
 #ifdef COMPILE_WIFI
 static void handleFirmwareFileUpload(AsyncWebServerRequest *request, String fileName, size_t index, uint8_t *data, size_t len, bool final)
 {
-  if (online.microSD == false)
+  //Todo check file name against valid firmware names
+
+  if (!index)
   {
-    Serial.println(F("No SD card available"));
-    return;
+    if (!Update.begin(UPDATE_SIZE_UNKNOWN))
+    {
+      Update.printError(Serial);
+      return request->send(400, "text/plain", "OTA could not begin");
+    }
   }
 
-  //Attempt to write to file system. This avoids collisions with file writing in F9PSerialReadTask()
-  if (xSemaphoreTake(xFATSemaphore, fatSemaphore_longWait_ms) != pdPASS) {
-    Serial.println(F("Failed to get file system lock on firmware file"));
-    return;
+  // Write chunked data to the free sketch space
+  if (len)
+  {
+    if (Update.write(data, len) != len)
+      return request->send(400, "text/plain", "OTA could not begin");
   }
 
-  if (!index) {
-    //Convert string to array
-    char tempFileName[100];
-    fileName.toCharArray(tempFileName, sizeof(tempFileName));
-
-    if (sd.exists(tempFileName))
+  if (final)
+  {
+    if (!Update.end(true))
     {
-      sd.remove(tempFileName);
-      Serial.printf("Removed old firmware file: %s\n\r", tempFileName);
+      Update.printError(Serial);
+      return request->send(400, "text/plain", "Could not end OTA");
     }
-
-    Serial.printf("Start Firmware Upload: %s\n\r", tempFileName);
-
-    // O_CREAT - create the file if it does not exist
-    // O_APPEND - seek to the end of the file prior to each write
-    // O_WRITE - open for write
-    if (newFirmwareFile.open(tempFileName, O_CREAT | O_APPEND | O_WRITE) == false)
+    else
     {
-      Serial.printf("Failed to create firmware file: %s\n\r", tempFileName);
-      xSemaphoreGive(xFATSemaphore);
-      return;
+      Serial.print("Update complete: ");
+      Serial.println(fileName);
+      request->send(200, "text/html", "<b>Done</b><br><br>Firmware update complete. RTK device is rebooting.");
+      Serial.println("Restarting");
+      delay(100);
+      ESP.restart();
     }
   }
-
-  //Record to file
-  if (newFirmwareFile.write(data, len) != len)
-    log_e("Error writing to firmware file");
-  else
-    log_d("Recorded %d bytes to file\n\r", len);
-
-  if (final)
-  {
-    updateDataFileCreate(&newFirmwareFile); // Update the file create time & date
-    newFirmwareFile.close();
-
-    Serial.print("Upload complete: ");
-    Serial.println(fileName);
-
-    binCount = 0;
-    xSemaphoreGive(xFATSemaphore); //Must release semaphore before scanning for firmware
-    scanForFirmware(); //Update firmware file list
-
-    //Reload page upon success - this will show all available firmware files
-    request->send(200, "text/html", "<meta http-equiv=\"Refresh\" content=\"0; url='/'\" />");
-  }
-
-  xSemaphoreGive(xFATSemaphore);
 }
 #endif
 

Firmware/RTK_Surveyor/Form.ino

@@ -106,17 +106,6 @@ function parseIncoming(msg) {
         ) {
             ge(id).innerHTML = val;
         }
-        else if (id.includes("firmwareFileName")) {
-            show("firmwareAvailable"); //Turn on firmware area
-
-            ge(id).innerHTML = val;
-            if (id.includes("0")) show("firmwareFile0");
-            if (id.includes("1")) show("firmwareFile1");
-            if (id.includes("2")) show("firmwareFile2");
-            if (id.includes("3")) show("firmwareFile3");
-            if (id.includes("4")) show("firmwareFile4");
-            if (id.includes("5")) show("firmwareFile5");
-        }
 
         //Check boxes / radio buttons
         else if (val == "true") {
@@ -184,22 +173,6 @@ function sendData() {
     ws.send(settingCSV);
 }
 
-function sendFirmwareFile() {
-    var firmwareFileName = "firmwareFileName,";
-
-    //ID the firmware file radio
-    if (ge("file0").checked) firmwareFileName += ge("firmwareFileName0").innerHTML;
-    else if (ge("file1").checked) firmwareFileName += ge("firmwareFileName1").innerHTML;
-    else if (ge("file2").checked) firmwareFileName += ge("firmwareFileName2").innerHTML;
-    else if (ge("file3").checked) firmwareFileName += ge("firmwareFileName3").innerHTML;
-    else if (ge("file4").checked) firmwareFileName += ge("firmwareFileName4").innerHTML;
-    else if (ge("file5").checked) firmwareFileName += ge("firmwareFileName5").innerHTML;
-
-    firmwareFileName += ","
-    ws.send(firmwareFileName);
-    ge("firmwareUpdateMsg").innerHTML = 'Updating, please wait for system reset...';
-}
-
 function showError(id, errorText) {
     ge(id + 'Error').innerHTML = '<br>Error: ' + errorText;
 }
@@ -526,7 +499,7 @@ function exitConfig() {
 }
 
 function firmwareUploadWait() {
-    ge("firmwareUploadMsg").innerHTML = "<br>Uploading, please wait....";
+    ge("firmwareUploadMsg").innerHTML = "<br>Uploading, please wait...";
 }
 
 document.addEventListener("DOMContentLoaded", (event) => {
@@ -575,7 +548,7 @@ document.addEventListener("DOMContentLoaded", (event) => {
                 ge("fixedEcefX").disabled = false;
                 ge("fixedEcefY").disabled = false;
                 ge("fixedEcefZ").disabled = false;
-                //Disable Geodetic inputs
+                //Disable Geographic inputs
                 ge("fixedLat").disabled = true;
                 ge("fixedLong").disabled = true;
                 ge("fixedAltitude").disabled = true;
@@ -585,7 +558,7 @@ document.addEventListener("DOMContentLoaded", (event) => {
                 ge("fixedEcefX").disabled = true;
                 ge("fixedEcefY").disabled = true;
                 ge("fixedEcefZ").disabled = true;
-                //Disable Geodetic inputs
+                //Disable Geographic inputs
                 ge("fixedLat").disabled = false;
                 ge("fixedLong").disabled = false;
                 ge("fixedAltitude").disabled = false;
@@ -600,7 +573,7 @@ document.addEventListener("DOMContentLoaded", (event) => {
             ge("fixedEcefX").disabled = false;
             ge("fixedEcefY").disabled = false;
             ge("fixedEcefZ").disabled = false;
-            //Disable Geodetic inputs
+            //Disable Geographic inputs
             ge("fixedLat").disabled = true;
             ge("fixedLong").disabled = true;
             ge("fixedAltitude").disabled = true;
@@ -610,7 +583,7 @@ document.addEventListener("DOMContentLoaded", (event) => {
             ge("fixedEcefX").disabled = true;
             ge("fixedEcefY").disabled = true;
             ge("fixedEcefZ").disabled = true;
-            //Disable Geodetic inputs
+            //Disable Geographic inputs
             ge("fixedLat").disabled = false;
             ge("fixedLong").disabled = false;
             ge("fixedAltitude").disabled = false;
@@ -624,7 +597,7 @@ document.addEventListener("DOMContentLoaded", (event) => {
             ge("fixedEcefX").disabled = true;
             ge("fixedEcefY").disabled = true;
             ge("fixedEcefZ").disabled = true;
-            //Enable Geodetic inputs
+            //Enable Geographic inputs
             ge("fixedLat").disabled = false;
             ge("fixedLong").disabled = false;
             ge("fixedAltitude").disabled = false;
@@ -634,7 +607,7 @@ document.addEventListener("DOMContentLoaded", (event) => {
             ge("fixedEcefX").disabled = false;
             ge("fixedEcefY").disabled = false;
             ge("fixedEcefZ").disabled = false;
-            //Disable Geodetic inputs
+            //Disable Geographic inputs
             ge("fixedLat").disabled = true;
             ge("fixedLong").disabled = true;
             ge("fixedAltitude").disabled = true;
@@ -684,25 +657,6 @@ document.addEventListener("DOMContentLoaded", (event) => {
         }
     });
 
-    //Enable the check box
-    ge("firmwareFile0").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile1").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile2").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile3").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile4").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-    ge("firmwareFile5").addEventListener("change", function () { ge("enableFirmwareUpdate").disabled = false; });
-
-    ge("enableFirmwareUpdate").addEventListener("change", function () {
-        if (ge("enableFirmwareUpdate").checked) {
-            //Enable button
-            ge("firmwareUpdate").disabled = false;
-        }
-        else {
-            //Disable button
-            ge("firmwareUpdate").disabled = true;
-        }
-    });
-
     ge("dataPortChannel").addEventListener("change", function () {
         if (ge("dataPortChannel").value == 0) {
             show("dataPortBaudDropdown");
@@ -1865,9 +1819,8 @@ static const char *index_html = R"=====(
                     </div>
                     <div class="col-sm-7 col-6 mt-2">
                         <div id="uploadNewFirmwareDiv" class="mb-2">
-                            <label class="form-check-label" for="uploadNewFirmware">Add Firmware:</label>
-                            <span class="tt" data-bs-placement="right"
-                                title="New firmware may be uploaded via WiFi to the SD card. Firmware is only loaded to the SD card and must then be loaded to the unit.">
+                            <label class="form-check-label" for="uploadNewFirmware">Update Firmware:</label>
+                            <span class="tt" data-bs-placement="right" title="Update the unit's firmware over WiFi.">
                                 <span class="icon-info-circle text-primary ms-2"></span>
                             </span>
                             <form id="uploadNewFirmware" enctype="multipart/form-data" method="post" action="/upload">
@@ -1896,7 +1849,8 @@ static const char *index_html = R"=====(
                     <p id="saveBtnSuccess" class="inlineSuccess"></p>
                 </div>
                 <div align="center" class="col-sm-5 col-12">
-                    <button type="button" id="exitBtn" class="btn btn-outline-secondary" onclick="exitConfig()">Exit and Reset<span class="icon-remove text-secondary ms-1"></span></button>
+                    <button type="button" id="exitBtn" class="btn btn-outline-secondary" onclick="exitConfig()">Exit and
+                        Reset<span class="icon-remove text-secondary ms-1"></span></button>
                     <p id="exitBtnError" class="inlineSuccess"></p>
                     <p>&nbsp;</p>
                 </div>