Files and pins

Path

What it is

build.py

The build command: every option. It fills in micropython/, modules/ and deps/ if they’re missing, prepares the MicroPython tree and runs the port’s own make.

build_mp.py

The code build.py runs. It keeps working under its own name for now, so older instructions still do.

DEPENDENCIES.lock

Everything build.py fetches, one <name> <url> <commit> line each: the MicroPython commit everything applies to; the modules it clones when one isn’t there; omnipython-lvgl, LVGL with its bindings and a port per interpreter, which a build with lvgl (or all) fetches into modules/.omnipython-lvgl; esp-vision; and the toolchains: ESP-IDF, emsdk, the TinyUSB the esp32 port builds on, and CircuitPython for --interpreter circuitpython. A toolchain’s line ends in the tag its commit is. SDL2 for MinGW and the ESP-IDF components CircuitPython builds ask for are downloads, pinned by version. Beside sibling checkouts, modules are links to those checkouts instead. python3 scripts/pins.py --list prints the file as the build reads it.

provenance.json

The MicroPython pin and the checksum of every patch in patches/micropython/, patches/tinyusb/ and patches/esp_hosted/.

modules/

manifest.py, the manifest every build freezes; all/; the modules, linked or cloned; and .esp-vision/, the fetch script for esp-vision’s modules.

patches/micropython/

Our patch series, numbered from 0001-… (there is no 0026, whose fix moved into patches/tinyusb/), each justified in its own header.

patches/tinyusb/

Patches to the TinyUSB the esp32 port builds on the S2, S3 and P4, which build.py applies to deps/espressif__tinyusb (at its DEPENDENCIES.lock tag) and builds in place of the port’s own copy.

patches/esp_hosted/

Patches to esp_hosted, the P4’s Wi-Fi through its companion chip, applied the same way to deps/espressif__esp_hosted (at its DEPENDENCIES.lock commit).

patches/micropython-lib/

micropython-lib’s own fixes from after the commit MicroPython’s lib/micropython-lib points at. A firmware that freezes those packages, and a board whose /lib you fill from the submodule, both get them.

patches/circuitpython/

Our patches to CircuitPython, applied to deps/circuitpython.

patches/apply_patches.py

Applies the MicroPython series, plus each module’s own MicroPython patches, once, as one local commit. --check tests a change without applying it.

variants/

Our variants and the esp32 settings.

boards/circuitpython/

Boards CircuitPython has no definition for.

scripts/

pins.py, exercise_build.sh, release_firmware.py, stage_firmware_page.py, serve_workbench.sh, freeze_list.py, update_provenance.py, ci_scope.py, wasm_provenance.py. Contributing says what each is for.