This repository is an aggregator of other projects for the MCH badge. Its purpose is to build the firmware and images for other partitions, generate a FatFS partition for the internal FAT partition and make them all flashable in one command.
We include the mch2022-firmware-esp32 repository as a submodule, which in
turn contains the ESP IDF in the version required for the firmware to compile
(currently release version 4.4.1). The repo also includes an instance of the
ESP IDF in a diffent version (current master) for building the wear-leveled
FatFS image. At time of writing, these versions differ. At a later time, this
process might be simplified. Note that currently only the IDF included as a
submodule from mch2022-firmware-esp32 will be sourced and used. The IDF
included as a submodule is only used for referencing the FATFS generation
scripts.
The whole process is executed via the Makefile. It will:
- compile the firmware (including bootloader, partition table, and other partition binaries)
- compile the sponsor slideshow app (that is also included as a submodule)
- generate an appfs image and add the slideshow app to it
- generate a wear-balanced fatfs filesystem
- copy all needed binaries to a destination directory
- generate an args file that can be passed to esptool.py
- git
- GNU make
(other stuff such as Python will be installed by and used from the firmware submodule)
- Clone this repo
- Update submodules and install ESP-IDF dependencies:
make prepare - Make sure you have checked out the correct versions of the firmware and slideshow submodules (see using
git submodule) - Copy files that should go into the FatFS partition into the
fatfs-contentsdirectory, remove the placeholder file. - Copy apps that should be included on the AppFS to
appfs-contentsand add their info toapplist.csv - run
make - The arguments to
esptool.pywill be printed when make is done.
The default procedure collects several binary blobs and generates a script
to flash them all individually. Alternatively, you can run make singlebin, which will merge all binary blobs into a single image file to
flash to address 0x0. This may be slightly slower to flash, but a single file
may be convenient in certain situations.
Choosing a good baud rate is an important factor for fast flashing. During testing, a speed of around 2Mbit/s was the fastest transfer rate before running into communication errors.
- Flash individual bins without -e (full erase) option: 80s
- Flash individual bins with -e (full erase) option: 85s
- Flash single bin (implies full erase): 85s