1*************************** 2快速入门（传统 GNU Make） 3*************************** 4 5:link_to_translation:`en:[English]` 6 7.. include:: ../gnu-make-legacy.rst 8 9本文档旨在指导用户搭建 ESP32 硬件开发的软件环境，通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单，并编译、下载固件至 ESP32 开发板等步骤。 10 11 12 13.. include-build-file:: inc/version-note.inc 14 15概述 16==== 17 18ESP32 SoC 芯片支持以下功能： 19 20* 2.4 GHz Wi-Fi 21* 蓝牙 22* 高性能双核 23* 超低功耗协处理器 24* 多种外设 25 26ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。 27 28乐鑫为用户提供完整的软、硬件资源，进行 ESP32 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。 29 30准备工作 31======== 32 33硬件： 34 35* 一款 **ESP32** 开发板 36* **USB 数据线** (A 转 Micro-B) 37* PC（Windows、Linux 或 macOS） 38 39软件： 40 41* 设置 **工具链**，用于编译 ESP32 **应用程序**; 42* 获取 **ESP-IDF** 软件开发框架。该框架已经基本包含 ESP32 使用的 API（软件库和源代码）和运行 **工具链** 的脚本; 43* 安装 C 语言编程（**工程**）的 **文本编辑器**，例如 `Eclipse <https://www.eclipse.org/>`_。 44 45开发板简介 46========== 47 48请点击下方连接，了解有关具体开发板的详细信息。 49 50.. toctree:: 51 :maxdepth: 1 52 53 ESP32-DevKitC <../hw-reference/esp32/get-started-devkitc> 54 ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit> 55 ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit> 56 ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit> 57 ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1> 58.. _get-started-step-by-step-legacy: 59 60详细安装步骤 61============ 62 63请根据下方详细步骤，完成安装过程。 64 65设置开发环境 66~~~~~~~~~~~~ 67 68* :doc:`Windows <windows-setup>`、:doc:`Linux <linux-setup>` 和 :doc:`macOS <macos-setup>` 的 :ref:`get-started-setup-toolchain-legacy` 69* :ref:`get-started-get-esp-idf-legacy` 70* :ref:`get-started-setup-path-legacy` 71* :ref:`get-started-get-packages-legacy` 72 73创建您的第一个工程 74~~~~~~~~~~~~~~~~~~ 75 76* :ref:`get-started-start-project-legacy` 77* :ref:`get-started-connect-legacy` 78* :ref:`get-started-configure-legacy` 79* :ref:`get-started-build-and-flash-legacy` 80* :ref:`get-started-monitor-legacy` 81 82 83.. _get-started-setup-toolchain-legacy: 84 85第一步：设置工具链 86================== 87 88工具链指一套用于编译代码和应用程序的程序。 89 90为了加快开发进度，您可以直接使用乐鑫提供的预制工具链。请根据您的操作系点击对应的链接，并按照链接中的指导进行安装。 91 92.. toctree:: 93 :hidden: 94 95 Windows <windows-setup> 96 Linux <linux-setup> 97 macOS <macos-setup> 98 99+-----------------+---------------+---------------+ 100| |windows-logo| | |linux-logo| | |macos-logo| | 101+-----------------+---------------+---------------+ 102| Windows_ | Linux_ | `macOS`_ | 103+-----------------+---------------+---------------+ 104 105.. |windows-logo| image:: ../../_static/windows-logo.png 106 :target: ../get-started-legacy/windows-setup.html 107 108.. |linux-logo| image:: ../../_static/linux-logo.png 109 :target: ../get-started-legacy/linux-setup.html 110 111.. |macos-logo| image:: ../../_static/macos-logo.png 112 :target: ../get-started-legacy/macos-setup.html 113 114.. _Windows: ../get-started-legacy/windows-setup.html 115.. _Linux: ../get-started-legacy/linux-setup.html 116.. _macOS: ../get-started-legacy/macos-setup.html 117 118.. note:: 119 120 在本文档中，Linux 和 macOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``；Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下，但请注意在使用命令行时进行相应替换。注意，ESP-IDF 不支持带有空格的路径。 121 122此外， 您也可以根据自身经验和实际需求，对环境进行个性化设置，而非使用预制工具链。此时，请前往 :ref:`get-started-customized-setup-legacy` 章节获取更多信息。 123 124 125.. _get-started-get-esp-idf-legacy: 126 127第二步：获取 ESP-IDF 128===================== 129 130除了工具链，您还需要供 ESP32 使用的 API（软件库和源代码），具体请见 `ESP-IDF 仓库 <https://github.com/espressif/esp-idf>`_。 131 132获取本地副本：打开终端，切换到你要存放 ESP-IDF 的工作目录，使用 ``git clone`` 命令克隆远程仓库。 133 134打开终端，后运行以下命令： 135 136.. include-build-file:: inc/git-clone-bash.inc 137 138ESP-IDF 将下载至 ``~/esp/esp-idf``。 139 140请前往 :doc:`/versions`，查看 ESP-IDF 不同版本的具体适用场景。 141 142.. include-build-file:: inc/git-clone-notes.inc 143 144.. note:: 145 146 在克隆远程仓库时，不要忘记加上 ``--recursive`` 选项。否则，请接着运行以下命令，获取所有子模块:: 147 148 cd esp-idf 149 git submodule update --init 150 151 152.. _get-started-setup-path-legacy: 153 154第三步：设置环境变量 155======================= 156 157工具链通过环境变量 ``IDF_PATH`` 获得 ESP-IDF 的目录。因此，您需要在 PC 中设置该环境变量，否则无法编译工程。 158 159您可以在每次重启会话时手动设置，也可以在用户配置中进行永久设置，具体请前往 :doc:`add-idf_path-to-profile` 章节，查看 :ref:`Windows <add-idf_path-to-profile-windows-legacy>` 、:ref:`Linux 及 MacOS <add-idf_path-to-profile-linux-macos-legacy>` 操作系统的具体设置方式。 160 161 162.. _get-started-get-packages-legacy: 163 164第四步：安装 Python 软件包 165========================== 166 167ESP-IDF 所需的 Python 软件包位于 ``IDF_PATH/requirements.txt`` 中。您可以运行以下命令进行安装:: 168 169 python -m pip install --user -r $IDF_PATH/requirements.txt 170 171.. note:: 172 173 请注意查询您所使用的 Python 解释器的版本（运行命令 ``python --version``），并根据查询结果将上方命令中的 ``python`` 替换为 ``python3``, ``python3.7``，例如:: 174 175 python3 -m pip install --user -r $IDF_PATH/requirements.txt 176 177 178.. _get-started-start-project-legacy: 179 180 181 182第五步：开始创建工程 183===================== 184 185现在，您可以开始准备开发 ESP32 应用程序了。您可以从 ESP-IDF 中 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程开始。 186 187将 :example:`get-started/hello_world` 复制至您本地的 ``~/esp`` 目录下： 188 189Linux 和 macOS 操作系统 190~~~~~~~~~~~~~~~~~~~~~~~~ 191 192.. code-block:: bash 193 194 cd ~/esp 195 cp -r $IDF_PATH/examples/get-started/hello_world . 196 197Windows 操作系统 198~~~~~~~~~~~~~~~~~~ 199 200.. code-block:: batch 201 202 cd %userprofile%\esp 203 xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world 204 205ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照上面的方法进行创建。您可以按照上述方法复制并运行其中的任何示例，也可以直接编译示例，无需进行复制。 206 207.. important:: 208 209 ESP-IDF 编译系统不支持带有空格的路径。 210 211 212 213.. _get-started-connect-legacy: 214 215第六步：连接设备 216=================== 217 218现在，请将您的 ESP32 开发板连接到 PC，并查看开发板使用的串口。 219 220通常，串口在不同操作系统下显示的名称有所不同： 221 222- **Windows 操作系统：** ``COM1`` 等 223- **Linux 操作系统：** 以 ``/dev/tty`` 开始 224- **macOS 操作系统：** 以 ``/dev/cu.`` 开始 225 226有关如何查看串口名称的详细信息，请见 :doc:`establish-serial-connection`。 227 228.. note:: 229 230 请记住串口名，您会在下面的步骤中用到。 231 232 233.. _get-started-configure-legacy: 234 235第七步：配置 236============= 237 238请进入 :ref:`get-started-start-project-legacy` 中提到的 ``hello_world`` 目录，并运行工程配置工具 ``menuconfig``。 239 240Linux 和 macOS 操作系统 241~~~~~~~~~~~~~~~~~~~~~~~~~ 242 243.. code-block:: bash 244 245 cd ~/esp/hello_world 246 make menuconfig 247 248Windows 操作系统 249~~~~~~~~~~~~~~~~~~~ 250 251.. code-block:: batch 252 253 cd %userprofile%\esp\hello_world 254 make menuconfig 255 256如果之前的步骤都正确，则会显示下面的菜单： 257 258.. figure:: ../../_static/project-configuration.png 259 :align: center 260 :alt: 工程配置 — 主窗口 261 :figclass: align-center 262 263 工程配置 — 主窗口 264 265进入菜单后，选择 ``Serial flasher config`` > ``Default serial port`` 配置串口（设备将通过该串口加载工程）。按回车键确认选择，点击 ``< Save >`` 保存配置，然后点击 ``< Exit >`` 退出 ``menuconfig``。 266 267``menuconfig`` 工具的常见操作见下。 268 269* 上下箭头：移动 270* ``回车``：进入子菜单 271* ``ESC 键``：返回上级菜单或退出 272* ``英文问号``：调出帮助菜单（退出帮助菜单，请按回车键）。 273* ``空格``或 ``Y 键``：选择 ``[*]`` 配置选项；``N 键``：禁用 ``[*]`` 配置选项 274* ``英文问号`` （查询配置选项）：调出有关该选项的帮助菜单 275* ``/ 键``：寻找配置工程 276 277.. attention:: 278 279 如果您使用的是 ESP32-DevKitC（板载 ESP32-SOLO-1 模组），请在烧写示例程序前，前往 ``menuconfig`` 中使能单核模式（:ref:`CONFIG_FREERTOS_UNICORE`）。 280 281.. _get-started-build-and-flash-legacy: 282 283第八步：编译和烧录 284==================== 285 286请使用以下命令，编译烧录工程:: 287 288 make flash 289 290运行以上命令可以编译应用程序和所有 ESP-IDF 组件，接着生成 bootloader、分区表和应用程序二进制文件。接着，这些二进制文件将被烧录至 ESP32 开发板。 291 292 293烧录过程中可能遇到的问题 294~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 295 296如果在运行给定命令时出现如“连接失败”这样的错误，原因之一则可能是运行 ``esptool.py`` 出现错误。``esptool.py`` 是构建系统调用的程序，用于重置芯片、与 ROM 引导加载器交互以及烧录固件的工具。解决该问题的一个简单的方法就是按照以下步骤进行手动复位。如果问题仍未解决，请参考 `Troubleshooting <https://github.com/espressif/esptool#bootloader-wont-respond>`_ 获取更多信息。 297 298``esptool.py`` 通过使 USB 转串口转接器芯片（如 FTDI 或 CP210x）的 DTR 和 RTS 控制线生效来自动复位 {IDF_TARGET_NAME}（请参考 :doc:`establish-serial-connection` 获取更多详细信息)。DTR 和 RTS 控制线又连接到 {IDF_TARGET_NAME} 的 ``GPIO0`` 和 ``CHIP_PU`` (EN) 管脚上，因此 DTR 和 RTS 的电压电平变化会使 {IDF_TARGET_NAME} 进入固件下载模式。相关示例可查看 ESP32 DevKitC 开发板的 `原理图 <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf>`_。 299 300一般来说，使用官方的 esp-idf 开发板不会出现问题。但是，``esptool.py`` 在以下情况下不能自动重置硬件。 301 302- 您的硬件没有连接到 ``GPIO0`` 和 ``CIHP_PU`` 的 DTR 和 RTS 控制线 303- DTR 和 RTS 控制线的配置方式不同 304- 根本没有这样的串行控制线路 305 306根据您硬件的种类，也可以将您 {IDF_TARGET_NAME} 开发板手动设置成固件下载模式（复位）。 307 308- 对于 Espressif 的开发板，您可以参考对应开发板的入门指南或用户指南。例如，可以通过按住 **Boot** 按钮 (``GPIO0``) 再按住 **EN** 按钮(``CHIP_PU``) 来手动复位 esp-idf 开发板。 309- 对于其他类型的硬件，可以尝试将 ``GPIO0`` 拉低。 310 311 312常规操作 313~~~~~~~~~~~~~~~~ 314 315如果一切顺利，您可在烧录完成后看到类似下方的打印信息。接着，开发板将会复位，应用程序 "hello_world" 开始启动。 316 317.. code-block:: bash 318 319 esptool.py v3.0-dev 320 Flashing binaries to serial port /dev/ttyUSB0 (app at offset 0x10000)... 321 esptool.py v3.0-dev 322 Serial port /dev/cu.SLAB_USBtoUART 323 Connecting........____ 324 Chip is ESP32D0WDQ6 (revision 1) 325 Features: WiFi, BT, Dual Core, Coding Scheme None 326 Crystal is 40MHz 327 MAC: 30:ae:a4:15:21:b4 328 Uploading stub... 329 Running stub... 330 Stub running... 331 Configuring flash size... 332 Auto-detected Flash size: 4MB 333 Flash params set to 0x0220 334 Compressed 26704 bytes to 15930... 335 Wrote 26704 bytes (15930 compressed) at 0x00001000 in 1.4 seconds (effective 151.9 kbit/s)... 336 Hash of data verified. 337 Compressed 147984 bytes to 77738... 338 Wrote 147984 bytes (77738 compressed) at 0x00010000 in 6.9 seconds (effective 172.7 kbit/s)... 339 Hash of data verified. 340 Compressed 3072 bytes to 103... 341 Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 1607.9 kbit/s)... 342 Hash of data verified. 343 344 Leaving... 345 Hard resetting via RTS pin... 346 347 348如果您希望使用 Eclipse IDE，而非 ``make`` 编译系统，请参考 :doc:`Eclipse guide <eclipse-setup>`。 349 350 351.. _get-started-monitor-legacy: 352 353第九步：监视器 354=============== 355 356您可以使用 ``make monitor`` 命令，监视 “hello_world” 的运行情况。 357 358运行该命令后，:doc:`IDF 监视器 <../api-guides/tools/idf-monitor>` 应用程序将启动:: 359 360 $ make monitor 361 MONITOR 362 --- idf_monitor on /dev/ttyUSB0 115200 --- 363 --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H --- 364 ets Jun 8 2016 00:22:57 365 366 rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT) 367 ets Jun 8 2016 00:22:57 368 ... 369 370此时，您就可以在启动日志和诊断日志之后，看到打印的 “Hello world!” 了。 371 372.. code-block:: bash 373 374 ... 375 Hello world! 376 This is esp32 chip with 2 CPU cores, WiFi/BT/BLE, silicon revision 1, 4MB external flash 377 Restarting in 10 seconds... 378 Restarting in 9 seconds... 379 Restarting in 8 seconds... 380 Restarting in 7 seconds... 381 382您可使用快捷键 ``Ctrl+]``，退出 IDF 监视器。 383 384如果 IDF 监视器在烧录后很快发生错误，或打印信息全是乱码（见下），很有可能是因为您的开发板采用了 26 MHz 晶振，而 ESP-IDF 默认支持大多数开发板使用的 40 MHz 晶振。 385 386.. figure:: ../../_static/get-started-garbled-output.png 387 :align: center 388 :alt: 乱码输出 389 :figclass: align-center 390 391此时，请您： 392 3931. 退出监视器。 3942. 打开 :ref:`menuconfig <get-started-configure-legacy>`， 3953. 进入 ``Component config`` --> ``ESP32-specific`` --> ``Main XTAL frequency`` 进行配置，将 :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` 设置为 26 MHz。 3964. 然后，请重新 :ref:`编译和烧录 <get-started-build-and-flash-legacy>` 应用程序。 397 398.. note:: 399 400 您也可以运行以下命令，一次性执行构建、烧录和监视过程:: 401 402 make flash monitor 403 404此外，请前往 :doc:`IDF 监视器 <../api-guides/tools/idf-monitor>`，了解更多使用 IDF 监视器的快捷键和其他详情。 405 406**恭喜，您已完成 ESP32 的入门学习！** 407 408现在，您可以尝试一些其他 :idf:`examples`，或者直接开发自己的应用程序。 409 410 411环境变量 412======== 413 414用户可以在使用 ``make`` 命令时 **直接设置** 部分环境变量，而无需进入 ``make menuconfig`` 进行重新配置。这些变量包括： 415 416 417.. list-table:: 418 :widths: 25 75 419 :header-rows: 1 420 421 * - 变量 422 - 描述与使用方式 423 * - ``ESPPORT`` 424 - 覆盖 ``flash`` 和 ``monitor`` 命令使用的串口。例：``make flash ESPPORT=/dev/ttyUSB1``, ``make monitor ESPPORT=COM1`` 425 * - ``ESPBAUD`` 426 - 覆盖烧录 ESP32 时使用的串口速率。例：``make flash ESPBAUD=9600`` 427 * - ``MONITORBAUD`` 428 - 覆盖监控时使用的串口速率。例：``make monitor MONITORBAUD=9600`` 429 430 431.. note:: 432 433 您可导出环境变量（例：``export ESPPORT=/dev/ttyUSB1``）。在同一会话窗口中，如果未被同步覆盖，所有 ``make`` 命令均会使用导出的环境变量值。 434 435 436 437更新 ESP-IDF 438============= 439 440乐鑫会不时推出更新版本的 ESP-IDF，修复 bug 或推出新的特性。因此，您在使用时，也应注意更新您本地的版本。最简单的方法是：直接删除您本地的 ``esp-idf`` 文件夹，然后按照 :ref:`get-started-get-esp-idf-legacy` 中的指示，重新完成克隆。 441 442如果您希望将 ESP-IDF 克隆到新的路径下，请务必 :doc:`重新设置 IDF_PATH <add-idf_path-to-profile>`。否则，工具链将无法找到 ESP-IDF。 443 444此外，您可以仅更新变更部分。具体方式，请前往 :ref:`更新 <updating>` 章节查看。 445 446相关文档 447======== 448 449.. toctree:: 450 :maxdepth: 1 451 452 add-idf_path-to-profile 453 establish-serial-connection 454 make-project 455 eclipse-setup 456 ../api-guides/tools/idf-monitor 457 toolchain-setup-scratch 458 459.. Note: These two targets may be used from git-clone-notes.inc depending on version, don't remove 460.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/ 461.. _Releases page: https://github.com/espressif/esp-idf/releases 462
