ESP32 SDK 开发——ESP32/ESP-IDF环境搭建-linux

Posted 2021-09-09 零涂

ubuntu18搭建ESP_IDF环境

参考资料

• 官方文档：https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html

1. 安装准备:

编译 ESP-IDF 需要以下软件包。请根据使用的系统，选择合适的安装命令，如下所示：

• Ubuntu 和 Debian:

sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0

• CentOS 7 & 8:

sudo yum -y update && sudo yum install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache dfu-util libusbx

目前仍然支持 CentOS 7，但为了更好的用户体验，建议使用 CentOS 8。

• Arch:

sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util libusb

注解

• 使用 ESP-IDF 需要 CMake 3.5 或以上版本。较早的 Linux 发行版可能需要升级自身的软件源仓库，或开启 backports 套件库，或安装 “cmake3” 软件包（不是安装 “cmake”）。
• 如果上述列表中，并没有您使用的系统，请参考您所用系统的相关文档，查看安装软件包所用的命令。
• 如果在安装过程中出现依赖，而且一直不能解决依赖，建议更换软件源，亲测清华源完美解决。更换方法：https://www.jianshu.com/p/206dd6d34f00 建议使用命令方式修改
• ESP-IDF 支持 Python 3.6 及以上版本，建议升级操作系统到最新版本从而更新 Python。也可选择从 sources 安装最新版 Python，或使用 Python 管理系统如 pyenv 对版本进行升级管理。

2. 获取ESP—IDF

在围绕 ESP32 构建应用程序之前，请先获取乐鑫提供的软件库文件 ESP-IDF 仓库。

获取 ESP-IDF 的本地副本：打开终端，切换到您要保存 ESP-IDF 的工作目录，使用 git clone 命令克隆远程仓库。针对不同操作系统的详细步骤，请见下文。

打开终端，后运行以下命令：

mkdir -p ~/esp
cd ~/esp
git clone  -b v4.3 https://gitee.com/EspressifSystems/esp-idf.git
下载子模块参考：https://gitee.com/EspressifSystems/esp-gitee-tools/blob/master/docs/README-submodule-update.md

ESP-IDF 将下载至 ~/esp/esp-idf。

3. 设置工具

除了 ESP-IDF 本身，您还需要安装 ESP-IDF 使用的各种工具，比如编译器、调试器、Python 包等。

cd ~/esp/esp-idf
./install.sh esp32

或使用 Fish shell

cd ~/esp/esp-idf
./install.fish esp32

注解

• 通过一次性指定多个目标，可为多个目标芯片同时安装工具，如运行 ./install.sh esp32,esp32c3,esp32s3。 通过运行 ./install.sh 或 ./install.sh all 可一次性为所有支持的目标芯片安装工具。
• ESP-IDF 工具安装器会下载 Github 发布版本中附带的一些工具，如果访问 Github 较为缓慢，则可以设置一个环境变量，实现优先选择 Espressif 的下载服务器进行 Github 资源下载。

强烈建议使用国内下载：要在安装工具时优先选择 Espressif 下载服务器，请在运行 install.sh 时使用以下命令：

cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
./install.sh

4.设置环境变量

此时，您刚刚安装的工具尚未添加至 PATH 环境变量，无法通过“命令窗口”使用这些工具。因此，必须设置一些环境变量，这可以通过 ESP-IDF 提供的另一个脚本完成。
请在需要运行 ESP-IDF 的终端窗口运行以下命令：

. $HOME/esp/esp-idf/export.sh

对于 fish shell（仅支持 fish 3.0.0 及以上版本），请运行以下命令：

. $HOME/esp/esp-idf/export.fish

注意，命令开始的 “.” 与路径之间应有一个空格！

如果您需要经常运行 ESP-IDF，您可以为执行 export.sh 创建一个别名，具体步骤如下：

• 1. 复制并粘贴以下命令到 shell 配置文件中（.profile， .bashrc， .zprofile 等）

     alias get_idf='. $HOME/esp/esp-idf/export.sh'
     

• 2. 通过重启终端窗口或运行 source [path to profile]，如 source ~/.bashrc 来刷新配置文件。

现在您可以在任何终端窗口中运行 get_idf 来设置或刷新 esp-idf 环境。
这里不建议您直接将 export.sh 添加到 shell 的配置文件。因为这会导致在每个终端会话中都激活 IDF 虚拟环境（包括无需使用 IDF 的情况），从而破坏使用虚拟环境的目的，并可能影响其他软件的使用。

5. 开始创建工程

现在，您可以开始准备开发 ESP32 应用程序了。您可以从 ESP-IDF 中 examples 目录下的 get-started/hello_world 工程开始。(以后开发也是，需要哪个就复制哪个)

将 get-started/hello_world 工程复制至您本地的 ~/esp 目录下：

cd ~/esp
cp -r $IDF_PATH/examples/get-started/hello_world .

ESP-IDF 的 examples 目录下有一系列示例工程，都可以按照上面的方法进行创建。您可以按照上述方法复制并运行其中的任何示例，也可以直接编译示例，无需进行复制。

注意：ESP-IDF 编译系统不支持带有空格的路径。

6. 连接设备

现在，请将您的 ESP32 开发板连接到 PC，并查看开发板使用的串口。
通常，串口在不同操作系统下显示的名称有所不同：

• Windows 操作系统： COM1 等
• Linux 操作系统： 以 /dev/tty 开始
• macOS 操作系统： 以 /dev/cu. 开始

注解

• 如果你使用的是虚拟机，那么要显示USB的话必须先安装VMware-tool， 安装方法见：https://zhuanlan.zhihu.com/p/56932426
• 使用 ls /dev/tty* 命令查看端口号， 一般是ttyUSB0, ttyUSB1, ttyUSBx等等。
• 在下载的时候可能会遇到无法打开ttyUSB0的错误和显示没有权限打开ttyUSB0等等。此时运行 sudo chmod 666 /dev/ttyUSB0 就可以了。

7. 配置

cd ~/esp/hello_world
idf.py set-target esp32
idf.py menuconfig

打开一个新项目后，应首先设置“目标”芯片 idf.py set-target esp32。注意，此操作将清除并初始化项目之前的编译和配置（如有）。 您也可以直接将“目标”配置为环境变量（此时可跳过该步骤）。更多信息，请见
https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/build-system.html#selecting-idf-target

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-N75PHaDn-1629600025243)(./home/duke/project-configuration1.png)]

您可以通过此菜单设置项目的具体变量，包括 Wi-Fi 网络名称、密码和处理器速度等. hello_world 示例项目会以默认配置运行，因此可以跳过使用 menuconfig 进行项目配置这一步骤。

注解

• 如果您使用的是 ESP32-DevKitC（板载 ESP32-SOLO-1 模组）或 ESP32-DevKitM-1（板载 ESP32-MINI-1(1U) 模组），请在烧写示例程序前，前往 menuconfig 中使能单核模式（CONFIG_FREERTOS_UNICORE）。
• 您终端窗口中显示出的菜单颜色可能会与上图不同。您可以通过选项 --style 来改变外观。更多信息，请运行 idf.py menuconfig --help 命令。
• 如果在运行idf.py set-target esp32的时候出现报错，大概率为下载SDK的时候子模块没有下载，那么需要再次下载子模块，方法：把错误复制下来， 教程：https://gitee.com/EspressifSystems/esp-gitee-tools/blob/master/docs/README-submodule-update.md

8.编译工程

请使用以下命令，编译烧录工程：

idf.py build

运行以上命令可以编译应用程序和所有 ESP-IDF 组件，接着生成 bootloader、分区表和应用程序二进制文件。

$ idf.py build
Running cmake in directory /path/to/hello_world/build
Executing "cmake -G Ninja --warn-uninitialized /path/to/hello_world"...
Warn about uninitialized values.
-- Found Git:/usr/bin/git (found version "2.17.0")
-- Building empty aws_iot component due to configuration
-- Component names: ...
-- Component paths: ...

... (more lines of build system output)

[527/527] Generating hello-world.bin
esptool.py v2.3.1

Project build complete. To flash, run this command:
../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello-world.bin  build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
or run 'idf.py -p PORT flash'

如果一切正常，编译完成后将生成 .bin 文件。

9. 烧录到设备

请使用以下命令，将刚刚生成的二进制文件 (bootloader.bin, partition-table.bin 和 hello-world.bin) 烧录至您的 ESP32 开发板：

idf.py -p PORT [-b BAUD] flash

例如： idf.py -p /dev/ttyUSB0 flash
请将 PORT 替换为 ESP32 开发板的串口名称，具体可见 第六步：连接设备。

您还可以将 BAUD 替换为您希望的烧录波特率。默认波特率为 460800。

更多有关 idf.py 参数的详情，请见 idf.py。

烧录过程中可能遇到的问题

如果在运行给定命令时出现如“连接失败”这样的错误，原因之一则可能是运行 esptool.py 出现错误。esptool.py 是构建系统调用的程序，用于重置芯片、与 ROM 引导加载器交互以及烧录固件的工具。解决该问题的一个简单的方法就是按照以下步骤进行手动复位。如果问题仍未解决，请参考 Troubleshooting 获取更多信息。

esptool.py 通过使 USB 转串口转接器芯片（如 FTDI 或 CP210x）的 DTR 和 RTS 控制线生效来自动复位 ESP32（请参考 与 ESP32 创建串口连接 获取更多详细信息)。DTR 和 RTS 控制线又连接到 ESP32 的 GPIO0 和 CHIP_PU (EN) 管脚上，因此 DTR 和 RTS 的电压电平变化会使 ESP32 进入固件下载模式。相关示例可查看 ESP32 DevKitC 开发板的 原理图。

一般来说，使用官方的 esp-idf 开发板不会出现问题。但是，esptool.py 在以下情况下不能自动重置硬件。

• 您的硬件没有连接到 GPIO0 和 CIHP_PU 的 DTR 和 RTS 控制线。
• DTR 和 RTS 控制线的配置方式不同
• 根本没有这样的串行控制线路
  根据您硬件的种类，也可以将您 ESP32 开发板手动设置成固件下载模式（复位）。
• 对于 Espressif 的开发板，您可以参考对应开发板的入门指南或用户指南。例如，可以通过按住 Boot 按钮 (GPIO0) 再按住 EN 按钮(CHIP_PU) 来手动复位 esp-idf 开发板。
• 对于其他类型的硬件，可以尝试将 GPIO0 拉低。

常规操作

在烧录过程中，您会看到类似如下的输出日志：

...
esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello-world.bin
esptool.py v3.0-dev
Serial port /dev/ttyUSB0
Connecting........_
Chip is ESP32D0WDQ6 (revision 0)
Features: WiFi, BT, Dual Core, Coding Scheme None
Crystal is 40MHz
MAC: 24:0a:c4:05:b9:14
Uploading stub...
Running stub...
Stub running...
Changing baud rate to 460800
Changed.
Configuring flash size...
Compressed 3072 bytes to 103...
Writing at 0x00008000... (100 %)
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 5962.8 kbit/s)...
Hash of data verified.
Compressed 26096 bytes to 15408...
Writing at 0x00001000... (100 %)
Wrote 26096 bytes (15408 compressed) at 0x00001000 in 0.4 seconds (effective 546.7 kbit/s)...
Hash of data verified.
Compressed 147104 bytes to 77364...
Writing at 0x00010000... (20 %)
Writing at 0x00014000... (40 %)
Writing at 0x00018000... (60 %)
Writing at 0x0001c000... (80 %)
Writing at 0x00020000... (100 %)
Wrote 147104 bytes (77364 compressed) at 0x00010000 in 1.9 seconds (effective 615.5 kbit/s)...
Hash of data verified.

Leaving...
Hard resetting via RTS pin...
Done

10. 监视器

您可以使用 idf.py -p PORT monitor 命令，监视 “hello_world” 工程的运行情况。注意，不要忘记将 PORT 替换为您的串口名称。

运行该命令后，IDF 监视器 应用程序将启动：:

$ idf.py -p /dev/ttyUSB0 monitor
Running idf_monitor in directory [...]/esp/hello_world/build
Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello-world.elf"...
--- idf_monitor on /dev/ttyUSB0 115200 ---
--- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
ets Jun  8 2016 00:22:57

rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
ets Jun  8 2016 00:22:57
...

此时，您就可以在启动日志和诊断日志之后，看到打印的 “Hello world!” 了。

...
Hello world!
Restarting in 10 seconds...
This is esp32 chip with 2 CPU core(s), WiFi/BT/BLE, silicon revision 1, 2MB external flash
Minimum free heap size: 298968 bytes
Restarting in 9 seconds...
Restarting in 8 seconds...
Restarting in 7 seconds...

您可使用快捷键 Ctrl+]，退出 IDF 监视器。
如果 IDF 监视器在烧录后很快发生错误，或打印信息全是乱码（如下），很有可能是因为您的开发板采用了 26 MHz 晶振，而 ESP-IDF 默认支持大多数开发板使用的 40 MHz 晶振。