mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
b24341a664
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder; 2. Deleted get-started files, 7 documents in total, in get-started folder; 3. Updated links in get-started-cmake/index.rst and in get-started/index.rst; 4. Modified descriptions for build system in these files.
496 lines
18 KiB
ReStructuredText
496 lines
18 KiB
ReStructuredText
*******************
|
||
快速入门（CMake）
|
||
*******************
|
||
|
||
:link_to_translation:`en:[English]`
|
||
|
||
.. include:: ../cmake-warning.rst
|
||
|
||
.. include:: ../cmake-pending-features.rst
|
||
|
||
本文档旨在指导用户搭建 ESP32 硬件开发的软件环境，
|
||
|
||
通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单，并编译、下载固件至 ESP32 开发板等步骤。
|
||
|
||
.. include:: /_build/inc/version-note.inc
|
||
|
||
概述
|
||
====
|
||
|
||
ESP32 SoC 芯片支持以下功能：
|
||
|
||
* 2.4 GHz Wi-Fi
|
||
* 蓝牙 4.2 标准
|
||
* 高性能双核
|
||
* 超低功耗协处理器
|
||
* 多种外设
|
||
|
||
ESP32 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性，适用于各种应用场景和不同功耗需求。
|
||
|
||
乐鑫为用户提供完整的软、硬件资源，进行 ESP32 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。
|
||
|
||
准备工作
|
||
========
|
||
|
||
硬件：
|
||
|
||
* 一款 **ESP32** 开发板
|
||
* **USB 数据线** （USB A/Micro USB B）
|
||
* PC（Windows、Linux 或 Mac OS）
|
||
|
||
软件：
|
||
|
||
* 设置 **工具链**，用于编译 ESP32 代码；
|
||
* **编译工具** —— CMake 和 Ninja 编译工具，用于编译 ESP32 **应用程序**；
|
||
* 获取 **ESP-IDF** 软件开发框架。该框架已经基本包含 ESP32 使用的 API（软件库和源代码）和运行 **工具链** 的脚本；
|
||
* 安装 C 语言编程（**工程**）的 **文本编辑器**，例如 `Eclipse <https://www.eclipse.org/>`_。
|
||
|
||
|
||
.. figure:: ../../_static/what-you-need-cmake.png
|
||
:align: center
|
||
:alt: ESP32 应用程序开发
|
||
:figclass: align-center
|
||
|
||
ESP32 应用程序开发
|
||
|
||
|
||
开发板简介
|
||
==========
|
||
|
||
请点击下方连接，了解有关具体开发板的详细信息。
|
||
|
||
.. toctree::
|
||
:maxdepth: 1
|
||
|
||
ESP32-DevKitC <../hw-reference/get-started-devkitc>
|
||
ESP-WROVER-KIT <../hw-reference/get-started-wrover-kit>
|
||
ESP32-PICO-KIT <../hw-reference/get-started-pico-kit>
|
||
ESP32-Ethernet-Kit <../hw-reference/get-started-ethernet-kit>
|
||
|
||
|
||
.. _get-started-step-by-step-cmake:
|
||
|
||
详细安装步骤
|
||
==============
|
||
|
||
请根据下方详细步骤，完成安装过程。
|
||
|
||
设置开发环境
|
||
~~~~~~~~~~~~~~~~
|
||
|
||
* :ref:`get-started-setup-toolchain-cmake`
|
||
* :ref:`get-started-get-esp-idf-cmake`
|
||
* :ref:`get-started-setup-path-cmake`
|
||
* :ref:`get-started-get-packages-cmake`
|
||
|
||
创建您的第一个工程
|
||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
* :ref:`get-started-start-project-cmake`
|
||
* :ref:`get-started-connect-cmake`
|
||
* :ref:`get-started-configure-cmake`
|
||
* :ref:`get-started-build-cmake`
|
||
* :ref:`get-started-flash-cmake`
|
||
* :ref:`get-started-build-monitor-cmake`
|
||
|
||
|
||
.. _get-started-setup-toolchain-cmake:
|
||
|
||
第一步：设置工具链
|
||
====================
|
||
|
||
工具链指一套用于编译代码和应用程序的程序。
|
||
|
||
为了加快开发进度，您可以直接使用乐鑫提供的预制工具链。请根据您的操作系统，点击下方对应的链接，并按照链接中的指导进行安装。
|
||
|
||
.. toctree::
|
||
:hidden:
|
||
|
||
Windows <windows-setup>
|
||
Linux <linux-setup>
|
||
MacOS <macos-setup>
|
||
|
||
+-------------------+-------------------+-------------------+
|
||
| |windows-logo| | |linux-logo| | |macos-logo| |
|
||
+-------------------+-------------------+-------------------+
|
||
| `Windows`_ | `Linux`_ | `Mac OS`_ |
|
||
+-------------------+-------------------+-------------------+
|
||
|
||
.. |windows-logo| image:: ../../_static/windows-logo.png
|
||
:target: ../get-started-cmake/windows-setup.html
|
||
|
||
.. |linux-logo| image:: ../../_static/linux-logo.png
|
||
:target: ../get-started-cmake/linux-setup.html
|
||
|
||
.. |macos-logo| image:: ../../_static/macos-logo.png
|
||
:target: ../get-started-cmake/macos-setup.html
|
||
|
||
.. _Windows: ../get-started-cmake/windows-setup.html
|
||
.. _Linux: ../get-started-cmake/linux-setup.html
|
||
.. _Mac OS: ../get-started-cmake/macos-setup.html
|
||
|
||
.. note::
|
||
|
||
在本文档中，Linux 和 MacOS 操作系统中 ESP-IDF 的默认安装路径为 ``~/esp``；Windows 操作系统的默认路径为 ``%userprofile%\esp``。您也可以将 ESP-IDF 安装在任何其他路径下，但请注意在使用命令行时进行相应替换。注意，ESP-IDF 不支持带有空格的路径。
|
||
|
||
此外， 您也可以根据自身经验和实际需求，对环境进行个性化设置，而非使用预制工具链。此时，请前往 :ref:`工具链的个性化设置<get-started-customized-setup-cmake>` 章节获取更多信息。
|
||
|
||
|
||
.. _get-started-get-esp-idf-cmake:
|
||
|
||
第二步：获取 ESP-IDF
|
||
===========================
|
||
|
||
除了工具链，您还需要供 ESP32 使用的 API（软件库和源代码），具体请见 `ESP-IDF 仓库 <https://github.com/espressif/esp-idf>`_。
|
||
|
||
请将 ESP-IDF 下载到您的本地。
|
||
|
||
获取本地副本：打开终端，切换到你要存放 ESP-IDF 的工作目录，使用 ``git clone`` 命令克隆远程仓库。
|
||
|
||
Linux 和 MacOS 操作系统
|
||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
打开终端，后运行以下命令：
|
||
|
||
.. include:: /_build/inc/git-clone-bash.inc
|
||
|
||
ESP-IDF 将下载至 ``~/esp/esp-idf``。
|
||
|
||
请前往 :doc:`/versions`，查看 ESP-IDF 不同版本的具体适用场景。
|
||
|
||
Windows 操作系统
|
||
~~~~~~~~~~~~~~~~~~
|
||
|
||
.. note::
|
||
|
||
较早版本 ESP-IDF 使用了 **MSYS2 bash 终端** 命令行。目前，基于 CMake 的编译系统可使用常见的 **Windows 命令窗口**，即本指南中使用的终端。
|
||
|
||
请注意，如果您使用基于 bash 的终端或 PowerShell 终端，一些命令语法将与下面描述有所不同。
|
||
|
||
打开命令提示符，后运行以下命令：
|
||
|
||
.. include:: /_build/inc/git-clone-windows.inc
|
||
|
||
ESP-IDF 将下载至 ``%userprofile%\esp\esp-idf``。
|
||
|
||
请前往 :doc:`/versions`，查看 ESP-IDF 不同版本的具体适用场景。
|
||
|
||
.. include:: /_build/inc/git-clone-notes.inc
|
||
|
||
.. note::
|
||
|
||
在克隆远程仓库时，不要忘记加上 ``--recursive`` 选项。否则，请接着运行以下命令，获取所有子模块： ::
|
||
|
||
cd esp-idf
|
||
git submodule update --init
|
||
|
||
.. _get-started-setup-path-cmake:
|
||
|
||
第三步：设置环境变量
|
||
===========================
|
||
|
||
请在您的 PC 上设置以下环境变量，否则无法编译工程。
|
||
|
||
- ``IDF_PATH`` 应设置为 ESP-IDF 根目录的路径。
|
||
- ``PATH`` 应包括同一 ``IDF_PATH`` 目录下的 ``tools`` 目录路径。
|
||
|
||
您可以在每次重启会话时手动设置，也可以在用户配置中进行永久设置，具体请前往 :doc:`add-idf_path-to-profile` 章节，查看 :ref:`Windows <add-paths-to-profile-windows-cmake>` 、:ref:`Linux 及 MacOS <add-idf_path-to-profile-linux-macos-cmake>` 操作系统的具体设置方式。
|
||
|
||
|
||
.. _get-started-get-packages-cmake:
|
||
|
||
第四步：安装 Python 软件包
|
||
=================================
|
||
|
||
ESP-IDF 所需的 Python 软件包位于 ``IDF_PATH/requirements.txt`` 中。您可以运行以下命令进行安装： ::
|
||
|
||
python -m pip install --user -r $IDF_PATH/requirements.txt
|
||
|
||
.. note::
|
||
|
||
请注意查询您所使用的 Python 解释器的版本（运行命令 ``python --version``），并根据查询结果将上方命令中的 ``python`` 替换为 ``python2``, ``python2.7``，例如：
|
||
|
||
``python2.7 -m pip install --user -r $IDF_PATH/requirements.txt``
|
||
|
||
.. _get-started-start-project-cmake:
|
||
|
||
第五步：开始创建工程
|
||
=======================
|
||
|
||
现在，您可以开始准备开发 ESP32 应用程序了。您可以从 ESP-IDF 中 :idf:`examples` 目录下的 :example:`get-started/hello_world` 工程开始。
|
||
|
||
将 :example:`get-started/hello_world` 复制至您本地的 ``~/esp`` 目录下：
|
||
|
||
Linux 和 MacOS 操作系统
|
||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
.. code-block:: bash
|
||
|
||
cd ~/esp
|
||
cp -r $IDF_PATH/examples/get-started/hello_world .
|
||
|
||
Windows 操作系统
|
||
~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
.. code-block:: batch
|
||
|
||
cd %userprofile%\esp
|
||
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world
|
||
|
||
ESP-IDF 的 :idf:`examples` 目录下有一系列示例工程，都可以按照上面的方法进行创建。您可以按照上述方法复制并运行其中的任何示例，也可以直接编译示例，无需进行复制。
|
||
|
||
.. important::
|
||
|
||
ESP-IDF 编译系统不支持带有空格的路径。
|
||
|
||
.. _get-started-connect-cmake:
|
||
|
||
第六步：连接设备
|
||
======================
|
||
|
||
现在，请将您的 ESP32 开发板连接到 PC，并查看开发板使用的串口。
|
||
|
||
通常，串口在不同操作系统下显示的名称有所不同：
|
||
|
||
- **Windows 操作系统：** ``COM1`` 等
|
||
- **Linux 操作系统：** 以 ``/dev/tty`` 开始
|
||
- **MacOS 操作系统：** 以 ``/dev/cu.`` 开始
|
||
|
||
有关如何查看串口名称的详细信息，请见 :doc:`establish-serial-connection`。
|
||
|
||
.. note::
|
||
|
||
请记住串口名，您会在下面的步骤中用到。
|
||
|
||
|
||
.. _get-started-configure-cmake:
|
||
|
||
第七步：配置
|
||
=================
|
||
|
||
请进入 :ref:`get-started-start-project-cmake` 中提到的 ``hello_world`` 目录，并运行工程配置工具 ``menuconfig``。
|
||
|
||
Linux 和 MacOS 操作系统
|
||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
.. code-block:: bash
|
||
|
||
cd ~/esp/hello_world
|
||
idf.py menuconfig
|
||
|
||
如果您的默认 Python 版本为 3.0 以上，可能需要运行 ``python2 idf.py`` 。
|
||
|
||
Windows 操作系统
|
||
~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
.. code-block:: batch
|
||
|
||
cd %userprofile%\esp\hello_world
|
||
idf.py menuconfig
|
||
|
||
Python 2.7 安装程序将尝试配置 Windows，将 ``.py`` 文件与 Python 2 关联起来。如果其他程序（比如 Visual Studio Python 工具）曾关联了其他版本 Python，则 ``idf.py`` 可能无法正常运行（文件将在 Visual Studio 中打开）。这种情况下，您可以选择每次都运行一遍 ``C:\Python27\python idf.py``，或更改 Windows 的 ``.py`` 关联文件设置。
|
||
|
||
.. note::
|
||
|
||
如果出现 ``idf.py not found（无法找到 idf.py）`` 错误，请确保 ``PATH`` 环境变量设置无误，具体请参考 :ref:`get-started-setup-path-cmake`。如果 ``tools`` 目录下没有 ``idf.py`` 文件，请确保 CMake 预览的分支正确无误，具体请参考 :ref:`get-started-get-esp-idf-cmake`。
|
||
|
||
如果之前的步骤都正确，则会显示下面的菜单：
|
||
|
||
.. figure:: ../../_static/project-configuration.png
|
||
:align: center
|
||
:alt: 工程配置 — 主窗口
|
||
:figclass: align-center
|
||
|
||
工程配置 — 主窗口
|
||
|
||
``menuconfig`` 工具的常见操作见下。
|
||
|
||
* ``上下箭头``：移动
|
||
* ``回车``：进入子菜单
|
||
* ``ESC 键``：返回上级菜单或退出
|
||
* ``英文问号``：调出帮助菜单（退出帮助菜单，请按回车键）。
|
||
* ``空格``、``Y 键``或``N 键``：使能/禁用 ``[*]`` 配置选项
|
||
* ``英文问号``：调出有关高亮选项的帮助菜单
|
||
* ``/ 键``：寻找配置项目
|
||
|
||
.. attention::
|
||
|
||
如果您使用的是 ESP32-DevKitC（板载 ESP32-SOLO-1 模组），请在烧写示例程序前，前往 ``menuconfig`` 中使能单核模式（:ref:`CONFIG_FREERTOS_UNICORE`）。
|
||
|
||
.. _get-started-build-cmake:
|
||
|
||
第八步：编译工程
|
||
==================
|
||
|
||
请使用以下命令，编译烧录工程：::
|
||
|
||
idf.py build
|
||
|
||
运行以上命令可以编译应用程序和所有 ESP-IDF 组件，接着生成 bootloader、分区表和应用程序二进制文件。
|
||
|
||
.. code-block:: none
|
||
|
||
$ 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 文件。
|
||
|
||
|
||
.. _get-started-flash-cmake:
|
||
|
||
第九步：烧录到设备
|
||
====================
|
||
|
||
请使用以下命令，将刚刚生成的二进制文件烧录至您的 ESP32 开发板： ::
|
||
|
||
idf.py -p PORT [-b BAUD] flash
|
||
|
||
请将 PORT 替换为 ESP32 开发板的串口名称，具体可见 :ref:`get-started-connect-cmake`。
|
||
|
||
您还可以将 BAUD 替换为您希望的烧录波特率。默认波特率为 ``460800``。
|
||
|
||
更多有关 idf.py 参数的详情，请见 :ref:`idf.py`。
|
||
|
||
.. note::
|
||
|
||
勾选 ``flash`` 选项将自动编译并烧录工程，因此无需再运行 ``idf.py build``。
|
||
|
||
.. code-block:: none
|
||
|
||
Running esptool.py in directory [...]/esp/hello_world
|
||
Executing "python [...]/esp-idf/components/esptool_py/esptool/esptool.py -b 460800 write_flash @flash_project_args"...
|
||
esptool.py -b 460800 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x1000 bootloader/bootloader.bin 0x8000 partition_table/partition-table.bin 0x10000 hello-world.bin
|
||
esptool.py v2.3.1
|
||
Connecting....
|
||
Detecting chip type... ESP32
|
||
Chip is ESP32D0WDQ6 (revision 1)
|
||
Features: WiFi, BT, Dual Core
|
||
Uploading stub...
|
||
Running stub...
|
||
Stub running...
|
||
Changing baud rate to 460800
|
||
Changed.
|
||
Configuring flash size...
|
||
Auto-detected Flash size: 4MB
|
||
Flash params set to 0x0220
|
||
Compressed 22992 bytes to 13019...
|
||
Wrote 22992 bytes (13019 compressed) at 0x00001000 in 0.3 seconds (effective 558.9 kbit/s)...
|
||
Hash of data verified.
|
||
Compressed 3072 bytes to 82...
|
||
Wrote 3072 bytes (82 compressed) at 0x00008000 in 0.0 seconds (effective 5789.3 kbit/s)...
|
||
Hash of data verified.
|
||
Compressed 136672 bytes to 67544...
|
||
Wrote 136672 bytes (67544 compressed) at 0x00010000 in 1.9 seconds (effective 567.5 kbit/s)...
|
||
Hash of data verified.
|
||
|
||
Leaving...
|
||
Hard resetting via RTS pin...
|
||
|
||
如果一切顺利，烧录完成后，开发板将会复位，应用程序 "hello_world" 开始运行。
|
||
|
||
.. note::
|
||
|
||
（目前不支持）如果您希望使用 Eclipse IDE，而非 ``idf.py``，请参考 :doc:`Eclipse 指南 <eclipse-setup>`。
|
||
|
||
|
||
.. _get-started-build-monitor-cmake:
|
||
|
||
第十步：监视器
|
||
==================
|
||
|
||
您可以使用 ``make monitor`` 命令，监视 “hello_world” 的运行情况。注意，不要忘记将 PORT 替换为您的串口名称。
|
||
|
||
运行该命令后，:doc:`IDF 监视器 <../api-guides/tools/idf-monitor>` 应用程序将启动： ::
|
||
|
||
$ 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!” 了。
|
||
|
||
.. code-block:: none
|
||
|
||
...
|
||
Hello world!
|
||
Restarting in 10 seconds...
|
||
I (211) cpu_start: Starting scheduler on APP CPU.
|
||
Restarting in 9 seconds...
|
||
Restarting in 8 seconds...
|
||
Restarting in 7 seconds...
|
||
|
||
您可使用快捷键 ``Ctrl+]``，退出 IDF 监视器。
|
||
|
||
如果 IDF 监视器在烧录后很快发生错误，或打印信息全是乱码（见下），很有可能是因为您的开发板选用了 26 MHz 晶振，而 ESP-IDF 默认支持大多数开发板使用的 40 MHz 晶振。
|
||
|
||
.. code-block:: none
|
||
|
||
e<><65><EFBFBD>)(Xn@<40>y.!<21><>(<28>PW+)<29><>Hn9a/9<>!<21>t5<74><35>P<EFBFBD>~<7E>k<EFBFBD><6B>e<EFBFBD>ea<65>5<EFBFBD>jA
|
||
~zY<7A><59>Y(1<>,1<15><> e<><65><EFBFBD>)(Xn@<40>y.!Dr<44>zY(<28>jpi<70>|<7C>+z5Ymvp
|
||
|
||
此时，请您：
|
||
|
||
1. 退出监视器。
|
||
2. 打开 :ref:`menuconfig <get-started-configure-cmake>`，
|
||
3. 进入 ``Component config`` --> ``ESP32-specific`` --> ``Main XTAL frequency`` 进行配置，将 :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` 设置为 26 MHz。
|
||
4. 然后，请重新 :ref:`编译和烧录 <get-started-flash-cmake>` 应用程序。
|
||
|
||
.. note::
|
||
|
||
您也可以运行以下命令，一次性执行构建、烧录和监视过程：
|
||
|
||
``idf.py -p PORT flash monitor``
|
||
|
||
此外，
|
||
|
||
- 请前往 :doc:`IDF 监视器 <../api-guides/tools/idf-monitor>`，了解更多使用 IDF 监视器的快捷键和其他详情。
|
||
- 请前往 :ref:`idf.py`，查看更多 ``idf.py`` 命令和选项。
|
||
|
||
**恭喜，您已完成 ESP32 的入门学习！**
|
||
|
||
现在，您可以尝试一些其他 :idf:`examples`，或者直接开发自己的应用程序。
|
||
|
||
更新 ESP-IDF
|
||
=================
|
||
|
||
乐鑫会不时推出更新版本的 ESP-IDF，修复 bug 或提出新的特性。因此，您在使用时，也应注意更新您本地的版本。最简单的方法是：直接删除您本地的 ``esp-idf`` 文件夹，然后按照 :ref:`get-started-get-esp-idf-cmake` 中的指示，重新完成克隆。
|
||
|
||
如果您希望将 ESP-IDF 克隆到新的路径下，请务必 :doc:`重新设置 IDF_PATH <add-idf_path-to-profile>`。否则，工具链将无法找到 ESP-IDF。
|
||
|
||
此外，您可以仅更新变更部分。具体方式，请前往 :ref:`更新 <updating>` 章节查看。
|
||
|
||
相关文档
|
||
===========
|
||
|
||
.. toctree::
|
||
:maxdepth: 1
|
||
|
||
add-idf_path-to-profile
|
||
establish-serial-connection
|
||
eclipse-setup
|
||
../api-guides/tools/idf-monitor
|
||
toolchain-setup-scratch
|
||
|
||
.. _Stable version: https://docs.espressif.com/projects/esp-idf/zh_CN/stable/
|
||
.. _Releases page: https://github.com/espressif/esp-idf/releases |