板级支持组件 (Boards)¶
本文档主要介绍板级支持组件 (Boards) 的使用方法,该组件作为示例程序的公共组件,可向应用程序提供统一的引脚宏定义和与硬件无关的初始化操作,基于板级支持开发的应用程序可以同时兼容不同的开发板,具体功能如下:
提供统一的引脚资源宏定义
提供默认的外设配置参数
提供统一的板级初始化接口
提供开发板的硬件控制接口
Boards 组件的结构如下:
Boards 组件中包含以下内容:
board_common.h
,包含了公有 API 的函数声明board_common.c
,包含了对公有 API 的函数实现(虚函数)Kconfig.projbuild
,包含了公有的配置项
以开发板名称命名的子文件夹包含以下内容:
iot_board.h
提供了开发板的引脚资源定义,该开发板特有的自定义 API 函数声明board.c
提供了公有 API 的用户实现(默认虚函数),自定义 API 函数实现kconfig.in
,提供了该开发板特有的自定义配置项。
注解
Boards 在 examples/common_components/boards
中提供。
使用方法¶
初始化开发板:在
app_main
使用iot_board_init
初始化开发板,用户亦可在menuconfig
中使用 开发板切换和配置 进行初始化配置;获取外设句柄:使用
iot_board_get_handle
和board_res_id_t
获取外设资源的句柄,如果该外设未被初始化将返回NULL
;使用句柄进行外设操作。
示例:
void app_main(void)
{
/*initialize board with default parameters,
you can use menuconfig to choose a target board*/
esp_err_t err = iot_board_init();
if (err != ESP_OK) {
goto error;
}
/*get the i2c0 bus handle with a board_res_id,
BOARD_I2C0_ID is declared in board_res_id_t in each iot_board.h*/
bus_handle_t i2c0_bus_handle = (bus_handle_t)iot_board_get_handle(BOARD_I2C0_ID);
if (i2c0_bus_handle == NULL) {
goto error;
}
/*
* use initialized peripheral with handles directly,
* no configurations required anymore.
*/
}
开发板切换和配置¶
基于 Boards
开发的应用程序,可以使用以下方法切换和配置开发板:
选择目标开发板:在
menuconfig->Board Options->Choose Target Board
中选择一个开发板;配置开发板参数:
Board Common Options
中包含公有的开发板配置项,例如配置是否在开发板初始化期间初始化i2c_bus
;XXX Board Options
中包含了该开发板特有的配置项,例如切换开发板供电状态等。使用
idf.py build flash monitor
重新编译并下载代码。
注解
编译系统编译目标默认为 ESP32
,如使用 ESP32-S2
,请在编译之前使用 idf.py set-target esp32s2
配置目标。
已支持的开发板¶
ESP32 开发板 |
|
ESP32-S2 开发板 |
|
ESP32-S3 开发板 |
|
添加新的开发板¶
通过添加新的开发板,可以快速适配基于 Boards
组件开发的应用程序。
添加开发板过程:
按照 组件文件结构 准备必要的
iot_board.h
;按照需求在
board_xxx.c
添加该开发板特有的函数实现,或对公有的弱函数进行覆盖;按照需求在
kconfig.in
添加该开发板特有的配置项;将开发板信息添加到
Kconfig.projbuild
,供用户选择;将开发板目录添加到
CMakeLists.txt
,使其能被编译系统索引。如果需要支持老的make
编译系统,请同时修改component.mk
。
注解
可复制 Boards
中已添加的开发板文件夹,通过简单修改完成开发板的添加。
组件依赖¶
公共依赖项:bus, button, led_strip
已适配 IDF 版本¶
ESP-IDF v4.4 及以上版本。
已适配芯片¶
ESP32
ESP32-S2
ESP32-S3