【乐鑫ESP32-C3 RISC-V处理器IoT开发板试用体验】完全使用Visual Studio Code+ESP官方插件进行开发工作指南

官方下载安装

本帖最后由 HonestQiao 于 2021-8-31 16:22 编辑

目录
前言
第一步：安装Visual Studio Code
1. 官方下载安装：访问
2. 中文语言包：
第二步：安装ESP官方插件
1. 安装ESP官方扩展：
2. 查看Espressif IDF插件网页：
3. 基础工具：
第三步：通过Espressif IDF插件，安装ESP-IDF开发环境
1. 配置开发环境：
2. 安装ESP-IDF开发工具：
第四步：建立ESP开发工作区
1. 保存工作区
2. 设置工作目录
第五步：参考ESP-IDF官方样例开始第一个项目开发
1. 调用命令：
2. 查看例子列表：
3. 选择blink例子
第六步：编译、烧录、运行
1. 连接串口
2. 连接到设备
3. 设置设备类型
4. 编译+开发+监视一条龙
第七步：通过模板，建立自己的项目
1. 执行命令创建项目，并编译烧录监控
2. Arduino组件库
3. Hello World项目
第八步：ESP官方插件命令和快捷按钮

后记

阅读说明：阅读本文，并动手实践，预计在1小时内，你将掌握使用Visual Studio Code+ESP官方插件进行开发工作的基本功。

前言
这篇文章，要告诉你的就是，不玩什么幺蛾子，就用Visual Studio Code进行ESP32-C3开发。这个开发，All In，代码编写、编译、烧录、调试，一条龙全搞定。虽然下面的例子，是在MacOS下面进行的，但对于Linux、Windows同样可以参考。

本文中，仅用到两个快捷键：
MaxOS系统：
Cmd+Shift+P：打开命令面板
Cmd+Shift+X：打开扩展面板

Windows系统：
Ctrl+Shift+P：打开命令面板
Ctrl+Shift+X：打开扩展面板
Linuxx系统：
参考以上和系统实际快捷键

第一步：安装Visual Studio Code
1. 官方下载安装：访问

2. 中文语言包：
安装完成后，View->Extensions（或者Cmd+Shift+X），打开扩展面板，搜索Chinese，安装第一个：Chinese (Simplified) Language Pack，点【Install】即可安装；
安装后重启，中文界面的Visual Studio Code就可以使用了。

第二步：安装ESP官方插件
1. 安装ESP官方扩展：
Visual Studio Code，查看->扩展（或者Cmd+Shift+X），打开扩展面板，搜索Espressif IDF，然后点击【安装】，等待安装完成即可

2. 查看Espressif IDF插件网页：
安装完成后，点击右则Espressif IDF说明页面的标题：Espressif IDF，打开插件官方介绍页

Espressif IDF插件官方介绍页：访问

3. 基础工具：
在该页面上，详细说明了，使用该插件，需要预装一些基础的工具，具体情况如下：

安装完以上的基础工具后，我们就可以下一步了。

第三步：通过Espressif IDF插件，安装ESP-IDF开发环境
1. 配置开发环境：
Cmd+Shift+P打开命令面板，如下图所示，输入：>ESP-IDF: Configure ESP-IDF extension

点击命令面板中列出来的： ESP-IDF: 配置ESP-IDF 插件，将出现ESP-IDF开发环境的配置安装界面。

注意，如果电脑上已经安装过ESP-IDF开发环境，则会出现如下界面：

为了保险起见，我们选择 Express 模式，安装一个全新的环境。
直接点击Express，进入到安装设置界面：

在这个界面上，可以设置从哪里下载ESP-IDF包，已经版本，安装位置，Python版本等，请根据实际情况填写，或者使用默认值。
为了更快下载ESP-IDF包，我们如上图选择下载服务器为：Espressif，然后点击右下角的【Install】，开始安装。

2. 安装ESP-IDF开发工具：
首先安装的是ESP-IDF包，核心基础，具体下载需要的时间，根据网速而定，耐心点就是了。

前面我在图片中说了，如果不能访问Github，则选择Espressif下载服务器下载ESP-IDF，但是到这里翻车了，下面的这些编译调试工具，还是从Github下载的。
如果不能正常访问Github，则对应的进度条一直不走，且底部的输出窗口会显示HTTP/HTTPS之类的错误。
所以，还是得先想办法，确保能够正常访问Github，能正常使用Git访问Github。八仙过海，各显神通吧。

正常下载情况下，进度会嗖嗖嗖的，底部输出窗口，也会显示安装情况。

一切安装完成后，你会看到如下界面。
恭喜你，ESP-IDF开发环境已经建立好了。

第四步：建立ESP开发工作区：
1. 保存工作区
首先将当前环境保存到起来：

将工作区文件，保存到一个专门的ESP工作目录中，这个目录，也作为我们今后进行ESP项目开发的存放目录。

2. 设置工作目录：
然后将上述目录，添加到这个工作区中来：

保存和添加完成后，结果如下：

第五步：参考ESP-IDF官方样例开始第一个项目开发：
1. 调用命令：
Cmd+Shift+P打开命令面板，按图找到 ESP-IDF：显示示例项目，或者输入 >ESP-IDF: Show Examples Projects
注意：命令面板列出的命令菜单中，中文部分为命令说明，全英文的部分为命令，输入命令可以直达对应的功能。另外，输入的命令前，必须有>符号，否则不被认为是命令。

紧接着，会出现本机ESP-IDF环境列表，选择我们安装ESP-IDF时对应目录的即可。

2. 查看例子列表：
随后，就会显示官方的所有例子列表：

其中包括：基础（闪烁LED、Hello World）、蓝牙、C++、网卡、mesh、外围设备通信、协议、WiFi、安全、存储、系统等例子程序。

3. 选择blink例子
我们选择blink例子，能够让板载LED闪烁，简单又直观。
选择后，会提示保存路径，我们选择之前第四步创建的ESP工作目录即可。

创建完成，自动生成项目文件，打开main/blink.c，可以查看具体的代码

通过以上步骤，我们就使用官方例子，创建了第一个项目blink。

第六步：编译、烧录、运行
1. 连接串口：
首先，我们要将设备接上，然后Cmd+SHift+P打开命令面板，输入 >ESP-IDF: Select port to use，也就是 ESP-IDF: 选择要使用的烧录端口，将会列出当前电脑上的设备端口

根据你的实际情况，进行选择。我的电脑连接后，端口为 /dev/cu.u***serial-1420，因此我选择它，点击即可。

点击后，Visual Studio Code界面右下角，会出现更新串口信息的弹窗：

2. 连接到设备：
点击Visual Studio Code右边工具栏的Esp图标，出现如下调试界面：

点击其中的 Connect your board first，会出现如下板子对应的信息：

【特别提醒】如果是在Linux环境下，普通用户，是无权直接操作串口的，操作过程中，会出现类似权限错误：[Errno 13] Permission denied: '/dev/ttyUSB0'，此时，应该进行如下操作：解决Linux非root用户读写串口权限问题

3. 设置设备类型：
Cmd+Shift+P打开命令面板，输入 >ESP-IDF: Set Espressif device target 或者找到 ESP-IDF: 设置Espressif设备目标

因为我们使用的是ESP32-C3，且使用USB连接的，所以选择 ESP32-C3 (Built-in USB JTAG) 即可

4. 编译+开发+监视一条龙：
Cmd+Shift+P打开命令面板，输入 >ESP-IDF: Build, Flash and start a monitor on your device，也就是 ESP-IDF: 构建、烧写项目及启动监视器

使用以上命令，会自动完成编译、烧录，以及启动监视器三个过程。
具体过程如下：
1) 编译：
底部终端窗口中的 [?? / **]，表示编译的进度，首次编译的项目会比较长，后续只编译更新过的。

2) 烧录：
底部终端窗口中的Write at 0x000???? (**%)，表示烧录进度，到100%表示完成

3) 监控运行：
底部终端窗口中的绿色部分，I (??) boot: **** 表示设备启动，进入了监控状态了

设备运行时输出的信息，都会在这个监视窗口中显示出来。

此时，请关注一下你的板子吧，看看它的板载LED的闪烁，是不是和上面的监视窗口输出的信息同频的。

在监控状态下，如果要退出，按Ctrl+]即可退出。

如果需要学习其他的例子项目，可以按 Cmd+Shift+P打开命令面板，输入>ESP-IDF: Show Examples Projects ，或者找到 ESP-IDF：显示示例项目，点击后，再次进入官方例子列表，选择对应的例子创建项目即可。

第七步：通过模板，建立自己的项目：
1. 执行命令创建项目，并编译烧录监控
Cmd+Shift+P打开命令面板，输入 ESP-IDF: Create project from extension template, 或者找到 ESP-IDF：从扩展模板创建项目

会提示选择ESP-IDF环境，再显示模板列表：

其中包括：构建可在Arduino 中使用的组件库、斐波那契数列的例子、新的组件，以及普通app模板。

2. Arduino组件库：
如果选择arduino-as-component，会创建一个Arduino的组件库，具体如下：

其中将可以使用Ardunio中定义的函数方法：

3. Hello World项目：
在这里，我们选择template-app模板，建立一个简单的Hello World的项目。

其对应的核心代码如下：

创建完成后，我们再依次执行命令：
(1) >ESP-IDF: Select port to use，也就是 ESP-IDF: 选择要使用的烧录端口
(2)>ESP-IDF: Set Espressif device target ，也就是 ESP-IDF: 设置Espressif设备目标
(3)>ESP-IDF: Build, Flash and start a monitor on your device，也就是 ESP-IDF: 构建、烧写项目及启动监视器

这个Hello World项目，将会被编译，并烧录到设备中，并被监控运行。

第八步：ESP官方插件常用命令和快捷按钮
通过之前的学习，我们已经知道了部分插件命令：
ESP-IDF: Configure ESP-IDF extension ：配置ESP-IDF插件
ESP-IDF: Show Examples Projects：查看官方样例
ESP-IDF: Select port to use：选择设备端口
ESP-IDF: Set Espressif device target：设置设备类型
ESP-IDF: Build, Flash and start a monitor on your device：编译烧录监控一条龙
ESP-IDF: Create project from extension template：通过模板创建工程
还有一些常用命令如下：
ESP-IDF: New Project：新建工程
ESP-IDF: Build your project：编译项目
ESP-IDF: Full clean project：清理工程目录，以便重新编译
ESP-IDF: Flash (UART) your project：烧录
ESP-IDF: Monitor your device：监控运行
监控运行更多插件命令，可以Cmd+Shift+P，输入 >ESP-IDF后查看列表。
另外，插件本还提供了快捷按钮以便操作，如下图所示点击右边快捷导航栏的ESP图标(像面条？)，就会进入ESP插件调试界面，左下角就是快捷按钮，具体功能如图所示：

后记
以上内容，只是对Visual Studio Code+ESP官方插件进行开发工作的一个基础指南。
该插件有丰富的功能，更进一步的使用，请大家访问插件介绍网页进行了解。
关于ESP32-C3的具体功能开发，请大家通过官方例子多多学习实践，一定会受益匪浅。

最后，祝愿大家早日成为ESP32-C3开发高手！！！

【特别提醒】如果是在Linux环境下，普通用户，是无权直接操作串口的，操作过程中，会出现类似权限错误：[Errno 13] Permission denied: '/dev/ttyUSB0'，此时，应该进行如下操作：解决Linux非root用户读写串口权限问题