ESP-IDF

本章节包含以下部分，请按需阅读：

ESP-IDF 入门教程
配置 ESP-IDF 开发环境
示例程序

ESP-IDF 入门教程

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

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

配置 ESP-IDF 开发环境

信息

对于 ESP32-S3-Touch-LCD-3.49 开发板，需要使用 ESP-IDF V5.5.0 以上版本。

备注

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

安装 ESP-IDF 开发环境

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

在页面中点击 Offline Installer 标签，然后在筛选栏中选择 Windows 操作系统和你要安装的版本。

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

请耐心等待两个文件下载完成。
下载完成后，双击运行 ESP-IDF 安装器(eim-gui-windows-x64.exe)。

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

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

接下来，选择安装路径。建议使用默认路径；若需自定义，请确保路径中不包含中文或空格。确认无误后，点击 开始安装。
当看到如下界面时，表示 ESP-IDF 已安装成功。
建议同时安装驱动程序。点击 完成安装，然后点击 安装驱动程序。

安装 Visual Studio Code 与 ESP-IDF 扩展

下载并安装 Visual Studio Code。
安装时建议勾选 通过 Code 打开操作添加到 Windows 资源管理器文件上下文菜单,以便快速打开项目文件夹。
在 VS Code 中,点击侧边活动栏中的扩展图标(或使用快捷键 Ctrl + Shift + X)打开扩展视图。
在搜索框中输入 ESP-IDF,找到 ESP-IDF 扩展并点击安装。
当 ESP-IDF 扩展版本 ≥ 2.0 时,扩展会自动检测并识别上述步骤中安装的 ESP-IDF 环境,无需手动配置。

示例程序

示例程序	基础例程说明	依赖库
01_ADC_Test	获取锂电池的电压值	-
02_I2C_PCF85063	打印RTC芯片的实时时间	SensorLib
03_I2C_QMI8658	打印IMU发出来的原始数据	SensorLib
04_SD_Card	加载显示SD卡的信息	-
05_WIFI_AP	设置为AP模式，可获取接入设备的IP地址	-
06_WIFI_STA	设置为STA模式，可接入WiFi获取IP地址	-
07_BATT_PWR_Test	单独使用锂电池供电时，通过PWR按键控制电源	-
08_Audio_Test	扬声器播放麦克风录到的声音	-
09_LVGL_V8_Test	LVGLV8例程	LVGL V8.4.0
10_LVGL_V9_Test	LVGLV9例程	LVGL V9.3.0
11_FactoryProgram	综合示例	LVGL V8.3.11

01_ADC_Test

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

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

【运行效果】

程序编译下载完成，打开串口监控可以看到打印输出的 ADC 的值和电压，如下图所示：

02_I2C_PCF85063

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

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

【运行效果】

程序编译下载完成，打开串口监控可以看到打印输出的 RTC 时间，如下图所示：

03_I2C_QMI8658

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

void i2c_qmi_loop_task(void *arg)：创建一个 QMI 任务来实现获取姿态信息，在任务中读取并打印加速度计、陀螺仪数据，并将获取的结果输出到串口控制台，间隔 200ms 。

【运行效果】

打开串口监控，可以看到打印输出的 IMU 发出来的原始数据(欧拉角需要自己转换)，如下图所示：

04_SD_Card

【程序说明】

通过 SDMMC 方式驱动 SD 卡，成功挂载之后把 SD 卡信息打印到终端。

【硬件连接】

上电之前先给板子装上 FatFs 格式的 SD 卡

【代码分析】

sdcard_init(void)：使用 1 线 SDMMC 方式初始化 SD 卡。
sdcard_loop_task(void *arg)：测试 SD 卡读写功能的任务，需要取消#define sdcard_write_Test宏定义的注释。
```
//#define sdcard_write_Test
```

【运行效果】

点击串口监控设备，可以看到输出的 SD 卡的信息，如下图所示：

05_WIFI_AP

【程序说明】

该示例可将开发板设置为热点，允许手机或其他处于 STA 模式的设备连接到开发板。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

在 softap_example_main.c 文件找到 SSID 和 PASSWORD，然后手机或其他处于 STA 模式的设备即可使用该 SSID 和 PASSWORD 连接到开发板。
```
#define EXAMPLE_ESP_WIFI_SSID      "waveshare_esp32"
#define EXAMPLE_ESP_WIFI_PASSWORD      "wav123456"
```

【运行效果】

烧录完程序，打开串口终端，如果设备连接热点成功之后，会输出该设备的 MAC 和 IP 地址，如图：

06_WIFI_STA

【程序说明】

该示例可将开发板配置为 STA 设备，以连接路由器，从而接入系统网络。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

在 esp_wifi_bsp.c 文件找到 ssid 和 password，然后将其修改为当前环境中可用路由器的 SSID 和 Password。
```
wifi_config_t wifi_config = {
  .sta = {
    .ssid = "PDCN",
    .password = "1234567890",
  },
};
```

【运行效果】

烧录完程序，打开串口终端，如果设备连接成功热点之后，会输出所获取的 IP 地址，如图：

07_BATT_PWR_Test

【程序说明】

使用锂电池供电的情况下，演示如何通过 PWR 按键控制系统的电源。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

setup_ui(lv_ui *ui)：初始化 UI 界面，使得控制可视化。
tca9554_init()：初始化锂电池控制 IO 端口。
button_Init()：初始化按键以及各类触发事件。
example_button_pwr_task(void* parmeter)：等待按键事件触发的任务。

【运行效果】

程序烧录完成后，断开 USB 供电，接入锂电池，通过长按 PWR 按键进行开机，如图：
提示
1. 长按PWR按键，等待屏幕显示"ON"，表示启动成功，松开按键即可
2. 再次长按PWR按键，等待屏幕显示"OFF"，表示电源关闭成功，松开按键即可

08_Audio_Test

【程序说明】

演示如何获取麦克风的数据，然后再通过扬声器播放。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

i2c_master_Init()：初始化 I2C 总线。
tca9554_init()：初始化功放 CTRL 控制 IO 端口。
lvgl_port_init()：初始化 lvgl 接口。
user_audio_bsp_init()：初始化 audio 接口。

【运行效果】

程序烧录完成后，如图：
提示
1. 单击 Recording 即可进入录音模式，对着 MIC 说话，3 秒后自动结束
2. 单击 Play，播放刚刚录的声音
3. 单击 Play Music，可以播放一段音乐
4. 单击 Music Exit，可以打断音乐播放

09_LVGL_V8_Test

【程序说明】

通过移植LVGL V8，帮助用户快速实现 UI 界面设计。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

如果需要旋转 90 度显示，可以在 user_config.h 文件找到 #define Rotated 宏定义，给值"USER_DISP_ROT_90"即可。

如果需要进行背光测试，可以在 user_config.h 文件找到 #define Backlight_Testing 宏定义，给值 "true" 即可。

#define Backlight_Testing 0
#define USER_DISP_ROT_90    1
#define USER_DISP_ROT_NONO  0
#define Rotated USER_DISP_ROT_NONO   //软件实现旋转

【运行效果】

程序烧录完成后，设备的运行效果如下：

10_LVGL_V9_Test

【程序说明】

通过移植LVGL V9，帮助用户快速实现 UI 界面设计。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

如果需要旋转 90 度显示，可以在 user_config.h 文件找到 #define Rotated 宏定义，给值"USER_DISP_ROT_90"即可。

如果需要进行背光测试，可以在 user_config.h 文件找到 #define Backlight_Testing 宏定义，给值 "true" 即可。

#define Backlight_Testing 0
#define USER_DISP_ROT_90    1
#define USER_DISP_ROT_NONO  0
#define Rotated USER_DISP_ROT_NONO   //软件实现旋转

【运行效果】

程序烧录完成后，设备的运行效果如下：

11_FactoryProgram

【程序说明】

综合性工程，简单测试板载硬件功能，也可以直接使用我们提供的 BIN 固件烧录。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

setup_ui(&src_ui);            // 设置 UI 界面
lcd_bl_pwm_bsp_init(LCD_PWM_MODE_255);  // 初始化 LCD 背光 PWM，使用 255 级亮度调节模式
tca9554_init();               // 初始化 TCA9554 GPIO 扩展芯片
button_Init();                // 初始化按键
adc_bsp_init();               // 初始化 ADC 用于电压检测
i2c_rtc_setup();              // 设置 RTC 实时时钟
i2c_rtc_setTime(2025,7,7,18,43,30);  // 设置 RTC 时间为 2025 年 7 月 7 日 18:43:30
i2c_imu_setup();              // 设置 IMU 惯性测量单元
_sdcard_init();               // 初始化 SD 卡
espwifi_init();               // 初始化 WiFi 功能
user_audio_bsp_init();        // 初始化用户音频板载支持
audio_play_init();            // 初始化音频播放功能

【运行效果】

程序烧录完成后，设备的运行效果如下：
提示
1. 可以通过主界面，判断板载的硬件是否正常工作
2. 左滑动，可进行背光控制
Touch和Audio控制界面，如图：
提示
1. 长按 BOOT 按键，可以进入 audio 界面，该界面可测试录音和播放功能，再次长按 BOOT 按键，退回主界面
2. 单击 BOOT 按键，可以进入 Touch 界面，该界面可以绘画 Touch 轨迹

ESP-IDF 入门教程​

配置 ESP-IDF 开发环境​

安装 ESP-IDF 开发环境​

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

示例程序​

01_ADC_Test​

02_I2C_PCF85063​

03_I2C_QMI8658​

04_SD_Card​

05_WIFI_AP​

06_WIFI_STA​

07_BATT_PWR_Test​

08_Audio_Test​

09_LVGL_V8_Test​

10_LVGL_V9_Test​

11_FactoryProgram​

ESP-IDF 入门教程

配置 ESP-IDF 开发环境

安装 ESP-IDF 开发环境

安装 Visual Studio Code 与 ESP-IDF 扩展

示例程序

01_ADC_Test

02_I2C_PCF85063

03_I2C_QMI8658

04_SD_Card

05_WIFI_AP

06_WIFI_STA

07_BATT_PWR_Test

08_Audio_Test

09_LVGL_V8_Test

10_LVGL_V9_Test

11_FactoryProgram