快速入门

[English]

本文档介绍如何获取和使用 ESP-Brookesia 组件，以及如何编译和运行示例工程。

ESP-Brookesia 版本说明

ESP-Brookesia 自 v0.7 版本起采用组件化管理，建议项目通过组件注册表获取所需组件，约定如下：

1. 各组件独立迭代，但均具有相同的 major.minor 版本号，并且依赖相同的 ESP-IDF 版本。

2. release 分支仅维护历史大版本，master 分支持续集成新特性。

不同版本说明如下，组件列表与更新说明请参考：

ESP-Brookesia 版本支持情况

ESP-Brookesia	依赖的 ESP-IDF	主要变更	支持状态
master (v0.7)	>= v5.5, < 6.0	支持组件管理器	新功能开发分支
release/v0.6	>= v5.3, <= 5.5	预览支持系统框架，提供 ESP-VoCat 固件工程	停止维护

开发环境搭建

ESP-IDF 是乐鑫为 ESP 系列芯片提供的物联网开发框架：

• ESP-IDF 包含一系列库及头文件，提供了基于 ESP SoC 构建软件项目所需的核心组件；

• ESP-IDF 还提供了开发和量产过程中最常用的工具及功能，例如：构建、烧录、调试和测量等。

备注

• 请参考：ESP-IDF 编程指南 完成 ESP-IDF 开发环境的搭建。

• 不推荐使用 VSCode 扩展插件安装 ESP-IDF 环境，可能导致部分依赖 esp_board_manager 组件的示例编译失败。

硬件准备

ESP 系列 SoC 支持以下功能：

• Wi-Fi（2.4 GHz/5 GHz 双频）

• 蓝牙 5.x（BLE/Mesh）

• 高性能多核处理器，主频最高可达 400 MHz

• 超低功耗协处理器和深度睡眠模式

• 丰富的外设接口：

  • 通用接口：GPIO、UART、I2C、I2S、SPI、SDIO、USB OTG 等

  • 专用接口：LCD、摄像头、以太网、CAN、Touch、LED PWM、温度传感器等

• 大容量内存：

  • 内部 RAM 最大可达 768 KB

  • 支持外部 PSRAM 扩展

  • 支持外部 Flash 存储

• 增强的安全特性：

  • 硬件加密引擎

  • 安全启动

  • Flash 加密

  • 数字签名

ESP 系列 SoC 采用先进工艺制程，提供业界领先的射频性能、低功耗特性和稳定可靠性，适用于物联网、工业控制、智能家居、可穿戴设备等多种应用场景。

备注

• 各系列芯片的具体规格和功能请参考 ESP 产品选型工具。

• 参考 ESP-Brookesia HAL 开发板支持 快速开始

• ESP-Brookesia 对内存和 Flash 占用较高，建议选用 Flash ≥ 8 MB、PSRAM ≥ 4 MB 的芯片或开发板。

如何获取和使用组件

推荐通过 ESP Component Registry 获取 ESP-Brookesia 组件。

以 brookesia_service_wifi 组件为例，添加依赖的步骤如下：

1. 使用命令行

   在工程目录下运行以下命令：

   idf.py add-dependency "espressif/brookesia_service_wifi"
   

2. 修改配置文件

   在工程目录下创建或修改 idf_component.yml 文件：

   dependencies:
      espressif/brookesia_service_wifi: "*"
   

更多组件管理器的使用方法请参考 ESP Registry Docs。

如何使用示例工程

ESP-Brookesia 提供了多个示例工程。示例工程的使用方法如下：

1. 确保已经完成 ESP-IDF 开发环境的搭建

2. 选择目标芯片或开发板。根据功能依赖的外设不同，该步骤可分为：

   • 选择目标芯片：

     以 examples/service/wifi 示例工程为例，该工程仅依赖于芯片的 WiFi 外设功能，因此仅需选择目标芯片（如 esp32s3 等）：

     idf.py set-target <target>
     

   • 选择目标开发板：

     以 examples/service/console 示例工程为例，该工程依赖于开发板的音频外设功能，因此需要选择目标开发板（如 esp_vocat_board_v1_2 等）：

     idf.py gen-bmgr-config -b <board>
     idf.py set-target <target>
     

3. 配置项目（可选）：

   idf.py menuconfig
   

4. 编译并烧录到开发板：

   idf.py build
   idf.py -p <PORT> flash
   

5. 通过串口监视输出：

   idf.py -p <PORT> monitor
   

更多示例请见 examples/ 目录，具体使用方法请参考各示例目录下的 README 文件。