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, and ESP8266 RTOS projects in a large scale.
What is an app
?
A project using ESP-IDF SDK, or ESP8266 RTOS SDK typically contains:
- Build recipe in CMake or Make and the main component with app sources
- (Optional) One or more sdkconfig files
app
is the abbreviation for application. An application is a set of binary files that is being built with the specified sdkconfig and the target chip. idf-build-apps
could build one project into a number of applications according to the matrix of these two parameters.
Installation
pip install idf-build-apps
or pipx
pipx install idf-build-apps
Basic Usage
idf-build-apps
is a python package that could be used as a library or a CLI tool.
As a CLI tool, 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
As a library, you may check the API documentation for more information. Overall it provides
- Two functions,
find_apps
andbuild_apps
- Two classes,
CMakeApp
andMakeApp
Quick CLI Example
To build ESP-IDF hello world example project with ESP32:
idf-build-apps build -p $IDF_PATH/examples/get-started/hello_world/ --target esp32
The binary files will be generated under $IDF_PATH/examples/get-started/hello_world/build
directory.
Documentation
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-2.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8c64c0d8cacbbf215cf6b65a271ffa28c8550d48b2bb1df9ea86ddf259cd144 |
|
MD5 | 9ab9f1004b7210397289e6d62c6c0f1b |
|
BLAKE2b-256 | 862e008646f37945047835887e66e2095fa5018a473e4dcece1b6b2672f82152 |