跳到主要内容

ESP-IDF

ESP-IDF 入门教程​

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

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

配置开发环境​

备注

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

烧录程序​

  1. 在安装完 ESP-IDF 的开发环境之后，选择文件夹打开示例

    在 VS Code 中打开文件夹

  2. 在弹出的窗口当中选择、ESP32-S3-Touch-LCD-7-Demo\ESP-IDF 目录下的示例，点击选择文件 （这里用 01_I2C_Test 文件夹作为示例）。

    在 VS Code 中打开文件

  3. 为了将对应的代码上传到 ESP32-S3，需要用 Type-C 转 Type-A 的线将 ESP32-S3-Touch-LCD-7 的 USB 口接到电脑的 USB 口。

    将 ESP32-S3 板子上传电脑

  4. 若是新工程首次烧录程序，需要先选择识别出来的 COM 口，例如我这边识别到的是 COM36。

    选择 COM 口

  5. 选择下载方式为：UART。

    选择下载方式

  6. 接着选择主芯片为 ESP32S3。

    选择主芯片

    选择 openocd 的路径，这里对我们没有影响，所以我们随便选择一个即可，此处可选择第一个。

    选择 openocd 的路径

  7. 点击下列的小火苗 Build Flash Monitor 一键按钮，用于连续执行 Build-->Flash-->Monitor。

    选择小火苗

  8. 板子上板载自动下载电路，无需手动操作即可自动下载。接着等待编译烧录完成就好，首次编译可能需要较长时间才能完成。

    编译下载完成

示例程序​

  • ESP32-S3-Touch-LCD-7 示例程序
示例程序基础例程说明
01_I2C_Test测试 I2C 座子
02_RS485_Test测试 RS485 座子
03_SD_Test测试 SD 卡座
04_Sensor_AD测试 ADC 座子
05_UART_Test测试 UART
06_TWAItransmit测试 CAN 卡座
07_TWAIreceive测试 CAN 卡座
08_lvgl_Porting测试 LVGL 移植

  • 依赖库通过 idf component.yml 在编译时自动下载。

    信息

    更多学习链接：IDF 组件管理器

01_I2C_Test​

【硬件连接】

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

将 ESP32-S3 板子上传电脑

【代码分析】

app_main() ：

  • 首先定义了与 I2C 相关的常量和变量，如日志标签、I2C 的 SDA 和 SCL 引脚以及端口号。
  • 接着，根据不同配置选项安装控制台 REPL 环境，用于用户交互。随后配置 I2C 总线，包括时钟源、端口、引脚和启用内部上拉电阻等，并初始化 I2C 主总线。
  • 之后注册一系列 I2C 工具命令，如设备检测、寄存器读写等操作的命令。还打印了使用说明，指导用户如何使用这些命令。
  • 最后启动控制台 REPL，允许用户通过命令行与应用程序交互，执行各种 I2C 操作，为用户提供了一种方便的方式通过命令行操作 I2C 总线。

【运行效果】

  • 烧录成功后，打开串口终端，输入命令后，摁回车即可运行： I2C 例程运行结果

  • 使用步骤如下：

    • 使用help，检查所有支持的命令
    • 使用i2cconfig配置你的 I2C 总线
    • 使用i2cdetect来扫描总线上的设备
    • 使用i2cget获取特定寄存器的内容
    • 使用i2cset设置特定寄存器的值
    • 使用i2cdump转储所有寄存器（实验）

02_RS485_Test​

【硬件连接】

使用 USB 线把板子接入电脑，开发板连接 USB 转 RS485 转换器，如： RS485 硬件连接

【代码分析】

echo_task() ：

  • 首先配置了 UART 参数，包括波特率、数据位、奇偶校验位、停止位和硬件流控制等。
  • 然后安装 UART 驱动，设置 UART 引脚，并分配一个临时缓冲区用于接收数据。
  • 在一个无限循环中，从 UART 读取数据，将读取到的数据回写到 UART，并在有数据接收时记录日志信息。

【运行效果】

打开串口调试助手向 ESP32-S3-Touch-LCD-7 发送消息，该设备会将收到的消息返回给串口调试助手： RS485 运行结果

03_SD_Test​

【硬件连接】

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

【代码分析】

waveshare_sd_card_init() ：

这个函数主要用于初始化 SD 卡。首先初始化 I2C，然后通过 I2C 控制芯片拉低 SD 卡的 CS 引脚。接着配置 SD 卡的挂载选项，包括是否在挂载失败时格式化、最大文件数和分配单元大小等。之后初始化 SPI 总线，并使用配置好的 SPI 总线和挂载选项来挂载 SD 卡文件系统。如果挂载成功则返回 ESP_OK，表示 SD 卡初始化完成。

waveshare_sd_card_test() ：

这个函数用于测试 SD 卡的功能。首先打印已初始化的 SD 卡的信息。然后创建一个文件并写入数据，重命名该文件并读取重命名后的文件内容。接着格式化文件系统，检查文件在格式化后是否被删除。最后创建一个新文件并读取其内容，完成测试后卸载 SD 卡并释放 SPI 总线资源。

【运行效果】

烧录成功后，串口会打印有关存储卡的信息，例如名称、类型、容量和支持的最大频率，再创建文件，写入文件，重命名文件，读取重命名文件： SD 卡例程运行结果

04_Sensor_AD_Test​

【硬件连接】

  • 使用 USB 线把板子接入电脑
  • 将 PH2.0 转 2.54mm 杜邦公头配件接入开发板的 Sensor AD 接口

【代码分析】

app_main() ：

  • 首先定义了用于存储当前 ADC 的一些变量，声明校准函数。
  • 接着初始化 ADC，设置 ADC 的分辨率跟衰减，然后创建 ADC。在无限循环中，读取当前 ADC 值后打印循环中还进行了 1 秒钟的延迟。

【运行效果】

ESP32-S3-Touch-LCD-7 会设置 ADC 分辨率，读取当前 AD 值，打印到串口终端： AD 例程运行结果

05_UART_Test​

【硬件连接】

使用 USB 线连接板子的 UART 口，接入电脑

【代码分析】

echo_task() ：

  • 首先配置了 UART 参数，包括波特率、数据位、奇偶校验位、停止位和硬件流控制等。
  • 然后安装 UART 驱动，设置 UART 引脚，并分配一个临时缓冲区用于接收数据。
  • 在一个无限循环中，从 UART 读取数据，将读取到的数据回写到 UART，并在有数据接收时记录日志信息

【运行效果】

打开串口调试助手向 ESP32-S3-Touch-LCD-7 发送消息，该设备会将收到的消息返回给串口调试助手： SD 例程运行结果

06_TWAItransmit​

【硬件连接】

使用 USB 线把板子接入电脑，开发板连接 USB-CAN-A，如图：

CAN 硬件连接

【代码分析】

waveshare_twai_transmit() ：

  • 若驱动未安装，等待一段时间后返回失败状态
  • 读取触发的警报并获取 TWAI 状态信息
  • 根据不同警报类型打印相应日志信息，包括错误被动警报、总线错误警报、传输失败警报和传输成功警报，并打印相关状态信息
  • 判断是否到了发送消息的时间，如果是则发送消息并更新上一次发送时间。

【运行效果】

  • 串口打印 CAN 消息发送成功，配置 USB-CAN-A_TOOL 后启动可看到 ESP32-S3-Touch-LCD-7 发送的 CAN 消息。 CAN 发送例程运行结果

  • 再观察 USB-CAN-A_TOOL，即可看到 ESP32-S3-Touch-LCD-7 发送的 CAN 消息 CAN 发送例程运行结果

07_TWAIreceive​

【硬件连接】

使用 USB 线把板子接入电脑，开发板连接 USB-CAN-A，如图： CAN 硬件连接

【代码分析】

waveshare_twai_receive() ：

  • 如果驱动未安装，则等待一段时间后返回失败状态。
  • 读取触发的警报并获取 TWAI 的状态信息。
  • 根据触发的不同警报类型打印相应的日志信息，包括错误被动警报、总线错误警报和接收队列满警报，并打印相关的状态信息。
  • 如果接收数据警报被触发，则循环接收消息并调用 handle_rx_message 函数处理每个接收到的消息。最后返回成功状态。

【运行效果】

  • ESP32-S3-Touch-LCD-7 等待 USB-CAN-A_TOOL 发送消息，如果接收成功，会将其打印到串口上。 CAN 发送例程运行结果 CAN 发送例程运行结果 CAN 发送例程运行结果

  • 如果出现以下错误，单击串口监视器并使用调试工具重新发送数据。（若按下复位， 有时也需要再单击串口监视器）： CAN 发送例程运行结果

08_lvgl_Porting​

【硬件连接】

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

【代码分析】

app_main() ：

  • 初始化 Waveshare ESP32-S3 RGB LCD，然后可以选择开启或关闭屏幕背光。
  • 接着打印一条信息表示要显示 LVGL 的演示内容，由于 LVGL 的 API 不是线程安全的，所以先锁定互斥锁。
  • 然后可以选择运行不同的 LVGL 演示程序，如 lv_demo_stress 、 lv_demo_benchmark 、 lv_demo_music 、 lv_demo_widgets 或 example_lvgl_demo_ui 等。
  • 最后释放互斥锁。

【代码修改】

在 waveshare_rgb_lcd_port.h 中有一宏定义用于选择是否打开触摸功能，值为 0 对应 关闭触摸，值为 1 对应 打开触摸，可依购买型号选择。

 #define CONFIG_EXAMPLE_LCD_TOUCH_CONTROLLER_GT911 0 // 1 initiates the touch, 0 closes the touch.

【运行效果】

烧录成功后，摁下复位按键，即可运行示例

LVGL 运行结果

信息
  • 如果还是进一步提升帧率，可以参考 此链接 进行配置
  • RGB LCD 驱动可以参考 此链接
  • GT911 驱动可以参考 此链接
  • lvgl 使用的版本是 8.3，可以通过以下文档进行对 LVGL 的 API 查询跟使用
最后由 Chongting 于 更新