Skip to content

firmware

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

firmware

README.md

PyBLE agent firmware

PyBLE firmware combines pinned upstream MicroPython with a portable PBLE/1 BLE agent and board overlays. Upstream source remains a Git submodule and is not edited in place.

Initial ports

PyBLE target Upstream IDF target Public browser profile
esp32 esp32 esp32-4mb
esp32-s3 esp32s3 esp32-s3-n16r8
esp32-c3 esp32c3 esp32-c3-4mb after HIL qualification

These targets are reference ports, not the permanent scope of the platform.

Initialize

From the repository root:

git submodule update --init --recursive
firmware/scripts/install_esp_idf.sh

Pins for MicroPython, ESP-IDF, toolchains, and target mappings live in versions.lock.

Build

Inspect a build plan without installing ESP-IDF:

firmware/scripts/build.sh --plan esp32

Build one target:

firmware/scripts/build.sh esp32
firmware/scripts/build.sh esp32-s3
firmware/scripts/build.sh esp32-c3

Or build the complete matrix:

firmware/scripts/build_all.sh

Build outputs are local and ignored. Release artifacts are published through GitHub Releases rather than committed to this repository.

Test

Fast repository and firmware gates:

firmware/scripts/check.sh
tests/firmware_tests/run_tests.sh

Hardware validation and release qualification have additional prerequisites; see:

Upstream and patches

Do not edit firmware/upstream/micropython in place. Target-specific files live under board_overlays/ and are copied into the build tree by the preparation step.

The default patch set is empty. Any unavoidable upstream patch belongs under patches/, must document why an overlay or upstream fix is insufficient, and must pass the patch-policy gate.

License

PyBLE-authored firmware source is MIT. Upstream MicroPython, ESP-IDF, compiler runtimes, and bundled components retain their own licenses. The release license policy, notices, and reviewed evidence live under licenses/.