README.md

ESP32 Graphical Bootloader

3rd stage graphical bootloader which lets you pick applications stored in OTA partitions.

How it works

The bootloader allows user to select an application from graphical menu. After the selection the partition is selected and the chip rebooted. The bootloader switches to the newly selected application. During the start of the application there is a code which switches bootloader back to the first application with the bootloader. After another restart the original application with the bootloader is visible again.

Test on-line

Run on-line in Wokwi Simulator

Selected board

The project is by default configured for ESP32-S3-BOX-3. Build configuration for the available boards are stored in boards directory. If you need a different board please run one of following exports and then CMake command:

• ESP32-S3-BOX-3

idf.py @boards/esp-box-3.cfg reconfigure

• ESP32-S3-BOX (prior Dec. 2023)

idf.py @boards/esp-box.cfg reconfigure

• ESP32-P4

idf.py @boards/esp32_p4_function_ev_board.cfg reconfigure

• M5Stack-CoreS3

idf.py @boards/m5stack_core_s3.cfg reconfigure

Quick start

Build and flash all applications at once:

cmake -DBUILD_BOARD=esp-box-3 -Daction=build_all_apps -P Bootloader.cmake

Build applications one by one

Applications are stored in ota_0 - ota_4 with the following offset:

• ota_0 - 0x220000
• ota_1 - 0x4E0000
• ota_2 - 0x7A0000
• ota_3 - 0xA60000
• ota_4 - 0xD20000

Commands to build and flash appplications:

idf.py @boards/esp-box-3.cfg build
pushd apps/tic_tac_toe
idf.py @../../boards/esp-box-3.cfg build
esptool.py --before default_reset --after hard_reset write_flash 0x220000 build.esp-box-3/tic_tac_toe.bin
popd
pushd apps/wifi_list
idf.py @../../boards/esp-box-3.cfg build
esptool.py --before default_reset --after hard_reset write_flash 0x4E0000 build.esp-box-3/wifi_list.bin
popd
pushd apps/calculator
idf.py @../../boards/esp-box-3.cfg build
esptool.py --before default_reset --after hard_reset write_flash 0x7A0000 build.esp-box-3/calculator.bin
popd
pushd apps/synth_piano
idf.py @../../boards/esp-box-3.cfg build
esptool.py --before default_reset --after hard_reset write_flash 0xA60000 build.esp-box-3/synth_piano.bin
popd
pushd apps/game_of_life
idf.py @../../boards/esp-box-3.cfg build
esptool.py --before default_reset --after hard_reset write_flash 0xD20000 build.esp-box-3/game_of_life.bin
popd

Alternatively you can use espflash:

espflash write-bin 0xD20000 .\build.esp-box-3\app.bin

Merging all applications

The following command merges all applications into binary image format:

esptool.py --chip esp32s3 merge_bin  -o build.esp-box-3/combined.bin --flash_mode dio --flash_size 16MB \
    0x0 build.esp-box-3/bootloader/bootloader.bin \
    0x8000 build.esp-box-3/partition_table/partition-table.bin \
    0xf000 build.esp-box-3/ota_data_initial.bin \
    0x20000 build.esp-box-3/esp32-graphical-bootloader.bin \
    0x220000 apps/tic_tac_toe/build.esp-box-3/tic_tac_toe.bin \
    0x4E0000 apps/wifi_list/build.esp-box-3/wifi_list.bin \
    0x7A0000 apps/calculator/build.esp-box-3/calculator.bin \
    0xA60000 apps/synth_piano/build.esp-box-3/synth_piano.bin \
    0xD20000 apps/game_of_life/build.esp-box-3/game_of_life.bin

The single binary can be flashed by command:

esptool.py --chip esp32s3  --baud 921600 write_flash 0x0000 build.esp-box-3/combined.bin

Create custom app

You can use ESP-IDF app, just you need to make sure that application has fallback mechanism to factory app. This can be achieving by following code.

Updating apps to fallback to bootloader

The bootloader is using OTA mechanism. It's necessary to add following code to the application in order to reboot to bootloader.

Put the following code to main, before starting the rest of the application:

#include "esp_ota_ops.h"

const esp_partition_t* factory_partition = esp_partition_find_first(ESP_PARTITION_TYPE_APP, ESP_PARTITION_SUBTYPE_APP_FACTORY, NULL);
if (factory_partition != NULL) {
    esp_ota_set_boot_partition(factory_partition);
}

More elaborate version which can be put somwhere into application, like reaction on back button:

#include "esp_ota_ops.h"

// Get the partition structure for the factory partition
const esp_partition_t *factory_partition = esp_partition_find_first(ESP_PARTITION_TYPE_APP, ESP_PARTITION_SUBTYPE_APP_FACTORY, NULL);
if (factory_partition != NULL) {
    if (esp_ota_set_boot_partition(factory_partition) == ESP_OK) {
        printf("Set boot partition to factory.\n");
    } else {
        printf("Failed to set boot partition to factory.\n");
    }
} else {
    printf("Factory partition not found.\n");
}

fflush(stdout);
printf("Restarting now.\n");
esp_restart();

If the project is using explicit list of components, you need to add app_update into main/CMakeLists.txt, so it looks like this:

idf_component_register(
    SRCS "main.cpp"
    INCLUDE_DIRS "."
    REQUIRES app_update
)