前言
最近虚拟机越用越卡,硬盘占用空间越来越大,整理了磁盘碎片也于事无补。那就重新搭建一遍环境,记录一下,以供交流学习。本文基于 Ubuntu 20.04 和 ESP-IDF 5.1,搭建 ESP32 最新代码的编译环境。
1 安装准备
(1) 编译 ESP-IDF 需要以下软件包支持,输入指令进行安装;
sudo apt-get install git wget flex bison gperf python3 python3-venv python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
(2) 输入 Y/y,继续安装,直到所有软件包安装完成。
以上软件包安装成功以后,我们还需要确定两个软件包的版本是否满足 ESP-IDF 的需求。
1.1 Python版本
目前,ESP-IDF 4.3 以上的版本都是基于 python3 进行构建。所以我们需要检查一下 python3 有没有安装成功。输入指令查看:
python3 --version
当输出 Python 3.8.10 时,python3 软件包安装成功。如果输出 Python 2.x.x,那么需要重新输入命令安装 python3,或者去 python 官网下载软件包手动安装。
1.2 Cmake版本
使用 ESP-IDF (5.1) 需要 CMake 3.16 或以上版本,输入指令查看:
cmake --version
当输出 cmake version 3.16.3 (高于 3.16)时,camke 软件包安装成功。
2 获取 ESP-IDF
在围绕 ESP32 构建应用程序之前,需要先获取乐鑫提供的软件库文件 ESP-IDF 仓库。
获取 ESP-IDF 的本地副本:打开终端,切换到要保存 ESP-IDF 的工作目录,使用 git clone 命令克隆远程仓库。
(1) 打开终端,输入以下命令:
mkdir -p ~/esp cd ~/esp git clone --recursive https://github.com/espressif/esp-idf.git
ESP-IDF 将下载至 ~/esp/esp-idf。
(2) clone 完成后,输入命令查看当前分支状态;
git status
当提示:nothing to commit,working tree clean,表示代码 clone 成功。
如果有同学代码 clone 失败,由于占用过多篇幅,这里不做介绍,感兴趣的可以参考:
git submodule update --init --recursive失败的处理办法
3 设置工具
除了 ESP-IDF 本身,还需要为支持 ESP32 的项目安装 ESP-IDF 使用的各种工具,比如编译器、调试器、Python 包等。
(1) ESP32 官方为我们提供了安装脚本 install.sh,输入以下指令安装:
1. cd ~/esp/esp-idf 2. export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets" 3. ./install.sh esp32
(2) 上述命令仅仅为 ESP32 安装所需工具。如果需要为多个目标芯片开发项目,则可以一次性指定多个目标,如下所示
cd ~/esp/esp-idf export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets" ./install.sh esp32,esp32s2
(3) 如果需要一次性为所有支持的目标芯片安装工具,可以运行如下命令:
1. cd ~/esp/esp-idf 2. export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets" 3. ./install.sh all
(4) 当提示:All done! You can now run: . ./export.sh,表示工具安装成功。
(目前,作者开发的硬件平台仅限于 esp32,所以这里指定目标芯片为 esp32)
ESP-IDF 工具安装器会下载 Github 发布版本中附带的一些工具,如果访问 Github 较为缓慢,可以设置一个环境变量,从而优先选择 Espressif 的下载服务器进行 Github 资源下载。
(上述我们已经使用了:export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets")
(5) 上述所有工具安装在用户根目录下的 .espressif 隐藏文件夹中。在用户根目录下,我们使用快捷键 CTRL+H 显示所有隐藏文件和文件夹,进入文件夹,如下所示:
4 设置环境变量
此时,刚刚安装的工具尚未添加至 PATH 环境变量,无法通过“命令窗口”使用这些工具。因此,必须设置一些环境变量。这可以通过 ESP-IDF 提供的另一个脚本进行设置。
4.1 官方命令
(1) 在需要运行 ESP-IDF 的终端窗口运行以下命令:
. $HOME/esp/esp-idf/export.sh
当提示:Go to the project directory and run: idf.py build,表示环境设置有效。
4.2 别名设置
这样比较麻烦,每次获取 esp-idf 环境,都需要输入一大段命令。我们可以为执行 export.sh 创建一个别名,具体步骤如下:
(1) 使用 gedit 打开 .bashrc 配置文件;
sudo gedit ~/.bashrc
粘贴完成后,使用 CTRL+S 快捷键保存内容,然后点击右上角“x”,关闭 .bashrc 文档。
(3) 输入指令,刷新配置环境并重启;
1. source ~/.bashrc 2. reboot
(4) 重启后,输入指令,查看环境配置;
get_idf
这样我们可以在任何终端窗口中运行 get_idf 来设置或刷新 esp-idf 环境。
5 开始创建工程
我们可以从 ESP-IDF 中 examples 目录下的 get-started/hello_world 工程开始。
输入以下指令,将 get-started/hello_world 工程复制至本地的 ~/esp 目录下:
1. cd ~/esp 2. cp -r $IDF_PATH/examples/get-started/hello_world .
6 连接设备
(1) 输入命令,查看系统默认 USB 设备名;
sudo ls /dev/tty*
(2) 将 ESP32 开发板连接到 PC(虚拟机中),输入指令查看开发板使用的串口;
一般设备名称的最后一个,就是 ESP32 开发板在虚拟机上映射的串口名称(如 ttyUSB0 或者 ttyACM0)。记住该串口名,后续烧录和监控中需要使用。
7 配置工程
进入 hello_world 目录,设置 ESP32 为目标芯片,然后运行工程配置工具 menuconfig。
1. cd ~/esp/hello_world 2. idf.py set-target esp32 3. idf.py menuconfig
当提示:Configuring done...,表示目标芯片设置成功。
可以使用 menuconfig 设置项目的具体变量,包括 Wi-Fi 网络名称、密码和处理器速度等。
hello_world 示例项目会以默认配置运行,因此在这一项目中,可以跳过使用 menuconfig 进行项目配置这一步骤。
8 编译工程
使用以下指令,编译烧录工程:
idf.py build
运行以上指令可以编译应用程序和所有 ESP-IDF 组件,接着生成引导加载程序(bootloader.bin)、分区表(partition-table.bin)和应用程序二进制文件(xxxx.bin)。
如果一切正常,编译完成后将生成 .bin 文件。
9 烧录到设备
(1) 运行以下指令,将刚刚生成的二进制文件烧录至 ESP32 开发板:
idf.py -p /dev/ttyUSB0 flash
(2) 如果一切顺利,烧录完成后,开发板将会复位,应用程序 “hello_world” 开始运行;
10 监视输出
可以使用 idf.py -p PORT monitor 命令,监视 “hello_world” 工程的运行情况。注意,不要忘记将 PORT 替换为第 6 步查看的串口名称。
(1) 输入指令,监控开发板运行状况:
idf.py -p /dev/ttyUSB0 monitor
运行该命令后,IDF 监视器 应用程序将启动:
(2) 在启动日志和诊断日志之后,看到打印的 “Hello world!” 了;
可使用快捷键 Ctrl+],退出 IDF 监视器。
11 清除工程
当我们需要清除刚刚编译和配置的文件时,ESP-IDF 提供了两种清除指令。
11.1 idf.py clean
可以使用 idf.py clean 命令从生成目录中删除项目生成输出文件。
该项目将在下次构建时被完全重建。使用这个方法并不会删除构建文件夹中的 CMake 配置输出。
11.2 idf.py fullclean
运行此命令将删除整个 "build" 目录的内容。这包括所有的 CMake 配置输出。下次构建项目时,CMake 将从头开始配置它。注意,这个选项会递归地删除构建目录中的所有文件,所以要小心使用。项目配置不会被删除。
总结
完成以上 ESP-IDF 编译环境的搭建和 hello_world 工程的编译—>下载—>运行—>监控。恭喜,您已完成 ESP32 的入门学习!