Custom binary firmware upload hangs

[Ryanf55]

Found in #803 (comment).

When attemping to upload a new firmware file (compiled from source using docker), the UI gets stuck displaying "Uploading, Please wait..." and never appears to complete the update. After a while, and a reboot, the firmware version displayed stays the same, and behavior does not seem different.

Version encountered: v2.3.

Note: I was able to update to the latest official release earlier from v1.x, so this previously worked with at least retrieving latest stable automatically. I've tried this a few times and it has the same error.

[PaulZC]

I can see two issues:

1 ) The compile_with_docker.bat file produces a binary file named RTK_Everywhere.ino.bin. The Web Config does not recognise it because it should start with RTK_Everywhere_Firmware. (The GitHub Action Workflow renames the file, giving it the prefix RTK_Everywhere_Firmware.)

Renaming the custom binary RTK_Everywhere.ino.bin to RTK_Everywhere_Firmware.bin doesn't work because:

2 ) The firmware filename prefix check doesn't include the "/" prefix. We should be using "/RTK_Everywhere_Firmware"

SparkFun_RTK_Everywhere_Firmware/Firmware/RTK_Everywhere/WebServer.ino

Line 420 in 1cce7c8

const char *BIN_HEADER = "RTK_Everywhere_Firmware";

If I recompile the source and use const char *BIN_HEADER = "/RTK_Everywhere"; then upload works just fine. I can upload my local "RTK_Everywhere.ino.bin" (v99.99).

I can also upload "RTK_Everywhere_Firmware_v2_3.bin" and it works, but then I'm stuck and have to use the GUI to upload my local v99.99 again...

It looks like we haven't tested this since we changed to the new webServer ...?!

With the old web server, the upload was written in chunks and we could print an upload percentage during the upload. The new web server takes the whole file and uploads it in one go. So we no longer get upload percentage prints. I'll poke at this and see if I can persuade it to provide a percentage.

[PaulZC]

The fix is in PR #812

[Ryanf55]

I can see two issues:

1 ) The compile_with_docker.bat file produces a binary file named RTK_Everywhere.ino.bin. The Web Config does not recognise it because it should start with RTK_Everywhere_Firmware. (The GitHub Action Workflow renames the file, giving it the prefix RTK_Everywhere_Firmware.)

Renaming the custom binary RTK_Everywhere.ino.bin to RTK_Everywhere_Firmware.bin doesn't work because:

2 ) The firmware filename prefix check doesn't include the "/" prefix. We should be using "/RTK_Everywhere_Firmware"

SparkFun_RTK_Everywhere_Firmware/Firmware/RTK_Everywhere/WebServer.ino

Line 420 in 1cce7c8

const char *BIN_HEADER = "RTK_Everywhere_Firmware";
If I recompile the source and use const char *BIN_HEADER = "/RTK_Everywhere"; then upload works just fine. I can upload my local "RTK_Everywhere.ino.bin" (v99.99).

I can also upload "RTK_Everywhere_Firmware_v2_3.bin" and it works, but then I'm stuck and have to use the GUI to upload my local v99.99 again...

It looks like we haven't tested this since we changed to the new webServer ...?!

With the old web server, the upload was written in chunks and we could print an upload percentage during the upload. The new web server takes the whole file and uploads it in one go. So we no longer get upload percentage prints. I'll poke at this and see if I can persuade it to provide a percentage.

Note: I compiled with docker build on Linux, not using the windows .bat script.

From docker cp rtk_everywhere:/RTK_Everywhere.ino.bin ., I believe your proposed patch would resolve this also.

If you need some inspiration on progress updates, we can steal anything from my CVCM project, which had ESP32 OTA with progress update info.
https://github.com/ryaniftron/clearview_interface_public/blob/263e52e98f75bf1c54a01657e6385f51fe8491da/src/cvesp32/components/cv_ota/cv_ota.c#L174