idf-build-apps 2.5.0

Tools for building ESP-IDF related apps.

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 three sub-commands.

• find to find the buildable applications
• build to build the found applications
• completions to activate autocompletions or print instructions for manual activation

For detailed explanation to all CLI options, you may run

idf-build-apps -h
idf-build-apps find -h
idf-build-apps build -h
idf-build-apps completions -h

As a library, you may check the API documentation for more information. Overall it provides

• Two functions, find_apps and build_apps
• Two classes, CMakeApp and MakeApp

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