feat: detect setups without ota partition setup

marcelkottmann · marcelkottmann · commit f19e533de8f5 · 2021-09-05T08:48:46.000+02:00
diff --git a/README.md b/README.md
@@ -92,6 +92,13 @@ If you need more than this, you can create your own esp-idf component below `./c
 Additionally you have to set your component name in the top level `./CMakeLists.txt`. Refer to the documentation next to the setting `ESP32_JS_PROJECT_NAME`.
 See [ESP Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) for information on how to create a component with the esp-idf build system.
 
+### Native OTA
+
+You can perform a native firmware OTA upgrade by calling the URL /setup . There is a section called "Native OTA" where you can provide two urls to the new images: One for the actual firmware image (normally named esp32-javascript.bin in your build directory) and the other for the JS modules image (normally named modules.bin in your build directory).
+
+The upgrade is performed in the background. You can check the upgrade status either by staying on the upgrade page, which is reloaded automatically every ~20 seconds or click on "Upgrade status" in the setup page.
+
+After upgrade has finished you have to restart the device to load the new firmware.
 ### Clean
 
 You can clean the project by executing
diff --git a/components/esp32-javascript/esp32-javascript.c b/components/esp32-javascript/esp32-javascript.c
@@ -822,6 +822,24 @@ duk_ret_t el_partition_write(duk_context *ctx)
     }
 }
 
+bool isNativeOtaSupported()
+{
+    if (esp_partition_find_first(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_OTA, "otadata") == NULL)
+    {
+        return false;
+    }
+    else
+    {
+        return true;
+    }
+}
+
+duk_ret_t el_is_native_ota_supported(duk_context *ctx)
+{
+    duk_push_boolean(ctx, isNativeOtaSupported());
+    return 1;
+}
+
 duk_ret_t el_readAndFreeString(duk_context *ctx)
 {
     char *str = duk_to_int(ctx, 0);
@@ -919,20 +937,26 @@ void duktape_task(void *ignore)
     duk_push_c_function(ctx, atob, 1 /*nargs*/);
     duk_put_global_string(ctx, "atob");
 
-    duk_push_c_function(ctx, el_ota_begin, 0 /*nargs*/);
-    duk_put_global_string(ctx, "el_ota_begin");
+    if (isNativeOtaSupported())
+    {
+        duk_push_c_function(ctx, el_ota_begin, 0 /*nargs*/);
+        duk_put_global_string(ctx, "el_ota_begin");
+
+        duk_push_c_function(ctx, el_ota_write, 2 /*nargs*/);
+        duk_put_global_string(ctx, "el_ota_write");
 
-    duk_push_c_function(ctx, el_ota_write, 2 /*nargs*/);
-    duk_put_global_string(ctx, "el_ota_write");
+        duk_push_c_function(ctx, el_ota_end, 1 /*nargs*/);
+        duk_put_global_string(ctx, "el_ota_end");
 
-    duk_push_c_function(ctx, el_ota_end, 1 /*nargs*/);
-    duk_put_global_string(ctx, "el_ota_end");
+        duk_push_c_function(ctx, el_ota_switch_boot_partition, 0 /*nargs*/);
+        duk_put_global_string(ctx, "el_ota_switch_boot_partition");
 
-    duk_push_c_function(ctx, el_ota_switch_boot_partition, 0 /*nargs*/);
-    duk_put_global_string(ctx, "el_ota_switch_boot_partition");
+        duk_push_c_function(ctx, el_ota_find_next_modules_partition, 0 /*nargs*/);
+        duk_put_global_string(ctx, "el_ota_find_next_modules_partition");
+    }
 
-    duk_push_c_function(ctx, el_ota_find_next_modules_partition, 0 /*nargs*/);
-    duk_put_global_string(ctx, "el_ota_find_next_modules_partition");
+    duk_push_c_function(ctx, el_is_native_ota_supported, 0 /*nargs*/);
+    duk_put_global_string(ctx, "el_is_native_ota_supported");
 
     duk_push_c_function(ctx, el_partition_erase, 1 /*nargs*/);
     duk_put_global_string(ctx, "el_partition_erase");
diff --git a/components/esp32-javascript/include/esp32-javascript.h b/components/esp32-javascript/include/esp32-javascript.h
@@ -67,6 +67,7 @@ extern "C"
     void loadJS(duk_context *ctx, const char *name, char *start, char *end);
 
     int esp32_javascript_init();
+    bool isNativeOtaSupported();
 
 #ifdef __cplusplus
 }
diff --git a/components/esp32-javascript/modules/esp32-javascript/config.js b/components/esp32-javascript/modules/esp32-javascript/config.js
@@ -34,7 +34,7 @@ function reloadConfig() {
     }
     catch (error) {
         exports.config = firmware_config_1.default;
-        console.error("An error ocurred while accessing config. Maybe it does not exist.");
+        console.error("Using default config. Seems like you never changed the config.");
     }
 }
 exports.reloadConfig = reloadConfig;
diff --git a/components/esp32-javascript/modules/esp32-javascript/config.ts b/components/esp32-javascript/modules/esp32-javascript/config.ts
@@ -49,7 +49,7 @@ export function reloadConfig(): void {
   } catch (error) {
     config = firmwareConfig;
     console.error(
-      "An error ocurred while accessing config. Maybe it does not exist."
+      "Using default config. Seems like you never changed the config."
     );
   }
 }
diff --git a/components/esp32-javascript/modules/esp32-javascript/configserver.js b/components/esp32-javascript/modules/esp32-javascript/configserver.js
@@ -220,9 +220,11 @@ function startConfigServer() {
                 .map(function (e) {
                 return e.filename + " (" + (e.size === undefined ? "?" : Math.floor(e.size / 1024)) + " kB) <form action=\"/viewlog\" method=\"post\" class=\"inline-form\"><button class=\"input\" type=\"submit\" name=\"file\" value=\"" + filelogging_1.FILE_LOGGING_DIRECTORY + "/" + e.filename + "\">View</button></form> <form action=\"/deletelog\" method=\"post\" class=\"inline-form\"><button class=\"input\" type=\"submit\" name=\"file\" value=\"" + filelogging_1.FILE_LOGGING_DIRECTORY + "/" + e.filename + "\">Delete</button></form><br />";
             })
-                .join("") + "\n          </form>\n        </div>\n        \n        <h2>Native OTA Upgrade</h2>\n        <form action=\"/native-ota\" method=\"post\" class=\"formpad\">\n          <div class=\"formpad\"><label for=\"appbin\" class=\"formlabel\">URL to app binary</label><input type=\"text\" name=\"appbin\" class=\"fill input\" value=\"\" /></div>\n          <div class=\"formpad\"><label for=\"modulesbin\" class=\"formlabel\">URL to modules binary</label><input type=\"text\" name=\"modulesbin\" class=\"fill input\" value=\"\" /></div>\n          <div class=\"formpad\"><input type=\"submit\" value=\"Upgrade\" class=\"formpad input\" " + (upgradeStatus.status === "inprogress" ? "disabled" : "") + "/> " + (upgradeStatus.status !== "idle"
-                ? '<a href="/native-ota">Upgrade status</a>'
-                : "") + "</div>\n        </form>\n\n        <h2>Request restart</h2>\n        <form action=\"/restart\" method=\"post\"><div class=\"formpad\"><input type=\"submit\" value=\"Restart\" class=\"formpad input\"/></div></form>\n        <h2>Uptime</h2>\n        <div class=\"formpad\">\n          Boot time: " + boot_1.getBootTime() + "\n        </div>\n        <div class=\"formpad\">\n          Uptime (hours): " + Math.floor((Date.now() - boot_1.getBootTime().getTime()) / 10 / 60 / 60) /
+                .join("") + "\n          </form>\n        </div>\n        \n        " + (el_is_native_ota_supported()
+                ? "<h2>Native OTA Upgrade</h2>\n        <form action=\"/native-ota\" method=\"post\" class=\"formpad\">\n          <div class=\"formpad\"><label for=\"appbin\" class=\"formlabel\">URL to app binary</label><input type=\"text\" name=\"appbin\" class=\"fill input\" value=\"\" /></div>\n          <div class=\"formpad\"><label for=\"modulesbin\" class=\"formlabel\">URL to modules binary</label><input type=\"text\" name=\"modulesbin\" class=\"fill input\" value=\"\" /></div>\n          <div class=\"formpad\"><input type=\"submit\" value=\"Upgrade\" class=\"formpad input\" " + (upgradeStatus.status === "inprogress" ? "disabled" : "") + "/> " + (upgradeStatus.status !== "idle"
+                    ? '<a href="/native-ota">Upgrade status</a>'
+                    : "") + "</div>\n        </form>"
+                : "") + "\n\n        <h2>Request restart</h2>\n        <form action=\"/restart\" method=\"post\"><div class=\"formpad\"><input type=\"submit\" value=\"Restart\" class=\"formpad input\"/></div></form>\n        <h2>Uptime</h2>\n        <div class=\"formpad\">\n          Boot time: " + boot_1.getBootTime() + "\n        </div>\n        <div class=\"formpad\">\n          Uptime (hours): " + Math.floor((Date.now() - boot_1.getBootTime().getTime()) / 10 / 60 / 60) /
                 100 + "<br />\n        </div>\n        <div class=\"formpad\">\n          Boot time is only available if a valid 'JS file url' is configured, otherwise it starts at unix epoch (1970).\n        </div>");
             successMessage = "";
             errorMessage = "";
diff --git a/components/esp32-javascript/modules/esp32-javascript/configserver.ts b/components/esp32-javascript/modules/esp32-javascript/configserver.ts
@@ -341,18 +341,22 @@ export function startConfigServer(): void {
           </form>
         </div>
         
-        <h2>Native OTA Upgrade</h2>
+        ${
+          el_is_native_ota_supported()
+            ? `<h2>Native OTA Upgrade</h2>
         <form action="/native-ota" method="post" class="formpad">
           <div class="formpad"><label for="appbin" class="formlabel">URL to app binary</label><input type="text" name="appbin" class="fill input" value="" /></div>
           <div class="formpad"><label for="modulesbin" class="formlabel">URL to modules binary</label><input type="text" name="modulesbin" class="fill input" value="" /></div>
           <div class="formpad"><input type="submit" value="Upgrade" class="formpad input" ${
             upgradeStatus.status === "inprogress" ? "disabled" : ""
           }/> ${
-          upgradeStatus.status !== "idle"
-            ? '<a href="/native-ota">Upgrade status</a>'
+                upgradeStatus.status !== "idle"
+                  ? '<a href="/native-ota">Upgrade status</a>'
+                  : ""
+              }</div>
+        </form>`
             : ""
-        }</div>
-        </form>
+        }
 
         <h2>Request restart</h2>
         <form action="/restart" method="post"><div class="formpad"><input type="submit" value="Restart" class="formpad input"/></div></form>
diff --git a/components/esp32-javascript/modules/esp32-javascript/esp32-javascript.d.ts b/components/esp32-javascript/modules/esp32-javascript/esp32-javascript.d.ts
@@ -94,6 +94,7 @@ declare function listDir(path: string): string[];
 declare function mkdir(path: string): void;
 
 // ota
+declare function el_is_native_ota_supported(): boolean;
 declare function el_ota_begin(): number;
 declare function el_ota_write(handle: number, data: Uint8Array): number;
 declare function el_ota_end(handle: number): number;
diff --git a/components/esp32-javascript/modules/esp32-javascript/native-ota.js b/components/esp32-javascript/modules/esp32-javascript/native-ota.js
@@ -100,6 +100,10 @@ function upgradeModules(partition, modulesImageUrl, submitSuccess, submitError)
     return client;
 }
 exports.upgrade = function (appImageUrl, modulesImageUrl, onError, onFinish) {
+    if (!el_is_native_ota_supported()) {
+        onError && onError("Native OTA is not supported.");
+        return;
+    }
     console.log("Start native firmware upgrade:");
     console.log("App image: " + appImageUrl);
     console.log("Modules image: " + modulesImageUrl);
diff --git a/components/esp32-javascript/modules/esp32-javascript/native-ota.ts b/components/esp32-javascript/modules/esp32-javascript/native-ota.ts
@@ -138,6 +138,11 @@ export const upgrade = (
   onError: (message: string) => void,
   onFinish: () => void
 ): void => {
+  if (!el_is_native_ota_supported()) {
+    onError && onError("Native OTA is not supported.");
+    return;
+  }
+
   console.log(`Start native firmware upgrade:`);
   console.log(`App image: ${appImageUrl}`);
   console.log(`Modules image: ${modulesImageUrl}`);
diff --git a/components/spiffs-events/spiffs-events.c b/components/spiffs-events/spiffs-events.c
@@ -103,7 +103,7 @@ char *readFile(const char *path)
 	FILE *f = fopen(path, "r");
 	if (f == NULL)
 	{
-		jslog(ERROR, "Failed to open file for reading");
+		jslog(ERROR, "Failed to open file '%s' for reading.", path);
 		return NULL;
 	}
 
@@ -132,7 +132,7 @@ int writeFile(const char *path, const char *content)
 	FILE *f = fopen(path, "w");
 	if (f == NULL)
 	{
-		jslog(ERROR, "Failed to open file '%s'for writing, errno %i", path, errno);
+		jslog(ERROR, "Failed to open file '%s' for writing, errno %i", path, errno);
 		return -1;
 	}
 	int result = fputs(content, f);
@@ -278,14 +278,16 @@ void registerBindings(duk_context *ctx)
 	duk_put_global_string(ctx, "fileSize");
 	duk_push_c_function(ctx, el_listDir, 1);
 	duk_put_global_string(ctx, "listDir");
-	// duk_push_c_function(ctx, el_mkdir, 1);
-	// duk_put_global_string(ctx, "mkdir");
 }
 
 void initSpiffs(duk_context *ctx)
 {
-	esp_partition_t *partition = esp_ota_get_boot_partition();
-	const char *modulesLabel = strcmp(partition->label, "ota_1") == 0 ? "modules_1" : "modules";
+	const char *modulesLabel = "modules";
+	if (isNativeOtaSupported())
+	{
+		esp_partition_t *partition = esp_ota_get_boot_partition();
+		modulesLabel = partition != NULL && strcmp(partition->label, "ota_1") == 0 ? "modules_1" : "modules";
+	}
 	initFilesystem(modulesLabel, "/modules");
 
 	initFilesystem("data", "/data");

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ extern "C"`
`67`	`67`	`void loadJS(duk_context ctx, const char name, char start, char end);`
`68`	`68`
`69`	`69`	`int esp32_javascript_init();`
	`70`	`+ bool isNativeOtaSupported();`
`70`	`71`
`71`	`72`	`#ifdef __cplusplus`
`72`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ function reloadConfig() {`
`34`	`34`	`}`
`35`	`35`	`catch (error) {`
`36`	`36`	`exports.config = firmware_config_1.default;`
`37`		`- console.error("An error ocurred while accessing config. Maybe it does not exist.");`
	`37`	`+ console.error("Using default config. Seems like you never changed the config.");`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	`exports.reloadConfig = reloadConfig;`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export function reloadConfig(): void {`
`49`	`49`	`} catch (error) {`
`50`	`50`	`config = firmwareConfig;`
`51`	`51`	`console.error(`
`52`		`- "An error ocurred while accessing config. Maybe it does not exist."`
	`52`	`+ "Using default config. Seems like you never changed the config."`
`53`	`53`	`);`
`54`	`54`	`}`
`55`	`55`	`}`