引言

文章的起点源于一个小伙伴私信我,想了解如何在vscode中直接开发esp8266。vscode其轻便,小巧等优点越来越受各类程序员的喜爱。 前面我分别介绍了如何在Windows中使用msys32,以及在Ubuntu(linux的一种发行版)搭建esp8266的开发环境,直接基于命令行编译,配置,下载等操作,这样做的好处是避免直接基于IDE(集成开发环境)开发,IDE背后帮我们封装了很多操作,让我们无法了解其背后实现的原理和机制,比如配置文件是如何生成的,多文件是如何编译的,头文件是如何关联起来的等等问题,这就需要我们去了解工程Makefile,一步步探索其中的原理。




esp32视频传输 vscode vs code esp32_esp32视频传输 vscode


回到正题,接下来主要介绍如何配置使得能够在vscode中直接开发esp8266,实现代码编辑和编译下载等操作全部在vscode中完成。OK, 开始行动~


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_02


开始前工作准备

开始前需要小伙伴先搭建好esp8266/32(之后以esp8266为例子)开发环境,包括下载ESP8266_RTOS_SDK, 交叉工具链,msys32等,并设置IDF_PATH,PATH 环境变量,这里不再赘述,不熟悉的小伙伴请参考我之前的视频Windows中搭建esp8266开发环境。 当然还要下载vscode编辑器啦~,其下载安装很简单,只需要到官网下载傻瓜式安装即可。 下载后需要安装一个"C/C++"插件


esp32视频传输 vscode vs code esp32_esp32视频传输 vscode_03


配置settings.json文件

点击“文件”->"打开文件夹",打开自己的工程目录,比如我的“Humiture”


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_04


点击vscode左下方“齿轮”图标, 选择“设置”:


esp32视频传输 vscode vs code esp32_esp32视频传输 vscode_05


接着会出现“用户”, “工作区” 2种类型的设置, 其中“用户”设置相当于全局设置,如果工作区中未进行相关配置,会默认使用“用户”下的设置, 而“工作区”相当于局部设置,只作用于当前打开的工作区,这里我们选择“工作区”来介绍,无论哪种模式设置操作都是一样的,只是作用域不同而已。

点击“工作区”->"终端",点击“settings.json”:


esp32视频传输 vscode vs code esp32_esp32视频传输 vscode_06


打开“settings.json”后,将其修改成以下内容,并保存:

{    "terminal.integrated.shell.windows": "D:msys32msys2_shell.cmd",//这里根据自己的实际路径    "terminal.integrated.shellArgs.windows": [        "-defterm",        "-no-start",        "-mingw32",        "-here"    ],    "terminal.integrated.automationShell.linux": "",    "terminal.integrated.automationShell.windows": "",    "extensions.confirmedUriHandlerExtensionIds": [        ]}


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_07

settings.json配置


以上配置说明:

  • "terminal.integrated.shell.windows": "D:msys32msys2_shell.cmd"

----------------------是设置Windows环境集成终端,即msys32文件下的msys2_shell.cmd


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_08


  • "terminal.integrated.shellArgs.windows": 中的参数:

"-defterm" 表示将windows中集成终端作为默认终端,即上面的msys2_shell.cmd

"-no-start" 表示当我们点击vscode下方的“终端”时,不要默认msys32终端界面(小伙伴可以去掉这个选项,自行感受下)

"-mingw32" 表示指定使用mingw32终端,因为在msys32文件中有mingw32和mingw64,而esp8266在Makefile中就指定了必须使用mingw32,否则编译会通不过,感兴趣的小伙伴自行分析下Makefile就能验证了。

"-here" 表示打开终端时,默认的路径就在工程,若不加此选项,这默认是在家目录下(~),这样方便我们直接点击vscode中的终端时,就可以直接make编译拉,不然还要cd切换目录~

  • 其他的参数,关系不大,这里就不一一说明了

验证下配置效果,点击vscode下方的信息栏,打开我们的终端:


esp32视频传输 vscode vs code esp32_esp32视频传输 vscode_09


尝试配置,编译

首先我们先尝试下配置下我们的工程,在终端输入make menuconfig命令:


esp32视频传输 vscode vs code esp32_esp32视频传输 vscode_10


发现配置失败,根据提示“Your display is too small to run Menuconfig!” , 我们知道esp8266采用kconfig(类似linux内核配置方式)图形界面配置,因此我们只需要把终端界面拖大一点,以满足能够全部显示出menuconfig界面问题就解决啦~


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_11


这里会出现一些乱码(其实kconfig并是真正图形,只是用工具模拟出图形,之后有机会讲解如何配置linux内核时,我再来详细说明~), 解决的方法:在msys32etcprofile.dexport_idf_path.sh脚本中添加export LAND="en_US" ,导出LANG环境变量即可。


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_12


接着重启vscode,重新配置,正常显示~


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_13


尝试编译, make -j4, 也是成功编译:


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_14


创建工作区,实现跳转,代码自动补全

前面我们只将工程代码添加进来,而依赖的ESP8266_RTOS_SDK还没关联起来呢, 接下来我们就将其添加到当前工作区中。

  • 首先将工作区保存:点击"文件"->“将工作区另存为...”


esp32视频传输 vscode vs code esp32_tpc-zk-ii集成开发环境_15


  • 接着将ESP8266_RTOS_SDK添加进来, “文件”->"将文件夹添加到工作区",选择ESP8266_RTOS_SDK


esp32视频传输 vscode vs code esp32_esp32视频传输 vscode_16


  • 配置c_cpp_properties.json 文件, 按住键盘的: shift + ctrl + p, 出现如下图所示:


esp32视频传输 vscode vs code esp32_tpc-zk-ii集成开发环境_17


点击框选,会默认创建c_cpp_properties.json, 并在“includePath”栏中添加以下自己实际的ESP8266_RTOS_SDK/components路径,当然如果你的工作还有其他依赖,按此格式添加即可。

{    "configurations": [        {            "name": "Win32",            "includePath": [                "${workspaceFolder}/**",                "D:/msys32/home/40806/esp/ESP8266_RTOS_SDK/components/**"//自己要添加的头文件路径            ],//其他内容是默认生成的,无需改动            "defines": [                "_DEBUG",                "UNICODE",                "_UNICODE"            ],            "windowsSdkVersion": "10.0.18362.0",            "compilerPath": "E:/visual stdio2019/VC/Tools/MSVC/14.25.28610/bin/Hostx64/x64/cl.exe",            "cStandard": "c11",            "cppStandard": "c++17",            "intelliSenseMode": "msvc-x64"        }    ],    "version": 4}


esp32视频传输 vscode vs code esp32_tpc-zk-ii集成开发环境_18


当然修改完记得保存哦, 接下来我们就可以看到工程中包含的头文件都显示正常了(在此设置前很多#include “xxx”都红色波浪线+黄灯提示无法加载头文件):


esp32视频传输 vscode vs code esp32_tpc-zk-ii 集成开发环境_19


接着我们再试试能否代码自动补全功能和函数和变量跳转:


esp32视频传输 vscode vs code esp32_tpc-zk-ii集成开发环境_20


可以看到随着一边输入,vscode也一边提示相关补全,同时跳转功能也是OK的。