跳到主要内容

ESP-IDF

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

ESP-IDF 入门教程​

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

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

配置 ESP-IDF 开发环境​

备注

以下内容以 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_WIFI_AP设置为 AP 模式，可获取接入设备的 IP 地址-
03_WIFI_STA设置为 STA 模式，可接入 WiFi 获取 IP 地址-
04_Audio_Test扬声器播放麦克风录到的声音LVGL V9.5.0
05_LVGL_V8_TestLVGLV8 例程LVGL V8.3.11
06_LVGL_V9_TestLVGLV9 例程LVGL V9.5.0
07_FactoryProgram综合示例LVGL V9.5.0

01_ADC_Test​

【程序说明】

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

【硬件连接】

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

【代码分析】

printf("adc-example run\n"); //终端输出信息
bsp_batt_init();             //初始化 adc 通道
xTaskCreate(Batt_LoopTask, "Batt_LoopTask", 4 * 1024, NULL, 3, NULL); //创建一个任务获取电压信息以及电池充电信息

【运行效果】

  • 程序编译下载完成，打开串口监控可以看到打印输出锂电池的电压以及充电信息，如下图所示：

02_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 地址，如图：

03_WIFI_STA​

【程序说明】

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

【硬件连接】

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

【代码分析】

  • 在 esp_wifi_bsp.c 文件找到 ssid 和 password，然后将其修改为当前环境中可用路由器的 SSID 和 Password。

    wifi_config_t wifi_config = {
      .sta = {
      	.ssid = "PDCN",
      	.password = "1234567890",
      },
    };

【运行效果】

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

04_Audio_Test​

【程序说明】

  • 演示如何获取麦克风数据，播放音乐等功能。

【硬件连接】

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

【代码分析】

bsp_broolesia_display_init(); //屏幕初始化
speaker = bsp_audio_codec_speaker_init(); //获取播放句柄
microphone = bsp_audio_codec_microphone_init();//获取录音句柄
boot_button_ = new Button(BUTTON_0_GPIO_PIN);//实例化按键
InitializeButtons();//按键回调初始化
ESP_ERROR_CHECK(esp_codec_dev_open(speaker, &fs));//打开播放
ESP_ERROR_CHECK(esp_codec_dev_open(microphone, &fs));  //打开录音
ESP_ERROR_CHECK(esp_codec_dev_set_out_vol(speaker, 100));//设置播放声音大小
ESP_ERROR_CHECK(esp_codec_dev_set_in_gain(microphone,35));//设置录音增益大小

【运行效果】

  • 程序烧录完成后，屏幕显示如图：

    提示
    1. 单击 BOOT 按键，可以录音 3 秒，录音结束之后自动播放录音
    2. 双击 BOOT 按键，可以播放一段音乐，长按 BOOT 按键可打断播放

05_LVGL_V8_Test​

【程序说明】

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

【硬件连接】

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

【代码分析】

#define BACKLIGHT_EN 1       //宏定义,使能开启背光测试,默认打开
bsp_broolesia_display_init();//初始化屏幕以及LVGL
if(bsp_display_lock(-1) == ESP_OK) { //等待锁
  lv_demo_widgets();  //LVGL 默认 UI
  bsp_display_unlock(); //释放锁
}

【运行效果】

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

06_LVGL_V9_Test​

【程序说明】

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

【硬件连接】

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

【代码分析】

#define BACKLIGHT_EN 1       //宏定义,使能开启背光测试,默认打开
bsp_broolesia_display_init();//初始化屏幕以及LVGL
if(bsp_display_lock(-1) == ESP_OK) { //等待锁
  lv_demo_widgets();  //LVGL 默认 UI
  bsp_display_unlock(); //释放锁
}

【运行效果】

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

07_FactoryProgram​

【程序说明】

  • 出厂固件，用户可烧录我们提供的出厂固件，帮助用户快速了解开发板。

【硬件连接】

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

【运行效果】

  • 烧录出厂固件重启之后，可看到开发板显示内容，如下图所示：

    提示
    1. FacTest app ：测试板载硬件，可助力用户快速查找问题
    2. 更多 app 开发，可通过关注 Gitee、Github 仓库连接，后续会持续更新