Skip to content

Add example to update ESP32 via SD card #628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 29, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 111 additions & 0 deletions libraries/Update/examples/SD_Update/SD_Update.ino
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
/*
Name: SD_Update.ino
Created: 12.09.2017 15:07:17
Author: Frederik Merz <[email protected]>
Purpose: Update firmware from SD card

Steps:
1. Flash this image to the ESP32 an run it
2. Copy update.bin to a SD-Card, you can:
- Use the file supplied in the examples folder
- Compile an own app and rename the app binary to update.bin
3. Connect SD-Card as shown in SD_MMC example,
this can also be adapted for SPI
3. After successfull update and reboot, ESP32 shall start the new app
*/

#include <Update.h>
#include <FS.h>
#include <SD_MMC.h>

// perform the actual update from a given stream
void performUpdate(Stream &updateSource, size_t updateSize) {
if (Update.begin(updateSize)) {
size_t written = Update.writeStream(updateSource);
if (written == updateSize) {
Serial.println("Written : " + String(written) + " successfully");
}
else {
Serial.println("Written only : " + String(written) + "/" + String(updateSize) + ". Retry?");
}
if (Update.end()) {
Serial.println("OTA done!");
if (Update.isFinished()) {
Serial.println("Update successfully completed. Rebooting.");
}
else {
Serial.println("Update not finished? Something went wrong!");
}
}
else {
Serial.println("Error Occurred. Error #: " + String(Update.getError()));
}

}
else
{
Serial.println("Not enough space to begin OTA");
}
}

// check given FS for valid update.bin and perform update if available
void updateFromFS(fs::FS &fs) {
File updateBin = fs.open("/update.bin");
if (updateBin) {
size_t updateSize = updateBin.size();

if (updateSize > 0) {
Serial.println("Try to start update");
performUpdate(updateBin, updateSize);
}
else {
Serial.println("Error, file is empty");
}

updateBin.close();

//remove any previous leftovers
if (fs.exists("/update_old.bin")) {
fs.remove("/update_old.bin");
}

//rename the file to prevent an infinite loop of updates
fs.rename("/update.bin", "/update_old.bin");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not just delete it?

}
else {
Serial.println("Could not load update.bin from sd root");
}
}

void setup() {
uint8_t cardType;
Serial.begin(115200);
Serial.println("Welcome to the SD-Update example!");

// You can uncomment this and build again
// Serial.println("Update successfull");

//first init and check SD card
if (!SD_MMC.begin()) {
Serial.println("Card Mount Failed");
goto end;
}

cardType = SD_MMC.cardType();

if (cardType == CARD_NONE) {
Serial.println("No SD_MMC card attached");
goto end;
}

updateFromFS(SD_MMC);

end:
delay(1000);
ESP.restart();
}

//will not be reached
void loop() {

}
Binary file added libraries/Update/examples/SD_Update/update.bin
Binary file not shown.