在VSCode中编译及调试ESP32程序

le062

在VSCode中编译及调试ESP32程序 [复制链接]

# 在VSCode中编译及调试ESP32程序

* 以Win10为例，Linux下类似。
* 调试器以CMSIS-DAP v2为例，如果使用官方FTDI或Jlink，配置会更简单。

## 所需硬件
1. Vllink Lite
2. esp-wroom-32

## 所需软件
1. VSCode
2. VSCode插件：Espressif IDF
3. Python3.x
4. git
5. OpenOCD-ESP32 (CMSIS-DAP v2兼容) [下载地址](https://github.com/vllogic/openocd_cmsis-dap_v2/releases)

## 注意事项
* 假定系统中已安装好最新版本VSCode、Python3.x及Git，并完成必要配置
* 假定系统对Github，Python库的网络链接速度良好，如果网络较差并且无提速手段，安装体验会非常糟糕

## 安装并配置
1. 下载OpenOCD-ESP32 (CMSIS-DAP v2兼容) ，并解压至`D:\OneDrive\OpenOCD-20200108`
2. 打开VSCode，安装`Espressif IDF`扩展
3. 打开左侧活动栏中的`ESP-IDF Explorer`

<ignore_js_op>

<div class="tip tip_4 aimg_tip" id="aimg_456804_menu" style="position: absolute; display: none" disautofocus="true">
<div class="xs0">
<p><strong>idf_start.png</strong> <em class="xg1">(19.01 KB, 下载次数: 0)</em></p>
<p>
<a href="javascript:;" class="loginf" >下载附件</a>

<a href="javascript:;" onclick="showWindow(this.id, this.getAttribute('url'), 'get', 0);" id="savephoto_456804" url="home.php?mod=spacecp&ac=album&op=saveforumphoto&aid=456804&handlekey=savephoto_456804">保存到相册</a>

</p>

</div>
<div class="tip_horn"></div>
</div>

</ignore_js_op>

4. 点击Start

<ignore_js_op>

<div class="tip tip_4 aimg_tip" id="aimg_456803_menu" style="position: absolute; display: none" disautofocus="true">
<div class="xs0">
<p><strong>idf_python.png</strong> <em class="xg1">(15.91 KB, 下载次数: 0)</em></p>
<p>
<a href="javascript:;" class="loginf" >下载附件</a>

<a href="javascript:;" onclick="showWindow(this.id, this.getAttribute('url'), 'get', 0);" id="savephoto_456803" url="home.php?mod=spacecp&ac=album&op=saveforumphoto&aid=456803&handlekey=savephoto_456803">保存到相册</a>

</p>

</div>
<div class="tip_horn"></div>
</div>

</ignore_js_op>

5. 自动检测到已安装的Git及Python，点击Configure ESP-IDF

<ignore_js_op>

<div class="tip tip_4 aimg_tip" id="aimg_456799_menu" style="position: absolute; display: none" disautofocus="true">
<div class="xs0">
<p><strong>idf_configure.png</strong> <em class="xg1">(19.26 KB, 下载次数: 0)</em></p>
<p>
<a href="javascript:;" class="loginf" >下载附件</a>

<a href="javascript:;" onclick="showWindow(this.id, this.getAttribute('url'), 'get', 0);" id="savephoto_456799" url="home.php?mod=spacecp&ac=album&op=saveforumphoto&aid=456799&handlekey=savephoto_456799">保存到相册</a>

</p>

</div>
<div class="tip_horn"></div>
</div>

</ignore_js_op>

6. 此处，选择v4.0版本，并指定目录`d:\esp`
7. 点击Click here to download，等待clone完成
8. 完成后，点击Go to ESP-IDF Tools setup
9.继续点击Download ESP-IDF Tools
10. 指定目录`C:\Software\esp_idf_tools`，点击Download，继续等待
11. 点击Go to next step

<ignore_js_op>

<div class="tip tip_4 aimg_tip" id="aimg_456805_menu" style="position: absolute; display: none" disautofocus="true">
<div class="xs0">
<p><strong>idf_verify.png</strong> <em class="xg1">(43.79 KB, 下载次数: 0)</em></p>
<p>
<a href="javascript:;" class="loginf" >下载附件</a>

<a href="javascript:;" onclick="showWindow(this.id, this.getAttribute('url'), 'get', 0);" id="savephoto_456805" url="home.php?mod=spacecp&ac=album&op=saveforumphoto&aid=456805&handlekey=savephoto_456805">保存到相册</a>

</p>

</div>
<div class="tip_horn"></div>
</div>

</ignore_js_op>

12. 先不修改，直接点击Click here to check tools exists
13. 再点Go to next step，提示完成配置，可关闭IDF Onboarding
14. 安装过程完成，相关路径可自行选择，并且后面需要指定这些路径，整个过程大约需要下载600MB数据

## 编译、下载及运行例程
1. 打开例程文件夹`D:\esp\esp-idf\examples\get-started\hello_world`
2. 按快捷键F1，执行`ESP-IDF:Build your project.` 稍等片刻，完成编译
3. 将Vllink Lite外部串口与esp-wroom-32连接（注意：目前[Vllink Lite v0.4](https://github.com/vllogic/vllink_lite/releases/tag/v0.4)的CDC串口不兼容此环境，可先用其他USB串口工具，或直接用JTAG下载）
4. 执行`ESP-IDF:Select port to use.`，选择Vllink Lite的USBCDC串口
5. 执行`ESP-IDF:Flash your project.`，并将ESP32目标板进入下载模式
6. 执行`ESP-IDF:Monitor your device.`，并将ESP32目标板进入运行模式

<ignore_js_op>

<div class="tip tip_4 aimg_tip" id="aimg_456801_menu" style="position: absolute; display: none" disautofocus="true">
<div class="xs0">
<p><strong>idf_monitor.png</strong> <em class="xg1">(46.53 KB, 下载次数: 0)</em></p>
<p>
<a href="javascript:;" class="loginf" >下载附件</a>

<a href="javascript:;" onclick="showWindow(this.id, this.getAttribute('url'), 'get', 0);" id="savephoto_456801" url="home.php?mod=spacecp&ac=album&op=saveforumphoto&aid=456801&handlekey=savephoto_456801">保存到相册</a>

</p>

</div>
<div class="tip_horn"></div>
</div>

</ignore_js_op>

## 命令行调试

由于SDK中的OpenOCD不支持CMSIS-DAP v2，需要先修改一些调试配置

1. 进入`文件 -> 首选项 -> 设置`，选择工作区，在右上角打开json文件，增加如下配置： 
 ```
  "idf.deviceInterface": "interface/cmsis-dap_4M.cfg",
  "idf.deviceInterfaceWin": "interface\\cmsis-dap_4M.cfg",
  "idf.board": "board/esp-wroom-32.cfg",
  "idf.boardWin": "board\\esp-wroom-32.cfg",
  "idf.projectName": "hello-world",
  "idf.showOnboardingOnInit": false,
  ```
2. 选择用户，在右上角打开json文件，将其中的
 ```
 "idf.customExtraPaths": "C:\\Software\\Python37;C:\\Software\\esp_idf_tools\\tools\\xtensa-esp32-elf\\esp-2019r2-8.2.0\\xtensa-esp32-elf\\bin;C:\\Software\\esp_idf_tools\\tools\\esp32ulp-elf\\2.28.51.20170517\\esp32ulp-elf-binutils\\bin;C:\\Software\\esp_idf_tools\\tools\\cmake\\3.13.4\\bin;C:\\Software\\esp_idf_tools\\tools\\openocd-esp32\\v0.10.0-esp32-20190313\\openocd-esp32\\bin;C:\\Software\\esp_idf_tools\\tools\\mconf\\v4.6.0.0-idf-20190628;C:\\Software\\esp_idf_tools\\tools\\ninja\\1.9.0;C:\\Software\\esp_idf_tools\\tools\\idf-exe\\1.0.1;C:\\Software\\esp_idf_tools\\tools\\ccache\\3.7",
 ```
 替换为：
 ```
 "idf.customExtraPaths": "C:\\Software\\Python37;C:\\Software\\esp_idf_tools\\tools\\xtensa-esp32-elf\\esp-2019r2-8.2.0\\xtensa-esp32-elf\\bin;C:\\Software\\esp_idf_tools\\tools\\esp32ulp-elf\\2.28.51.20170517\\esp32ulp-elf-binutils\\bin;C:\\Software\\esp_idf_tools\\tools\\cmake\\3.13.4\\bin;D:\\OneDrive\\OpenOCD-20200108\\bin;C:\\Software\\esp_idf_tools\\tools\\mconf\\v4.6.0.0-idf-20190628;C:\\Software\\esp_idf_tools\\tools\\ninja\\1.9.0;C:\\Software\\esp_idf_tools\\tools\\idf-exe\\1.0.1;C:\\Software\\esp_idf_tools\\tools\\ccache\\3.7",
 ```
3. 由于需要在终端中测试调试效果，可将gdb所在文件夹加入PATH `C:\Software\esp_idf_tools\tools\xtensa-esp32-elf\esp-2019r2-8.2.0\xtensa-esp32-elf\bin`
4. 重启VSCode
5. 执行`ESP-IDF:OpenOCD Manager.` 选择Start OpenOCD

<ignore_js_op>

<div class="tip tip_4 aimg_tip" id="aimg_456802_menu" style="position: absolute; display: none" disautofocus="true">
<div class="xs0">
<p><strong>idf_openocd.png</strong> <em class="xg1">(77.34 KB, 下载次数: 0)</em></p>
<p>
<a href="javascript:;" class="loginf" >下载附件</a>

<a href="javascript:;" onclick="showWindow(this.id, this.getAttribute('url'), 'get', 0);" id="savephoto_456802" url="home.php?mod=spacecp&ac=album&op=saveforumphoto&aid=456802&handlekey=savephoto_456802">保存到相册</a>

</p>

</div>
<div class="tip_horn"></div>
</div>

</ignore_js_op>

6. 建立GDB初始化脚本：gdbinit，内容：
 ```
 target remote :3333
 set remote hardware-watchpoint-limit 2
 mon reset halt
 flushregs
 thb app_main
 c
 ```
7. 在终端中运行：`xtensa-esp32-elf-gdb -x gdbinit build/hello-world.elf`

<ignore_js_op>

<a href="javascript:;" onclick="showWindow(this.id, this.getAttribute('url'), 'get', 0);" id="savephoto_456800" url="home.php?mod=spacecp&ac=album&op=saveforumphoto&aid=456800&handlekey=savephoto_456800">保存到相册</a>

</p>

</div>
<div class="tip_horn"></div>
</div>

</ignore_js_op>

## 图形化调试
1. 安装插件`Native Debug`
2. 增加环境变量`IDF_PATH` -> `D:\esp\esp-idf`
3. 在`.vscode`目录下增加`c_cpp_properties.json`文件
 ```
  {
  "configurations": [
    {
      "name": "Win32",
      "includePath": [
      "${workspaceFolder}/**",
      "${env:IDF_PATH}/components/**"
      ],
      "defines": [
      "_DEBUG",
      "UNICODE",
      "_UNICODE"
      ],
      "compilerPath": "C:/Software/esp_idf_tools/tools/xtensa-esp32-elf/esp-2019r2-8.2.0/xtensa-esp32-elf/bin/xtensa-esp32-elf-gcc.exe",
      "cStandard": "c11",
      "cppStandard": "c++17",
      "intelliSenseMode": "${default}"
    }
  ],
  "version": 4
  }
 ```
4. 在`.vscode`目录下增加`launch.json`文件
 ```
  {
  "version": "0.2.0",
  "configurations": [
    {
      "type": "gdb",
      "request": "launch",
      "name" : "Flash and Debug",
      "target": "./build/hello-world.elf",
      "cwd": "${workspaceFolder}",
      "gdbpath" : "xtensa-esp32-elf-gdb",
      "autorun": [
      "target remote :3333",
      "mon reset halt",
      "mon program_esp32 ./build/hello-world.bin 0x10000 verify",
      "mon reset halt",
      "flushregs",
      "thb app_main",
      "c"
      ],
      //"preLaunchTask": "openocd"
    }
  ]
  }
 ```
5. 重启VSCode
6. 执行`ESP-IDF:OpenOCD Manager.` 启动OpenOCD
7. 然后按F5，开始调试，如果出现未跳转到app_main的情况，点击调试框中的reset即可
 
 
<ignore_js_op>

<div class="tip tip_4 aimg_tip" id="aimg_456798_menu" style="position: absolute; display: none" disautofocus="true">
<div class="xs0">
<p><strong>debug.png</strong> <em class="xg1">(181.67 KB, 下载次数: 0)</em></p>
<p>
<a href="javascript:;" class="loginf" >下载附件</a>

<a href="javascript:;" onclick="showWindow(this.id, this.getAttribute('url'), 'get', 0);" id="savephoto_456798" url="home.php?mod=spacecp&ac=album&op=saveforumphoto&aid=456798&handlekey=savephoto_456798">保存到相册</a>

</p>

</div>
<div class="tip_horn"></div>
</div>

</ignore_js_op>

8. 完成

## 参考
1. [Get started with ESP32 on Visual Studio Code for Windows 10](https://www.youtube.com/watch?v=KRyvly_SYS8&list=PLvtTUqQ2PdLwBddDkwRJ0GECkJeTe_Yf6)
2. [JTAG 调试](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/api-guides/jtag-debugging/index.html)
3. [Espressif IDF for VSCode 爬坑之路一：ESP32 的 esp-idf 例子编译与烧录](https://blog.csdn.net/zztiger123/article/details/103811665)