使用网页创建开发板

[English]

ESP Board Manager 网页配置工具在浏览器中创建开发板配置、导出板级 YAML 文件,并导入 BMGR 工程验证。工具的功能范围和使用边界见 Board Manager 网页配置工具

准备工作

  • 准备目标开发板的原理图和相关器件资料,用于确认引脚号、地址、时钟和时序参数。

  • 确认目标主控芯片和计划使用的 ESP-IDF 版本。

创建流程

打开网页

在浏览器中访问 https://board-manager.espressif.com/ ,进入主配置页。

填写基础信息

在首页表单中填写开发板名称、制造商和描述,选择目标 ESP-IDF 版本和主控芯片。开发板名称只允许小写字母、数字和下划线,将作为 board_info.yaml 中的 board 字段和导出文件名。所选芯片在目标 ESP-IDF 版本上不受支持时,表单会提示选择更高版本。

除了手动填写基础信息,还可以通过导入已有配置进行修改,支持以下导入方式:

  • 导入本地板级目录:选择本地板级目录,需要至少包含 board_info.yamlboard_devices.yamlboard_peripherals.yaml 三个文件。

  • 导入官方板卡:选择官方板卡,来自 esp_boards 组件,该组件默认在 BMGR 中声明依赖,无需额外声明。

  • 导入板卡组件:选择板卡组件,默认来自 esp_friends_boardsm5stack_boards 组件,也可以搜索并加载其他板卡组件后进行选择和导入。

填写完成后进入配置表。

添加设备与外设

从左侧设备库和外设库点击添加条目,再在每个配置卡片中按分组填写,主要包括:

  • 模式与选项:选择 sub_typeroleformat 等字段,按实际硬件路径配置。

  • IO 引脚分配:按原理图填写真实引脚号。

  • 待确认参数:查阅器件资料确认后填写时钟、地址、时序等取值,通常与硬件功能是否正常直接相关。

  • 供电控制设备依赖:分别配置设备的 power_ctrl_devicedepends_on

  • IDF 组件依赖:搜索并选择组件仓库中的组件,导出为设备 dependencies

  • 依赖外设配置:为设备绑定其引用的外设实例。

设备与外设的字段规范见 参考手册

配置校验与修正

配置表会结合所选芯片和 ESP-IDF 版本执行校验,并在”配置校验结果”面板汇总问题。点击问题行可定位到对应的配置卡片。

常见提示包括:

  • 芯片能力错误:当前配置超出所选芯片支持范围。这类问题会拦截导出,应检查目标芯片和 ESP-IDF 版本是否选择正确,或调整不受支持的设备、外设与模式组合。

  • IO 引脚复用警告:多个配置占用了同一引脚。这类问题不会拦截导出,但通常需要回到相关卡片的”IO 引脚分配”,按原理图重新分配引脚,或检查是否误用了外设实例。

网页校验用于提前发现明显问题,不替代 idf.py bmgr -b、编译和实板调试。

导出板级文件

配置完成后导出一个以开发板名称命名的 zip 包,解压后得到:

  • board_info.yaml

  • board_devices.yaml

  • board_peripherals.yaml

  • setup_device.c(如有)

当所选设备需要纯 YAML 无法描述的板级初始化逻辑(如显示屏工厂函数)时,工具会附带生成 setup_device.c。该文件只是按工厂函数接口生成的代码模板,不能直接使用,需要结合实际硬件补全初始化逻辑(复位时序、命令序列、参数等)并在板上调试通过。

放入工程

将解压出的板卡目录放入工程根目录下的 components/ 中,目录名与开发板名称一致:

components/
└── my_board/
    ├── board_info.yaml
    ├── board_devices.yaml
    ├── board_peripherals.yaml
    └── setup_device.c   # 如有

确认 board_info.yaml 中的 board 字段与目录名一致。

生成与验证

idf.py bmgr -b my_board

生成成功后,components/gen_bmgr_codes/ 下应包含:gen_board_periph_config.cgen_board_device_config.cgen_board_info.cboard_manager.defaultsKconfig.projbuildidf_component.yml 等文件。

正式使用前逐项确认:

  • board_info.yaml 中的开发板名称与目录名一致。

  • 所有引脚号已按原理图核实。

  • 时钟、地址、时序等需查器件资料确认的参数已填写真实值。

  • 设备引用的所有外设名均存在于 board_peripherals.yaml 中。

  • dependencies 中的组件能正常解析。

  • 如生成了 setup_device.c,其中的工厂函数已结合实际硬件补全并调试通过。

通过上述检查后,建议在新开发板上运行示例工程或测试应用,进一步验证外设与设备初始化是否正常:

  • 示例工程esp_board_manager/examples/ 目录下提供了音频播放、录音、LVGL 显示等场景示例,可直接切换至新开发板运行,验证实际硬件行为。

  • 测试应用esp_board_manager/test_apps/ 提供了针对板级初始化流程的系统测试,适合全面验证生成代码的正确性。


此文档对您有帮助吗?