【esp32开发】vscode+espidf开发环境搭建(实现单步调试)

概述

目前有多种支持esp32开发的ide：

• vscode
• visual studio+visual gdb
• esp ide(eclipse)
• clang
• …

上面的几种环境我都测试过，对比过后还是比较推荐vscode+espidf的方式，所以本文章主要介绍基于vscode和espidf搭建esp32的开发环境，并实现在线单步调试的功能。另外，esp32-s3系列可以直接通过芯片的usb接口直接进行调试，可以不需要外部的调试器，本文会分别介绍这两种调试方式。

视频版教程

【esp32开发】vscode+espidf开发环境搭建(实现单步调试)

硬件

esp32-s3开发板，购买的是muse lab的nanoESP32-S3开发板：

仿真器是乐鑫官方ESP-Prog，带串口和jtag接口：

硬件连线说明

硬件连接方式如下，注意ESP-Prog的串口TXD和RXD引脚分别对应开发板上面的TXD和RXD引脚，不需要交叉连接：

环境搭建

esp-idf下载和安装

请前往该链接：https://dl.espressif.com/dl/esp-idf/?idf=4.4，点击下图红框选项下载esp-idf框架离线安装包。

下载后进行安装。

python 3.9.2安装

请前往python官网，下载并安装python。

git安装

请前往git官网，下载并安装python。

vscode安装

请前往visual studio code官网，下载并安装visual studio code。

vscode的乐鑫esp插件安装

1. 打开vscode，打开扩展商店，搜索Espressif IDF并点击安装；
   

2. 安装完成后，点击键盘的F1，输入ESP-IDF: Configure ESP-IDF
   extension后回车，等待进行配置，选择第三个选项；
   
   

3. 等待自动配置完成，关闭窗口，如果中间提示pip有更新，则需要先更新pip。
   

ESP-Prog设置

1. 首先需要修改ESP-Prog的usb驱动，下载zadig；

2. ESP-Prog通过usb连接到电脑，打开zadig，点击Option下的List All Devices；
   

3. 注意要选择Dual RS232-HS (Interface 0)，不能选择Interface 1，因为Interface 1是串口驱动；
   

4. 点击Replace Driver；
   

5. 等待安装成功；
   

6. 检查一下，确认成功安装，注意如果更换了usb接口，需要重新安装驱动；
   

demo测试

创建示例工程

1. 新建一个blink的示例工程，点击键盘的F1，然后输入example；
   
2. 选择本地idf路径；
   
3. 选择要创建的示例工程，然后确定要保存的路径。
   
   esp-idf插件底栏按键介绍：
   
   ①选择串口端口号，如COM10；
   ②选择芯片型号；
   ③工程idf设置，相当于menuconfig；
   ④清理所有编译文件；
   ⑤编译；
   ⑥烧录方式，如uart、jtag和DFU；
   ⑦烧录；
   ⑧log监视窗口(monitor)；
   ⑨编译+烧录+自动打开log监视窗口；
   ⑩openocd配置，开启openocd或停止openocd。

编译和烧录

1. 先配置uart烧录端口，要根据自己实际端口号来选择，然后选择芯片型号，一定要选择目标芯片，不然编译会报错，我选的是ESP32-S3 (ESP-PROG JTAG)，即外部jtag；
   
   
2. 点击底栏的编译图标，等待编译完成；
   
   
3. 点击底栏的烧录图标，首次烧录还需要选择烧录方式，我选择uart，然后等待烧录完成。
   

log打印

点击底栏的log监视图标，查看log打印。

menuconfig设置

点击底栏的设置图标，该功能相当于idf.py menuconfig命令。

调试

esp32-s3在调试前，还需要额外配置调试接口的连接方式，因为esp32-s3默认的调试接口是内部usb-jtag接口，所以需要配置为使用外部jtag接口，执行下面操作：

1. 上电按住开发板的boot按键，执行espefuse.py -p COM10 burn_efuse STRAP_JTAG_SEL指令，设置一次即可，指令中的COM10是uart端口号；
2. 每次上电时将GPIO3浮空或拉低到地(上电时将GPIO3浮空或拉低到地，是选择使用外部jtag接口；上电时将GPIO3拉高到3.3v，则是选择使用内部usb-jtag接口)。

第一种方式：使用外部的ESP-Prog进行调试

1. 连线方式，ESP-Prog通过usb连接到电脑，开发板通过左边的ESPLink这个type-c接口连接到电脑：
   
2. 外部jtag调试器必须按照本文中ESP-Prog设置的说明来配置；
3. 把.vscode/launch.json文件修改为以下内容，
   本配置参考了其他教程，原文地址：https://blog.csdn.net/qq_24679791/article/details/121441755，
   但下面配置来源于乐鑫官方github的说明文档中，关于Use Microsoft C/C++ extension to debug的内容，地址：https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md，
   复制过来后，把"name": "GDB"修改为"name": "ESP32-S3 DEBUG"；

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "ESP32-S3 DEBUG",
      "type": "cppdbg",
      "request": "launch",
      "MIMode": "gdb",
      "miDebuggerPath": "${command:espIdf.getXtensaGdb}",
      "program": "${workspaceFolder}/build/${command:espIdf.getProjectName}.elf",
      "windows": {
        "program": "${workspaceFolder}\\build\\${command:espIdf.getProjectName}.elf"
      },
      "cwd": "${workspaceFolder}",
      "environment": [{ "name": "PATH", "value": "${config:idf.customExtraPaths}" }],
      "setupCommands": [
        { "text": "target remote :3333" },
        { "text": "set remote hardware-watchpoint-limit 2"},
        { "text": "mon reset halt" },
        { "text": "thb app_main" },
        { "text": "flushregs" }
      ],
      "externalConsole": false,
      "logging": {
        "engineLogging": true
      }
    }
  ]
}

4. 执行上文的编译和烧录后，点击底栏的openocd配置图标，并点击顶部Start Openocd，启动调试前必须执行这一步的操作；

5. 如果成功连接到芯片，会显示下图的信息，其中：
①为usb lib的错误信息，可以忽略；
②为成功连接到芯片的信息，如果连接不到芯片，会显示all zero或者all one的字眼；

6. 在主函数中任意地方打一个断点；

7. 点击键盘的F5，启动调试，根据我的经验，前两次启动都是启动失败的，第三次才启动成功，所以要多试几次；

8. 把变量添加到监视窗口、单步调试和停止调试；

9. 停止openocd，同样是点击底栏的openocd配置图标，然后点击Stop Openocd Running。

第二种方式：使用模块自带的usb-jtag接口进行调试

因为开发板自带串口转usb，而且板载两个type-c接口，所以开发板仅需通过两条type-c线连接电脑，即可实现烧录和仿真的全部操作，无需飞线到外部的ESP-Prog。

1. 连线方式，注意上电时，GPIO3必须要拉高到3.3v(我已修改过efuse的STRAP_JTAG_SEL标志位，没有修改efuse的话，默认就是使用内部usb-jtag功能)；
   
2. 查看usb是否正确显示USB JTAG/serial debug unit；
   
3. 点击底栏的选择芯片型号图标，选择ESP32-S3 (Build-in USB JTAG)；
   
4. 点击底栏的烧录方式图标，选择jtag烧录或uart烧录；
   
5. 编译和重新烧录；
6. 依次执行上文调试部分第一种方式的步骤3，4，5，6，7，8，9。

总结

通过上面的操作，已经成功搭建了esp32的vscode开发和调试环境，接下来就可以进行项目开发。在上文操作的过程中，如果遇到其他问题或者有更好的实现方法，欢迎在评论区留言，留下您宝贵的建议。