Tools for building ESP-IDF related apps.
Project description
idf-build-apps
idf-build-apps
is a tool that helps users find and build ESP-IDF projects faster.
What is an app
?
An ESP-IDF project would typically contain:
- Build recipe in CMake and the main component with app sources
- (Optional) One or more sdkconfig files
app
is the abbreviation for application. An application is the binary that is being built with the specified sdkconfig and the target chip. idf-build-apps
could build one project into a number of applications.
Installation
pip install idf-build-apps
or pipx
pipx install idf-build-apps
Basic Usage
idf-build-apps
is a callable python package, and an executable script with the same name would also be installed. It contains two sub-commands.
find
to find the buildable applicationsbuild
to build the found applications
For detailed explanation to all CLI options, you may run
idf-build-apps -h
idf-build-apps find -h
idf-build-apps build -h
Quick Example
To build the applications for all targets of the ESP-IDF hello world example project under ESP-IDF v5.0:
idf-build-apps build -p $IDF_PATH/examples/get-started/hello_world/ --target all --build-dir build_@t
It would get the default supported targets from your IDF version, build the hello world project with all targets and the default sdkconfig
file.
Partial build log:
2023-02-22 12:14:58 INFO Found 5 apps in total
2023-02-22 12:14:58 INFO Total 5 apps. running build for app 1-5
2023-02-22 12:14:58 INFO Building the following apps:
2023-02-22 12:14:58 INFO (cmake) App /tmp/test/esp/esp-idf/examples/get-started/hello_world/, target esp32, sdkconfig (default), build in /tmp/test/esp/esp-idf/examples/get-started/hello_world/build_esp32 (preserve: True)
2023-02-22 12:14:58 INFO (cmake) App /tmp/test/esp/esp-idf/examples/get-started/hello_world/, target esp32c2, sdkconfig (default), build in /tmp/test/esp/esp-idf/examples/get-started/hello_world/build_esp32c2 (preserve: True)
2023-02-22 12:14:58 INFO (cmake) App /tmp/test/esp/esp-idf/examples/get-started/hello_world/, target esp32c3, sdkconfig (default), build in /tmp/test/esp/esp-idf/examples/get-started/hello_world/build_esp32c3 (preserve: True)
2023-02-22 12:14:58 INFO (cmake) App /tmp/test/esp/esp-idf/examples/get-started/hello_world/, target esp32s2, sdkconfig (default), build in /tmp/test/esp/esp-idf/examples/get-started/hello_world/build_esp32s2 (preserve: True)
2023-02-22 12:14:58 INFO (cmake) App /tmp/test/esp/esp-idf/examples/get-started/hello_world/, target esp32s3, sdkconfig (default), build in /tmp/test/esp/esp-idf/examples/get-started/hello_world/build_esp32s3 (preserve: True)
For detailed information, please refer to our documentation site!
Contributing
Thanks for your contribution! Please refer to our Contributing Guide
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for idf_build_apps-1.0.0.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58a5d5e1252ffb1b5ad5b391f632b84c3a8bc7d8cdaa2d19ef9007a10b2ac83e |
|
MD5 | 53c01440e8f3b0acc655be7355491b46 |
|
BLAKE2b-256 | 1a4b7e0e1b7ea90fd82ea313d0bc8ab590050371bb3789c84b6ee5625299177f |
Hashes for idf_build_apps-1.0.0.dev1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 789bf5172690876b10d03cbf6e7ce718b9b8ff2922ca58fec22f135143ec48db |
|
MD5 | 9e0a4e858cff6d70e308572957c66604 |
|
BLAKE2b-256 | ff9530f46ca977ca7885ea8fc111813ec7c2bc166469b352d12b9f16faf5167a |