ESP-ESP_BOARD_MANAGER Component

[中文]

Note

This document is automatically translated using AI. Please excuse any detailed errors. The official English version is still in progress.

Overview

ESP_BOARD_MANAGER is a board-level management component developed by Espressif, focusing on the initialization of development board devices. It uses YAML files to describe the configuration of peripheral devices, can automatically generate configuration code, and simplifies the process of adding new boards. It provides a unified device management interface, not only improving the reusability of device initialization code, but also simplifying the adaptation of applications to various development boards.

Note

The current ESP Board Manager is compatible with ESP-IDF release/v5.4 (>= v5.4.3) and release/v5.5 (>= v5.5.2) branches.

Core Concepts

  • YAML Configuration: Information about the board’s pins, levels, driver parameters, etc. are all defined in the YAML file, avoiding the need to write initialization code directly.

  • Code Generation: The build system will automatically generate C language initialization code, Kconfig menu, and CMake dependencies based on the YAML configuration.

  • Layered Architecture:

    • Board: Overall description of the development board.

    • Device: Device implementation, such as LCD, Codec, Button, depends on one or more peripherals.

    • Peripheral: Peripheral implementation, such as I2C, SPI, GPIO, I2S.

Auxiliary Tools

esp-bmgr-assist can be used to automatically discover and load ESP Board Manager extensions, reducing the steps to manually set IDF_EXTRA_ACTIONS_PATH, and perform necessary pre-checks in build-like commands.

Installation Method

In an already activated IDF environment, you can use the following command to install esp-bmgr-assist:

# Installation command
pip install esp-bmgr-assist

# Upgrade command
pip install --upgrade esp-bmgr-assist

Component Pull Optimization

After installing esp-bmgr-assist, you can pull the component without going through set target, esp-bmgr-assist will automatically trigger the component pull.

// Before use:
set target // Pull component
idf.py bmgr xxx // Run command

// After use:
idf.py bmgr xxx // Pull component and run command

For more instructions and precautions about esp-bmgr-assist, please check the installation package link.