ESP-IDF

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

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

ESP-IDF 入门教程

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

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

配置 ESP-IDF 开发环境

信息

对于 ESP32-S3-ePaper-1.54 开发板，需要使用 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 环境,无需手动配置。

示例程序

ESP-IDF 示例程序位于示例程序包的 ESP-IDF 目录中。

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

01_ADC_Test

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

Adc_PortInit(void)：初始化 ADC1，包括创建 ADC 单次触发单元并配置 ADC1 的通道 3。
float Adc_GetBatteryVoltage(int *data)：读取 ADC1 通道 3 的值，返回实际的电压值。
uint8_t Adc_GetBatteryLevel(void)：返回电池的百分比。
void Adc_LoopTask(void *arg)：创建一个 ADC 任务，该任务每隔 1 秒读取一次 ADC 的值并打印到串口。

【运行效果】

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

02_I2C_PCF85063

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

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

【运行效果】

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

03_I2C_STHC3

【程序说明】

通过 I2C 协议，分别对 STHC3 芯片进行初始化、读取温湿度数据，然后打印到终端。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

void i2c_SHTC3_loop_task(void *arg)：创建一个 SHTC3 传感器任务，定时获取温湿度。

【运行效果】

打开串口监控，可以看到打印输出的温湿度数据，如下图所示：

04_SD_Card

【程序说明】

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

【硬件连接】

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

【代码分析】

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

【运行效果】

点击串口监控设备，可以看到输出的SD卡的信息，practical_size是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界面，使得控制可视化。
user_button_init()：初始化按键以及各类触发事件。
example_button_pwr_task(void* parmeter)：等待按键事件触发的任务。

【运行效果】

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

08_Audio_Test

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

i2c_master_Init()：初始化 I2C 总线。
user_ui_init()：初始化全局 ui 。
user_button_init()：初始化 audio 接口。

【运行效果】

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

09_LVGL_V8_Test

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

void loop_lvgl_img(void *arg)：创建 img 组件任务，间隔 5s 切换一次图片。
void led_test_task(void *arg)：led 闪烁任务。

【运行效果】

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

10_LVGL_V9_Test

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

void loop_lvgl_img(void *arg)：创建 img 组件任务，间隔 5s 切换一次图片。
void led_test_task(void *arg)：led 闪烁任务。

【运行效果】

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

11_FactoryProgram

【程序说明】

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

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

board_div.VBAT_POWER_ON();     //打开VBAT 供电使能
board_div.POWEER_EPD_ON();     //打开EPD 供电使能
board_div.POWEER_Audio_ON();   //打开Audio 供电使能
i2c_master_Init();			 //初始化I2C 总线
/*epaper init*/
custom_lcd_spi_t driver_config = {};
driver_config.cs = EPD_CS_PIN;
driver_config.dc = EPD_DC_PIN;
driver_config.rst = EPD_RST_PIN;
driver_config.busy = EPD_BUSY_PIN;
driver_config.mosi = EPD_MOSI_PIN;
driver_config.scl = EPD_SCK_PIN;
driver_config.spi_host = EPD_SPI_NUM;
driver_config.buffer_len  = 5000;
driver = new epaper_driver_display(EPD_WIDTH,EPD_HEIGHT,driver_config); //创建ePaper 驱动对象
driver->EPD_Init(); //初始化ePaper 驱动
driver->EPD_Clear();//清除显示内容
driver->EPD_DisplayPartBaseImage();//显示基础图像
driver->EPD_Init_Partial();        //初始化ePaper 驱动（局部刷新模式）
rtc_dev = new i2c_equipment();     //创建I2C 设备对象（RTC）
rtc_dev->set_rtcTime(2025,8,27,8,0,0); //设置RTC 时间为：2025/08/27 08:00:00
shtc3_dev = new i2c_equipment_shtc3(); //创建I2C 设备对象（SHTC3）

【运行效果】

程序烧录完成后，设备的运行效果如下：
提示
1. 可以通过主界面，判断板载的硬件是否正常工作
2. 单击 PWR 可跳转至音乐界面，想查看相关设置，可以查看源码

12_RTC_Sleep_Test

【程序说明】

低功耗模式下，实现 RTC 唤醒。

【硬件连接】

使用 USB 线把板子接入电脑

【代码分析】

void set_rtcAlarmSec(int sec)：设置 RTC 秒定时（绝对时间）。
void set_rtcAlarmMinute(int min)：设置 RTC 分定时（绝对时间）。
void set_rtcAlarmHour(int hour)：设置 RTC 小时定时（绝对时间）。
void set_rtcAlarmDay(int day)：设置 RTC 天定时（绝对时间）。

【运行效果】

程序烧录完成后，设备的运行效果如下：
提示
1. 初始设定RTC的时间是：2025/08/08 08:00:00，秒定时时间是30秒（这个是绝对时间，比如：08:00:30、08:01:30、08:02:30）
2. 唤醒之后，读取RTC的值，进入低功耗，等待RTC唤醒
3. 低功耗模式下，单击PWR可关机，长按BOOT按键可重新设置RTC时间：2025/08/08 08:00:00

ESP-IDF 入门教程​

配置 ESP-IDF 开发环境​

安装 ESP-IDF 开发环境​

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

示例程序​

01_ADC_Test​

02_I2C_PCF85063​

03_I2C_STHC3​

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​

12_RTC_Sleep_Test​

ESP-IDF 入门教程

配置 ESP-IDF 开发环境

安装 ESP-IDF 开发环境

安装 Visual Studio Code 与 ESP-IDF 扩展

示例程序

01_ADC_Test

02_I2C_PCF85063

03_I2C_STHC3

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

12_RTC_Sleep_Test