ESP-ESP_BOARD_MANAGER 组件

[English]

概述

ESP_BOARD_MANAGER 是由乐鑫开发的专注于开发板设备初始化的板级管理组件。使用 YAML 文件来描述外围设备的配置，能够自动生成配置代码，简化了添加新板子的过程。提供了统一的设备管理接口，不仅提高了设备初始化代码的可重用性，还简化了应用程序对各种开发板的适配。

备注

当前 ESP Board Manager 兼容 ESP-IDF release/v5.4（>= v5.4.3） 和 release/v5.5（>= v5.5.2） 分支。

核心概念

  • YAML 配置: 关于板子的引脚、电平、驱动参数等信息都只在 YAML 文件中定义，避免了直接编写初始化代码。

  • 代码生成: 构建系统会根据 YAML 配置，自动生成 C 语言的初始化代码、Kconfig 菜单和 CMake 依赖关系。

  • 分层架构:

    • 板子: 开发板的整体描述。

    • 设备: 设备实现, 如 LCD、Codec、Button, 依赖一个或多个外设。

    • 外设: 外设实现, 如 I2C, SPI, GPIO, I2S。

辅助工具

esp-bmgr-assist 可以用于自动发现并加载 ESP Board Manager 扩展，减少手动设置 IDF_EXTRA_ACTIONS_PATH 的步骤，并在构建类命令中执行必要的预检查。

安装方法

在已经激活的 IDF 环境中，可以使用以下命令安装 esp-bmgr-assist：

# 安装命令
pip install esp-bmgr-assist

# 升级命令
pip install --upgrade esp-bmgr-assist

组件拉取优化

安装 esp-bmgr-assist 后，可以不通过 set target 来拉取组件，esp-bmgr-assist 会自动触发拉取组件。

// 使用前：
set target // 拉组件
idf.py bmgr xxx // 运行命令

// 使用后：
idf.py bmgr xxx // 拉组件并运行命令

有关 esp-bmgr-assist 的更多说明以及注意事项请查看 安装包链接。

相关链接