跳到主要内容

ESP-IDF

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

ESP-IDF 入门教程​

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

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

配置 ESP-IDF 开发环境​

信息

对于 ESP32-S3-ePaper-Driver-Board 开发板，需要使用 ESP-IDF V5.5.0 以上版本。

备注

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

安装 ESP-IDF 开发环境​

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

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

    下载 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 环境,无需手动配置。

示例程序​

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

示例程序基础例程说明
01_ADC_Test获取锂电池的电压值
02_Mic_test扬声器播放麦克风录音
03_Music挂载 SD 卡，读取播放 SD 卡中的音乐
04_E-Paper_Example墨水屏示例程序
05_SD_Test读取 SD 卡显示图片

01_ADC_Test​

【程序说明】

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

【硬件连接】

  • 使用 USB 线把板子接入电脑

【代码分析】

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

【运行效果】

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

02_Mic_test​

程序说明​

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

硬件连接​

  • 将开发板接入电脑

代码分析

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

运行效果​

  • 屏幕无显示效果

  • 长按 BOOT 按键即可进入录音模式，对着 MIC 说话，3 秒后自动结束

  • 单击 BOOT 按键，播放刚刚录的声音，（如果没有录音的情况下，播放的声音会很刺耳）

  • 串口打印：

03_Music​

程序说明​

  • 挂载 SD 卡，读取播放 SD 卡中的音频

硬件连接​

  • 将开发板接入电脑
  • 喇叭接入 SPK 接口

代码分析

  • _sdcard_init(); ：初始化 SD 卡并读取 SD 卡音频文件。
  • i2c_master_init();：初始化 I2C 总线，为 ES8311 音频编解码器的配置指令传输提供通信链路。
  • audio_player_play(audio_fp);：启动音频播放器，读取打开的 MP3 文件并通过 ES8311 驱动扬声器播放。

运行效果​

  • 屏幕无显示效果
  • 喇叭播放音频

04_E-Paper_Example​

程序说明​

  • 本示例为 13.3 寸 E6 墨水屏 ESP-IDF 本地例程，实现电子纸初始化清屏，显示图片，绘制基础图形、文字。

硬件连接​

  • 将开发板接入电脑

代码解释

  • 显示预设图片 ：

    #if 1
      EPD_Display(Image6color);
      vTaskDelay(pdMS_TO_TICKS(3000));
    #endif

  • 绘制基础图形、中英文文字、数字，并刷新显示 ：

    #if 1
      Paint_NewImage(Image_Mono, EPD_WIDTH, EPD_HEIGHT, 90, EPD_WHITE);
      Paint_SetScale(6);
      printf("SelectImage:Image\r\n");
      Paint_SelectImage(Image_Mono);
      Paint_Clear(EPD_WHITE);

      Paint_DrawPoint(10, 80, EPD_RED, DOT_PIXEL_1X1, DOT_STYLE_DFT);
      Paint_DrawPoint(10, 90, EPD_BLUE, DOT_PIXEL_2X2, DOT_STYLE_DFT);
      Paint_DrawPoint(10, 100, EPD_GREEN, DOT_PIXEL_3X3, DOT_STYLE_DFT);
      Paint_DrawLine(20, 70, 70, 120, EPD_YELLOW, DOT_PIXEL_1X1, LINE_STYLE_SOLID);
      Paint_DrawLine(70, 70, 20, 120, EPD_YELLOW, DOT_PIXEL_1X1, LINE_STYLE_SOLID);
      Paint_DrawRectangle(20, 70, 70, 120, EPD_BLACK, DOT_PIXEL_1X1, DRAW_FILL_EMPTY);
      Paint_DrawRectangle(80, 70, 130, 120, EPD_BLACK, DOT_PIXEL_1X1, DRAW_FILL_FULL);
      Paint_DrawCircle(45, 95, 20, EPD_BLACK, DOT_PIXEL_1X1, DRAW_FILL_EMPTY);
      Paint_DrawCircle(105, 95, 20, EPD_WHITE, DOT_PIXEL_1X1, DRAW_FILL_FULL);
      Paint_DrawLine(85, 95, 125, 95, EPD_YELLOW, DOT_PIXEL_1X1, LINE_STYLE_DOTTED);
      Paint_DrawLine(105, 75, 105, 115, EPD_YELLOW, DOT_PIXEL_1X1, LINE_STYLE_DOTTED);
      Paint_DrawString_CN(10, 130, "你好 abc", &Font16_UTF8, EPD_BLACK, EPD_WHITE);
      Paint_DrawString_CN(10, 170, "微雪电子", &Font16_UTF8, EPD_WHITE, EPD_BLACK);
      Paint_DrawNum(10, 10, 123456789, &Font12, EPD_BLACK, EPD_WHITE);
      Paint_DrawNum(10, 40, 987654321, &Font12, EPD_WHITE, EPD_BLACK);
      Paint_DrawString_EN(145, 0, "Waveshare", &Font16, EPD_BLACK, EPD_WHITE);
      Paint_DrawString_EN(145, 35, "Waveshare", &Font16, EPD_GREEN, EPD_WHITE);
      Paint_DrawString_EN(145, 70, "Waveshare", &Font16, EPD_BLUE, EPD_WHITE);
      Paint_DrawString_EN(145, 105, "Waveshare", &Font16, EPD_RED, EPD_WHITE);
      Paint_DrawString_EN(145, 140, "Waveshare", &Font16, EPD_YELLOW, EPD_WHITE);

      printf("EPD_Display\r\n");
      EPD_Display(Image_Mono);
      vTaskDelay(pdMS_TO_TICKS(3000));
    #endif

运行效果​

  • 屏幕刷新初始化清屏，显示图片，绘制基础图形、文字

05_SD_Test​

【程序说明】

  • 该示通过读取 SD 卡中的 BMP 图片并在墨水屏上刷新显示

【硬件连接】

  • 使用 USB 线把板子接入电脑
  • 将保存有图片的 bmp 文件夹放入 SD 卡根目录，插入 SD 卡模块

【代码分析】

  • _sdcard_init：sd 卡初始化
  • GUI_ReadBmp_RGB_6Color("/sdcard/bmp/13in3E.bmp", 0, 0);：图片解码

【运行效果】

  • 串口打印 SD 信息
  • 读取显示 sd 卡图片