# Windows 平台工具链的标准设置

[English]

## 概述

ESP-IDF 需要安装一些必备工具，才能围绕 ESP32-H2 构建固件，包括 Python、Git、交叉编译器、CMake 和 Ninja 编译工具等。

本入门指南介绍了如何通过 命令提示符 进行有关操作。不过，安装 ESP-IDF 后，还可以使用 Eclipse Plugin 或其他支持 CMake 的图形化工具 IDE。

备注

限定条件：

- 请注意 ESP-IDF 和 ESP-IDF 工具的安装路径不能超过 90 个字符，安装路径过长可能会导致构建失败。

- Python 或 ESP-IDF 的安装路径中一定不能包含空格或括号。

- 除非操作系统配置为支持 Unicode UTF-8，否则 Python 或 ESP-IDF 的安装路径中也不能包括特殊字符（非 ASCII 码字符）

系统管理员可以通过如下方式将操作系统配置为支持 Unicode UTF-8：`Control Panel` > 更改 `date`、`time`、或 `number` 格式 > `Administrative tab` > 更改 `system locale` > 勾选选项 `Beta: Use Unicode UTF-8 for worldwide language support` > `Ok` > 重启电脑。

## ESP-IDF 工具安装器

安装 ESP-IDF 必备工具最简易的方式是下载一个 ESP-IDF 工具安装器。

| Windows Installer Download

### 在线安装与离线安装的区别

在线安装程序非常小，可以安装 ESP-IDF 的所有版本。在安装过程中，安装程序只下载必要的依赖文件，包括 Git For Windows 安装器。在线安装程序会将下载的文件存储在缓存目录 `%userprofile%/espressif` 中。

离线安装程序不需要任何网络连接。安装程序中包含了所有需要的依赖文件，包括 Git For Windows 安装器。

### 安装内容

安装程序会安装以下组件：

- 内置的 Python

- 交叉编译器

- OpenOCD

- CMake 和 Ninja 编译工具

- ESP-IDF

安装程序允许将程序下载到现有的 ESP-IDF 目录。推荐将 ESP-IDF 下载到 `%userprofile%\Desktop\esp-idf` 目录下，其中 `%userprofile%` 代表家目录。

### 启动 ESP-IDF 环境

安装结束时，如果勾选了 `Run ESP-IDF PowerShell Environment` 或 `Run ESP-IDF Command Prompt (cmd.exe)`，安装程序会在选定的提示符窗口启动 ESP-IDF。

`Run ESP-IDF PowerShell Environment`:

完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF PowerShell Environment

ESP-IDF PowerShell

`Run ESP-IDF Command Prompt (cmd.exe)`:

完成 ESP-IDF 工具安装向导时运行 Run ESP-IDF Command Prompt (cmd.exe)

ESP-IDF 命令提示符窗口

## 使用命令提示符

在后续步骤中，将介绍如何使用 Windows 的命令提示符进行操作。

ESP-IDF 工具安装器可在“开始”菜单中，创建一个打开 ESP-IDF 命令提示符窗口的快捷方式。本快捷方式可以打开 Windows 命令提示符（即 cmd.exe），并运行 `export.bat` 脚本以设置各环境变量（比如 `PATH`，`IDF_PATH` 等）。此外，还可以通过 Windows 命令提示符使用各种已经安装的工具。

注意，本快捷方式仅适用 ESP-IDF 工具安装器中指定的 ESP-IDF 路径。如果电脑上存在多个 ESP-IDF 路径（比如需要不同版本的 ESP-IDF），有以下两种解决方法：

1. 为 ESP-IDF 工具安装器创建的快捷方式创建一个副本，并将新快捷方式的 ESP-IDF 工作路径指定为希望使用的 ESP-IDF 路径。

2. 或者，可以运行 `cmd.exe`，并切换至希望使用的 ESP-IDF 目录，然后运行 `export.bat`。注意，这种方法要求 `PATH` 中存在 Python 和 Git。如果在使用时遇到有关“找不到 Python 或 Git”的错误信息，请使用第一种方法。

## 开始使用 ESP-IDF

现在你已经具备了使用 ESP-IDF 的所有条件，接下来将介绍如何开始第一个工程。

本指南将介绍如何初步上手 ESP-IDF，包括如何使用 ESP32-H2 创建第一个工程，并构建、烧录和监控设备输出。

备注

如果还未安装 ESP-IDF，请参照 安装 中的步骤，获取使用本指南所需的所有软件。

## 开始创建工程

现在，可以准备开发 ESP32-H2 应用程序了。可以从 ESP-IDF 中 examples 目录下的 get-started/hello_world 工程开始。

重要

ESP-IDF 编译系统不支持 ESP-IDF 路径或其工程路径中带有空格。

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

    cd %userprofile%\esp
    xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world

备注

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

## 连接设备

现在，请将 ESP32-H2 开发板连接到 PC，并查看开发板使用的串口。

在 Windows 操作系统中，串口名称通常以 `COM` 开头。

有关如何查看串口名称的详细信息，请见 与 ESP32-H2 创建串口连接。

备注

请记住串口名，以便后续使用。

## 配置工程

请进入 `hello_world` 目录，设置 ESP32-H2 为目标芯片，然后运行工程配置工具 `menuconfig`。

### Windows

    cd %userprofile%\esp\hello_world
    idf.py set-target esp32h2
    idf.py menuconfig

打开一个新工程后，应首先使用 `idf.py set-target esp32h2` 设置“目标”芯片。注意，此操作将清除并初始化项目之前的编译和配置（如有）。也可以直接将“目标”配置为环境变量（此时可跳过该步骤）。更多信息，请见 选择目标芯片：set-target。

正确操作上述步骤后，系统将显示以下菜单：

工程配置 — 主窗口

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

备注

终端窗口中显示出的菜单颜色可能会与上图不同。可以通过选项 `--style` 来改变外观。请运行 `idf.py menuconfig --help` 命令，获取更多信息。

## 编译工程

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

    idf.py build

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

    $ 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 文件。

## 烧录到设备

请运行以下命令，将刚刚生成的二进制文件烧录至 ESP32-H2 开发板：

    idf.py -p PORT flash

请将 PORT 替换为 ESP32-H2 开发板的串口名称。如果 `PORT` 未经定义，idf.py 将尝试使用可用的串口自动连接。

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

备注

勾选 `flash` 选项将自动编译并烧录工程，因此无需再运行 `idf.py build`。

若在烧录过程中遇到问题，请参考下文中的“其他提示”。也可以前往 烧录故障排除 或 与 ESP32-H2 创建串口连接 获取更多详细信息。

### 常规操作

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

    ...
    esptool esp32h2 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 48m --flash_size 2MB 0x0 bootloader/bootloader.bin 0x10000 hello_world.bin 0x8000 partition_table/partition-table.bin
    esptool.py v4.6
    Serial port /dev/ttyUSB0
    Connecting....
    Chip is ESP32-H2 (revision v0.1)
    Features: BLE
    Crystal is 32MHz
    MAC: 60:55:f9:f7:3e:93:ff:fe
    Uploading stub...
    Running stub...
    Stub running...
    Changing baud rate to 460800
    Changed.
    Configuring flash size...
    Flash will be erased from 0x00000000 to 0x00005fff...
    Flash will be erased from 0x00010000 to 0x00034fff...
    Flash will be erased from 0x00008000 to 0x00008fff...
    Compressed 20880 bytes to 12788...
    Writing at 0x00000000... (100 %)
    Wrote 20880 bytes (12788 compressed) at 0x00000000 in 0.6 seconds (effective 297.5 kbit/s)...
    Hash of data verified.
    Compressed 149424 bytes to 79574...
    Writing at 0x00010000... (20 %)
    Writing at 0x00019959... (40 %)
    Writing at 0x00020bb5... (60 %)
    Writing at 0x00026d8f... (80 %)
    Writing at 0x0002e60a... (100 %)
    Wrote 149424 bytes (79574 compressed) at 0x00010000 in 2.1 seconds (effective 571.7 kbit/s)...
    Hash of data verified.
    Compressed 3072 bytes to 103...
    Writing at 0x00008000... (100 %)
    Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 539.7 kbit/s)...
    Hash of data verified.

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

如果一切顺利，烧录完成后，开发板将会复位，应用程序 "hello_world" 开始运行。

如果希望使用 Eclipse 或是 VS Code IDE，而非 `idf.py`，请参考 Eclipse Plugin，以及 VSCode Extension。

## 监视输出

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

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

    $ idf.py -p <PORT> 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 <PORT> 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 esp32h2 chip with 1 CPU core(s), BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.1, 2 MB external flash
    Minimum free heap size: 268256 bytes
        Restarting in 9 seconds...
        Restarting in 8 seconds...
        Restarting in 7 seconds...

使用快捷键 `Ctrl+]`，可退出 ESP-IDF 监视器。

备注

也可以运行以下命令，一次性执行构建、烧录和监视过程：

`idf.py -p PORT flash monitor`

此外，

- 请前往 IDF 监视器，了解更多使用 ESP-IDF 监视器的快捷键和其他详情。

- 请前往 idf.py，查看更多 `idf.py` 命令和选项。

恭喜完成 ESP32-H2 的入门学习！

现在，可以尝试一些其他 examples，或者直接开发自己的应用程序。

重要

一些示例程序不支持 ESP32-H2，因为 ESP32-H2 中不包含所需的硬件。

在编译示例程序前请查看 README 文件中 `Supported Targets` 表格。如果表格中包含 ESP32-H2， 或者不存在这个表格，那么即表示 ESP32-H2 支持这个示例程序。

## 其他提示

### 权限问题

使用某些 Linux 版本向 ESP32-H2 烧录固件时，可能会出现类似 `Could not open port <PORT>: Permission denied: '<PORT>'` 错误消息。此时可以在 Linux 将用户添加至 dialout 组或 uucp 组 来解决此类问题。

### 兼容的 Python 版本

ESP-IDF 支持 Python 3.8 及以上版本，建议升级操作系统到最新版本从而更新 Python。也可选择从 sources 安装最新版 Python，或使用 Python 管理系统如 pyenv 对版本进行升级管理。

### 擦除 flash

ESP-IDF 支持擦除 flash。请运行以下命令，擦除整个 flash：

    idf.py -p PORT erase-flash

若存在需要擦除的 OTA 数据，请运行以下命令：

    idf.py -p PORT erase-otadata

擦除 flash 需要一段时间，在擦除过程中，请勿断开设备连接。

## 相关文档

想要自定义安装流程的高阶用户可参照：

- 在 Windows 环境下更新 ESP-IDF 工具

- 与 ESP32-H2 创建串口连接

- Eclipse Plugin

- VSCode Extension

- IDF 监视器

提供有关此文档的反馈