refactor: enhance OTA update process with SPIFFS support and improved error handling

This commit is contained in:
Manuel Weiser 2025-02-20 20:19:24 +01:00
parent c161216c04
commit 89d40832c5
3 changed files with 145 additions and 80 deletions

View File

@ -48,30 +48,28 @@ jobs:
run: | run: |
cd .pio/build/esp32dev cd .pio/build/esp32dev
# Create OTA binary (already has correct magic byte) # Kopiere die Firmware in den SPIFFS-Build-Ordner
cp firmware.bin filaman.bin cp firmware.bin ./spiffs/firmware.bin
# Create a magic byte prepended binary for the bootloader # Baue das SPIFFS-Image neu mit der eingebetteten Firmware
echo -ne '\xE9' > bootloader_with_magic.bin pio run -t buildfs
cat bootloader.bin >> bootloader_with_magic.bin
echo "Creating full binary with magic byte..." # Erstelle die Release-Dateien
cp spiffs.bin filaman_spiffs.bin
# Create full binary with magic byte
echo "Creating full binary..."
esptool.py --chip esp32 merge_bin \ esptool.py --chip esp32 merge_bin \
--fill-flash-size 4MB \ --fill-flash-size 4MB \
--flash_mode dio \ --flash_mode dio \
--flash_freq 40m \ --flash_freq 40m \
--flash_size 4MB \ --flash_size 4MB \
-o filaman.bin \ -o filaman_full.bin \
0x0000 bootloader_with_magic.bin \ 0x0000 bootloader.bin \
0x8000 partitions.bin \ 0x8000 partitions.bin \
0x10000 firmware.bin \ 0x10000 firmware.bin \
0x390000 spiffs.bin 0x390000 spiffs.bin
# Verify magic bytes
echo "Checking magic bytes:"
echo "Full binary first bytes:"
xxd -l 16 filaman.bin
# Verify file sizes # Verify file sizes
echo "File sizes:" echo "File sizes:"
ls -lh *.bin ls -lh *.bin
@ -103,7 +101,7 @@ jobs:
# Upload binaries # Upload binaries
cd .pio/build/esp32dev cd .pio/build/esp32dev
for file in filaman.bin; do for file in filaman_ota.bin filaman_spiffs.bin filaman_full.bin; do
echo "Uploading $file..." echo "Uploading $file..."
curl -k -s \ curl -k -s \
-X POST \ -X POST \

View File

@ -37,30 +37,28 @@ jobs:
run: | run: |
cd .pio/build/esp32dev cd .pio/build/esp32dev
# Create OTA binary (already has correct magic byte) # Kopiere die Firmware in den SPIFFS-Build-Ordner
cp firmware.bin filaman.bin cp firmware.bin ./spiffs/firmware.bin
# Create a magic byte prepended binary for the bootloader # Baue das SPIFFS-Image neu mit der eingebetteten Firmware
echo -ne '\xE9' > bootloader_with_magic.bin pio run -t buildfs
cat bootloader.bin >> bootloader_with_magic.bin
echo "Creating full binary with magic byte..." # Erstelle die Release-Dateien
cp spiffs.bin filaman_spiffs.bin
# Create full binary with magic byte
echo "Creating full binary..."
esptool.py --chip esp32 merge_bin \ esptool.py --chip esp32 merge_bin \
--fill-flash-size 4MB \ --fill-flash-size 4MB \
--flash_mode dio \ --flash_mode dio \
--flash_freq 40m \ --flash_freq 40m \
--flash_size 4MB \ --flash_size 4MB \
-o filaman.bin \ -o filaman_full.bin \
0x0000 bootloader_with_magic.bin \ 0x0000 bootloader.bin \
0x8000 partitions.bin \ 0x8000 partitions.bin \
0x10000 firmware.bin \ 0x10000 firmware.bin \
0x390000 spiffs.bin 0x390000 spiffs.bin
# Verify magic bytes
echo "Checking magic bytes:"
echo "Full binary first bytes:"
xxd -l 16 filaman.bin
# Verify file sizes # Verify file sizes
echo "File sizes:" echo "File sizes:"
ls -lh *.bin ls -lh *.bin
@ -86,4 +84,4 @@ jobs:
gh release create "${{ github.ref_name }}" \ gh release create "${{ github.ref_name }}" \
--title "Release ${{ steps.get_version.outputs.VERSION }}" \ --title "Release ${{ steps.get_version.outputs.VERSION }}" \
--notes "${{ steps.changelog.outputs.CHANGES }}" \ --notes "${{ steps.changelog.outputs.CHANGES }}" \
.pio/build/esp32dev/filaman.bin .pio/build/esp32dev/filaman_full.bin

View File

@ -20,81 +20,150 @@ void stopAllTasks() {
Serial.println("All tasks stopped"); Serial.println("All tasks stopped");
} }
void performStageTwo() {
if (!SPIFFS.begin(true)) {
Serial.println("Error: Could not mount SPIFFS for stage 2");
return;
}
File firmwareFile = SPIFFS.open("/firmware.bin", "r");
if (!firmwareFile) {
Serial.println("Error: Could not open firmware.bin from SPIFFS");
return;
}
size_t firmwareSize = firmwareFile.size();
size_t maxAppSpace = (ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000;
Serial.printf("Stage 2 - Firmware size: %u bytes\n", firmwareSize);
Serial.printf("Available space: %u bytes\n", maxAppSpace);
if (firmwareSize > maxAppSpace) {
Serial.printf("Error: Not enough space for firmware. Need %u bytes but only have %u bytes\n",
firmwareSize, maxAppSpace);
return;
}
if (!Update.begin(firmwareSize)) {
Update.printError(Serial);
return;
}
size_t written = Update.writeStream(firmwareFile);
if (written != firmwareSize) {
Update.printError(Serial);
return;
}
if (!Update.end(true)) {
Update.printError(Serial);
return;
}
firmwareFile.close();
SPIFFS.remove("/firmware.bin"); // Cleanup
Serial.println("Stage 2 update successful, restarting...");
delay(500);
ESP.restart();
}
void checkForStagedUpdate() {
if (!SPIFFS.begin(true)) {
return;
}
if (SPIFFS.exists("/firmware.bin")) {
Serial.println("Found staged firmware update, initiating stage 2...");
performStageTwo();
}
}
void handleOTAUpload(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) { void handleOTAUpload(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) {
static File stagingFile;
if (!index) { if (!index) {
bool isFullImage = filename.endsWith(".bin"); bool isSpiffsUpdate = filename.endsWith("_spiffs.bin");
Serial.printf("Update Start: %s (type: %s)\n", filename.c_str(), isFullImage ? "full" : "OTA"); Serial.printf("Update Start: %s (type: %s)\n", filename.c_str(), isSpiffsUpdate ? "SPIFFS" : "OTA");
if (request->contentLength() == 0) { if (request->contentLength() == 0) {
request->send(400, "application/json", "{\"status\":\"error\",\"message\":\"Invalid file size\"}"); request->send(400, "application/json", "{\"status\":\"error\",\"message\":\"Invalid file size\"}");
return; return;
} }
// Berechne verfügbaren Speicherplatz // Stop tasks before update
size_t updateSize = request->contentLength();
size_t maxSketchSpace = (ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000;
Serial.printf("Update size: %u bytes\n", updateSize);
Serial.printf("Available space: %u bytes\n", maxSketchSpace);
if (updateSize > maxSketchSpace) {
Serial.printf("Error: Not enough space. Need %u bytes but only have %u bytes available\n",
updateSize, maxSketchSpace);
request->send(400, "application/json",
"{\"status\":\"error\",\"message\":\"Not enough space for update\"}");
return;
}
if (!tasksAreStopped && (RfidReaderTask || BambuMqttTask || ScaleTask)) { if (!tasksAreStopped && (RfidReaderTask || BambuMqttTask || ScaleTask)) {
stopAllTasks(); stopAllTasks();
tasksAreStopped = true; tasksAreStopped = true;
} }
// Ensure SPIFFS is ended before update size_t updateSize = request->contentLength();
if (SPIFFS.begin()) {
SPIFFS.end();
}
bool success; if (isSpiffsUpdate) {
if (isFullImage) { if (!SPIFFS.begin(true)) {
success = Update.begin(updateSize, U_FLASH);
} else {
if (data[0] != 0xE9) {
Serial.printf("Wrong magic byte: 0x%02X (expected 0xE9)\n", data[0]);
request->send(400, "application/json", request->send(400, "application/json",
"{\"status\":\"error\",\"message\":\"Invalid firmware format\"}"); "{\"status\":\"error\",\"message\":\"Could not mount SPIFFS\"}");
return; return;
} }
success = Update.begin(updateSize);
}
if (!success) { // Start SPIFFS update
if (!Update.begin(updateSize, U_SPIFFS)) {
Update.printError(Serial); Update.printError(Serial);
request->send(400, "application/json", request->send(400, "application/json",
"{\"status\":\"error\",\"message\":\"Update initialization failed\"}"); "{\"status\":\"error\",\"message\":\"SPIFFS update initialization failed\"}");
return;
}
} else {
// Regular OTA update
stagingFile = SPIFFS.open("/firmware.bin", "w");
if (!stagingFile) {
request->send(400, "application/json",
"{\"status\":\"error\",\"message\":\"Could not create staging file\"}");
return; return;
} }
} }
}
if (stagingFile) {
// Stage 1: Write to SPIFFS
if (stagingFile.write(data, len) != len) {
stagingFile.close();
SPIFFS.remove("/firmware.bin");
request->send(400, "application/json",
"{\"status\":\"error\",\"message\":\"Write to SPIFFS failed\"}");
return;
}
} else {
// Direct SPIFFS update
if (Update.write(data, len) != len) { if (Update.write(data, len) != len) {
Update.printError(Serial); Update.printError(Serial);
request->send(400, "application/json", request->send(400, "application/json",
"{\"status\":\"error\",\"message\":\"Write failed\"}"); "{\"status\":\"error\",\"message\":\"Write failed\"}");
return; return;
} }
}
if (final) { if (final) {
if (stagingFile) {
// Finish Stage 1
stagingFile.close();
Serial.println("Stage 1 complete - firmware staged in SPIFFS");
request->send(200, "application/json",
"{\"status\":\"success\",\"message\":\"Update staged successfully! Starting stage 2...\"}");
performStageTwo();
} else {
// Finish direct SPIFFS update
if (!Update.end(true)) { if (!Update.end(true)) {
Update.printError(Serial); Update.printError(Serial);
request->send(400, "application/json", request->send(400, "application/json",
"{\"status\":\"error\",\"message\":\"Update failed\"}"); "{\"status\":\"error\",\"message\":\"Update failed\"}");
return; return;
} }
Serial.println("Update successful, restarting..."); Serial.println("SPIFFS update successful, restarting...");
request->send(200, "application/json", request->send(200, "application/json",
"{\"status\":\"success\",\"message\":\"Update successful! Device will restart...\",\"restart\":true}"); "{\"status\":\"success\",\"message\":\"SPIFFS update successful! Device will restart...\",\"restart\":true}");
delay(500); delay(500);
ESP.restart(); ESP.restart();
} }
}
} }