跳到主要内容

ESP-IDF 开发

本章节包含以下内容，请按需阅读：

ESP-IDF 入门教程​

初次接触 ESP32 ESP-IDF 开发，想要快速上手？我们为您准备了一套通用的 入门教程。

请注意：该教程使用 ESP32-S3-Zero 作为教学示例，所有硬件代码均基于其引脚布局。在动手实践前，建议您对照手中的开发板引脚图，确认引脚配置无误。

配置开发环境​

信息

V1 示例需要使用 ESP-IDF V5.1.4 及以上版本。10_FactoryProgram 使用 V5.2.0 以上版本时可能无法扫描到周围的 Wi-Fi；如需测试该功能，可使用较低版本编译，或直接烧录 V1 资料包提供的 BIN 固件。

V2 仓库中的 09_LVGL_V9_Test 配置基于 ESP-IDF V5.5.2，其依赖锁定文件记录的版本为 V5.5.4。使用 V2 示例时，请优先使用 ESP-IDF V5.5.x。

备注

以下内容以 Windows 系统为例，使用 VS Code + ESP-IDF 扩展 的方式进行开发。Mac/Linux 用户请参考 官方说明。

版本选择

此部分图示以安装 ESP-IDF V5.5.2 为例示范，安装时请选用与您开发板示例匹配的 ESP-IDF 版本。

安装 ESP-IDF 开发环境​

  1. 前往 ESP-IDF Installation Manager 下载 ESP-IDF 安装管理器。这是乐鑫最新推出的跨平台安装工具，下文将演示如何使用其离线安装功能。

    在页面中点击 Offline Installer 标签，然后在筛选栏中选择 Windows 操作系统和你需要的 ESP-IDF 版本（图示仅为参考，请以实际为准）。

    下载 EIM 和整合包

    确认选择无误后，点击下载按钮。浏览器将自动同时下载两个文件：一个是 ESP-IDF 离线整合包(.zst)，另一个是 ESP-IDF 安装器(.exe)。

    下载 EIM 和整合包2

    请耐心等待两个文件下载完成。

  2. 下载完成后，双击运行 ESP-IDF 安装器(eim-gui-windows-x64.exe)。

    启动后，可在右上角将界面语言切换为中文。

    切换 EIM 语言

    安装工具会自动检测同一目录下是否存在离线整合包。点击 从存档安装。

    自动检测整合包

    接下来，选择安装路径。建议使用默认路径；若需自定义，请确保路径中不包含中文或空格。确认无误后，点击 开始安装。

    选择安装路径

  3. 当看到如下界面时，表示 ESP-IDF 已安装成功。

    安装成功

  4. 建议同时安装驱动程序。点击 完成安装，然后点击 安装驱动程序。

    用 ESP-IDF 安装管理器安装驱动

安装 Visual Studio Code 与 ESP-IDF 扩展​

  1. 下载并安装 Visual Studio Code。

  2. 安装时建议勾选 通过 Code 打开操作添加到 Windows 资源管理器文件上下文菜单,以便快速打开项目文件夹。

  3. 在 VS Code 中,点击侧边活动栏中的 扩展图标 扩展图标(或使用快捷键 Ctrl + Shift + X)打开 扩展 视图。

  4. 在搜索框中输入 ESP-IDF,找到 ESP-IDF 扩展并点击安装。

    在 VS Code 中搜索并安装 ESP-IDF 扩展

  5. 当 ESP-IDF 扩展版本 ≥ 2.0 时,扩展会自动检测并识别上述步骤中安装的 ESP-IDF 环境,无需手动配置。

示例程序​

版本说明

V1 与 V2 的部分引脚定义不同，ESP-IDF 示例程序不能直接混用。请先确认开发板的实际硬件版本，再从相关资料下载对应版本的程序。

ESP-IDF 示例程序位置如下：

  • V1：ESP-IDF
  • V2：02_Example/ESP-IDF

以下示例说明以 V1 资料包为基础。V2 示例的目录名称和实现可能不同，请以 V2 仓库中的程序为准。

Demo 流程

示例程序基础例程说明依赖库
01_ADC_Test读取系统当前的电压值-
02_I2C_PCF85063打印 RTC 芯片的实时时间-
03_I2C_QMI8658打印 IMU 发出来的原始数据-
04_SD_Card加载显示 SD 卡的信息-
05_WIFI_STA设置为 STA 模式，可接入 Wi-Fi 获取 IP 地址-
06_WIFI_AP设置为 AP 模式，可获取接入设备的 IP 地址-
07_EX_GPIO使用扩展 IO 和内部 IO-
08_Li_ION_Test使能锂电池-
09_LVGL_TestLVGL 例程LVGL
10_FactoryProgram综合性工程LVGL

01_ADC_Test​

本示例通过 GPIO 连接的模拟量电压经过 ADC 转换成数字量，然后通过计算得到实际的系统电压，打印到终端。

ESP-IDF 示例1

ADC_CHANGPIO_PIN
ADC2_CHANNEL_6GPIO17

代码解释

  • adc_bsp_init(void)：初始化 ADC2，包括创建 ADC 单次触发单元并配置 ADC2 的通道 6。
  • adc_get_value(float *value, int *data)：读取 ADC2 通道 6 的值，并根据参考电压和分辨率计算出对应的电压值，如果读取失败则存储 0。
  • adc_example(void* parameter)：初始化 ADC2 后，创建一个 ADC 任务，每隔 1 秒读取一次 ADC 的值并计算出系统的电压。

运行效果：程序烧录完成后，打开串口监视器可以看到输出的 ADC 值和电压。ADC 采样值约为 1628，BAT 电压约为 4.2 V。

02_I2C_PCF85063​

本示例通过 I2C 协议，分别对 PCF85063 芯片进行初始化、设置时间、间隔读取时间，然后打印到终端。

RTCGPIO_PIN
RTC_SDAGPIO47
RTC_SCLGPIO48
RTC_INTEXIO4

代码解释

  • void PCF85063_example(void* parameter)：创建一个 RTC 任务来实现 RTC 功能，每隔 10 秒读取一次 RTC 芯片的时钟，然后输出到终端。

运行效果：烧录完成后打开监控设备，可以看到打印输出的 RTC 时间。数据每隔 10 秒输出一次。

03_I2C_QMI8658​

本示例通过 I2C 协议，对 QMI8658 芯片进行初始化设置，然后每隔 1 秒读取对应的姿态信息打印到终端。

IMUGPIO_PIN
IMU_SDAGPIO47
IMU_SCLGPIO48
IMU_INT1EXIO4
IMU_INT2EXIO3

代码解释

  • qmi8658c_example(void* parameter)：初始化 QMI8658 设备，在无限循环中读取并打印加速度计、陀螺仪数据和温度数据，每 1 秒执行一次。

运行效果：打开串口监控可以看到 IMU 发出来的原始数据（欧拉角需要自己转换），每隔 1 秒输出一次。

04_SD_Card​

本示例通过宏定义选择 SPI 或者 SDMMC 方向驱动 SD 卡，成功挂载 SD 卡之后把 SD 卡信息打印到终端。

ESP-IDF 示例4

SPI/MMCGPIO_PIN
CSGPIO2
MISO/D0GPIO6
MOSI/CMDGPIO5
SCLK/MCLKGPIO4

代码解释

  • 可以根据用户选择来实现 SD 卡的通信协议，在 sd_card_bsp.c 源文件下找到宏定义 SD_Read_Mode，宏定义默认使用 SDMMC 通信协议，可以修改为 SDSPI。
#define SD_Read_Mode USER_SPI

运行效果：点击串口监控设备，可以看到输出的 SD 卡的信息，practical_size 是 SD 卡的实际容量。

05_WIFI_STA​

本示例把开发板作为一个终端角色，可以连接环境可用的 AP，成功连接之后打印获取到的 IP 信息到终端。

ESP-IDF 示例5

代码修改：该工程将芯片配置为 STA 模式并连接 Wi-Fi。在编译和下载固件前，需要将代码中的 Wi-Fi 名称和密码修改为当前网络的参数。

代码解释

  • espwifi_Init(void)：在 ESP32 上进行 Wi-Fi 初始化。依次初始化非易失性存储、TCP/IP 栈、创建默认事件循环和默认 Wi-Fi 站点网络接口，注册事件处理函数，设置 Wi-Fi 连接参数并启动 Wi-Fi。

运行效果：芯片在 STA 模式下连接 Wi-Fi 并获取 IP 地址。

06_WIFI_AP​

本示例把开发板作为一个 AP 等待 STA 终端的连接，连接成功之后把分配的 IP 打印到终端。

代码解释

  • wifi_init_softap(void)：初始化 ESP32 的 Wi-Fi 软接入点，包括设置网络接口、注册事件处理函数、配置软 AP 参数并启动软 AP。

运行效果：芯片处于 AP 模式时，手机连接 Wi-Fi 后，串口会输出该设备的 MAC 地址和分配的 IP 地址。

07_EX_GPIO​

本示例测试扩展 IO 和内部 GPIO 的基本功能。

ESP-IDF 示例7

硬件连接：需要使用两根线，把 EXIO5 和 EXIO6 连接在一起、GPIO2 和 GPIO1 连接在一起。

GPIOxGPIOy
GPIO1GPIO2
EXIO5EXIO6

代码解释

  • I2C_master_Init()：初始化 I2C，I2C 是外部扩展 IO 的通信协议。
  • esp32_gpio_init()：初始化 GPIO，把 GPIO1、EXIO5 设置为输出，GPIO2、EXIO6 设置为输入。
  • example_GPIO_task()：创建一个独立任务测试 GPIO 功能，可根据需要修改。

运行效果：串口监视器输出 GPIO test passed. 表示测试成功，输出 GPIO test failed. 表示失败。

08_Li_ION_Test​

本示例通过对 GPIO 的控制，实现锂电池的供电。

代码解释

  • BAT_GPIO_Init()：使用 GPIO16 控制锂电池的供电，负责初始化 GPIO16。
  • BAT_ON()：使能锂电池对系统的供电。
  • BAT_OFF()：失能锂电池对系统的供电。

运行效果：在软件上使能锂电池供电之后，接入锂电池，然后可以通过 PWR 按键实现锂电池的供电。

09_LVGL_Test​

本示例通过移植 LVGL，在屏幕上实现一些多功能的 GUI 界面。

ESP-IDF 示例9 旋转90 Rotate_90

ESP-IDF 示例9 不旋转 Rotate_NONO

代码解释

  • lv_demo_widgets()：通过测试 LVGL 的 demo 来验证屏幕的性能。

代码修改：如果需要旋转 90 度显示，可以在 main() 所在的源文件找到 AMOLED_Rotate 宏定义，二者取其一：

#define AMOLED_Rotate  Rotate_90      // 横屏
#define AMOLED_Rotate  Rotate_NONO    // 竖屏

运行效果：LVGL 示例占用的 RAM 和 ROM 较多，需要按照环境配置要求设置工程。程序烧录完成后的运行效果如上图所示。

10_FactoryProgram​

本示例是综合性工程，测试板载功能。

版本说明

此项说明仅适用于 V1：使用 ESP-IDF V5.2.0 以上版本编译时，程序可能无法扫描到周围的 Wi-Fi 网络。如需测试，可使用较低版本编译，或直接烧录 V1 资料包提供的 BIN 固件。

运行效果：

  • 通过左右滑动进行切换页面，优先每隔 1.5 秒显示 RGB 颜色，观察屏幕有无问题
  • 显示完 RGB 之后，自动跳转到时钟界面
  • 左滑界面，可以看到板载硬件信息
  • 再次左滑，进入功能界面
    • 点击 Wi-Fi 标志进入 Wi-Fi 测试界面，点击 Scan 扫描周围的 Wi-Fi 网络
    • 点击 BLE 标志进入 BLE 测试界面，点击 Scan 扫描周围 BLE
  • 再次左滑，进入亮度调整界面

出厂程序 1 出厂程序 2 出厂程序 3 出厂程序 4 出厂程序 5 出厂程序 6 出厂程序 7 出厂程序 8 出厂程序 9 出厂程序 10