2019-10-10 04:52:07 -04:00
|
|
|
|
***********
|
|
|
|
|
快速入门
|
|
|
|
|
***********
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
|
|
|
|
:link_to_translation:`en:[English]`
|
|
|
|
|
|
2020-12-03 02:26:17 -05:00
|
|
|
|
.. 请保证 README.md 文件与该文件保持同步
|
|
|
|
|
|
2019-12-10 01:55:35 -05:00
|
|
|
|
本文档旨在指导用户搭建 {IDF_TARGET_NAME} 硬件开发的软件环境,通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单,并编译、下载固件至 {IDF_TARGET_NAME} 开发板等步骤。
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2019-11-12 22:46:16 -05:00
|
|
|
|
.. include-build-file:: inc/version-note.inc
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
|
|
|
|
概述
|
2019-10-10 04:52:07 -04:00
|
|
|
|
============
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2021-07-22 03:54:47 -04:00
|
|
|
|
{IDF_TARGET_NAME} SoC 芯片支持以下功能:
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2021-07-22 03:54:47 -04:00
|
|
|
|
.. only:: esp32
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2019-12-10 01:55:35 -05:00
|
|
|
|
* 2.4 GHz Wi-Fi
|
2020-11-25 01:45:26 -05:00
|
|
|
|
* 蓝牙
|
2021-02-01 20:19:58 -05:00
|
|
|
|
* 高性能 Xtensa® 32 位 LX6 双核处理器
|
2019-12-10 01:55:35 -05:00
|
|
|
|
* 超低功耗协处理器
|
|
|
|
|
* 多种外设
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2020-12-03 02:26:17 -05:00
|
|
|
|
.. only:: esp32s2
|
2019-12-10 01:55:35 -05:00
|
|
|
|
|
|
|
|
|
* 2.4 GHz Wi-Fi
|
2021-02-01 20:19:58 -05:00
|
|
|
|
* 高性能 Xtensa® 32 位 LX7 单核处理器
|
2020-11-25 01:45:26 -05:00
|
|
|
|
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
|
2019-12-10 01:55:35 -05:00
|
|
|
|
* 多种外设
|
2020-11-25 01:45:26 -05:00
|
|
|
|
* 内置安全硬件
|
|
|
|
|
* USB OTG 接口
|
2019-12-10 01:55:35 -05:00
|
|
|
|
|
2021-06-30 06:05:36 -04:00
|
|
|
|
.. only:: esp32s3
|
|
|
|
|
|
|
|
|
|
* 2.4 GHz Wi-Fi
|
|
|
|
|
* 低功耗蓝牙
|
|
|
|
|
* 高性能 Xtensa® 32 位 LX7 双核处理器
|
|
|
|
|
* 运行 RISC-V 或 FSM 内核的超低功耗协处理器
|
|
|
|
|
* 多种外设
|
|
|
|
|
* 内置安全硬件
|
|
|
|
|
* USB OTG 接口
|
|
|
|
|
* USB 串口/JTAG 控制器
|
|
|
|
|
|
2021-02-01 20:19:58 -05:00
|
|
|
|
.. only:: esp32c3
|
|
|
|
|
|
|
|
|
|
* 2.4 GHz Wi-Fi
|
2021-06-30 06:05:36 -04:00
|
|
|
|
* 低功耗蓝牙
|
2021-02-01 20:19:58 -05:00
|
|
|
|
* 高性能 32 位 RISC-V 单核处理器
|
|
|
|
|
* 多种外设
|
|
|
|
|
* 内置安全硬件
|
|
|
|
|
|
2022-05-19 11:22:24 -04:00
|
|
|
|
.. only:: esp32c2
|
|
|
|
|
|
|
|
|
|
* 2.4 GHz Wi-Fi
|
|
|
|
|
* 低功耗蓝牙
|
|
|
|
|
* 高性能 32 位 RISC-V 单核处理器
|
|
|
|
|
* 多种外设
|
|
|
|
|
* 适用于较简单、大批量生产的物联网应用
|
|
|
|
|
|
2021-07-22 03:54:47 -04:00
|
|
|
|
{IDF_TARGET_NAME} 采用 40 nm 工艺制成,具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性,适用于各种应用场景和不同功耗需求。
|
|
|
|
|
|
|
|
|
|
乐鑫为用户提供完整的软、硬件资源,进行 {IDF_TARGET_NAME} 硬件设备的开发。其中,乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用,可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。
|
|
|
|
|
|
2019-07-23 05:45:41 -04:00
|
|
|
|
准备工作
|
2019-10-10 04:52:07 -04:00
|
|
|
|
=============
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
|
|
|
|
硬件:
|
2022-01-15 07:29:02 -05:00
|
|
|
|
~~~~~~~~~~~~~~~~
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2019-12-10 01:55:35 -05:00
|
|
|
|
* 一款 **{IDF_TARGET_NAME}** 开发板
|
2019-10-10 04:52:07 -04:00
|
|
|
|
* **USB 数据线** (A 转 Micro-B)
|
2022-01-15 07:29:02 -05:00
|
|
|
|
* 电脑(Windows、Linux 或 macOS)
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
.. note:: 目前一些开发板使用的是 USB Type C 接口。请确保使用合适的数据线来连接开发板!
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
以下是 {IDF_TARGET_NAME} 官方开发板,点击链接可了解更多硬件信息。
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2019-12-10 01:55:35 -05:00
|
|
|
|
.. only:: esp32
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2019-12-11 02:45:30 -05:00
|
|
|
|
ESP32-DevKitC <../hw-reference/esp32/get-started-devkitc>
|
|
|
|
|
ESP-WROVER-KIT <../hw-reference/esp32/get-started-wrover-kit>
|
|
|
|
|
ESP32-PICO-KIT <../hw-reference/esp32/get-started-pico-kit>
|
|
|
|
|
ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit>
|
2020-03-10 18:43:31 -04:00
|
|
|
|
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
|
2020-10-13 01:33:43 -04:00
|
|
|
|
ESP32-PICO-KIT-1 <../hw-reference/esp32/get-started-pico-kit-1>
|
2020-10-13 22:21:25 -04:00
|
|
|
|
ESP32-PICO-DevKitM-2 <../hw-reference/esp32/get-started-pico-devkitm-2>
|
2021-01-04 23:32:08 -05:00
|
|
|
|
ESP32-DevKitM-1 <../hw-reference/esp32/user-guide-devkitm-1>
|
2020-11-25 01:45:26 -05:00
|
|
|
|
|
2020-03-26 06:40:05 -04:00
|
|
|
|
.. only:: esp32s2
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2020-10-13 01:33:43 -04:00
|
|
|
|
|
2020-03-26 06:40:05 -04:00
|
|
|
|
ESP32-S2-Saola-1 <../hw-reference/esp32s2/user-guide-saola-1-v1.2>
|
2020-10-12 06:03:51 -04:00
|
|
|
|
ESP32-S2-DevKitM-1(U) <../hw-reference/esp32s2/user-guide-devkitm-1-v1>
|
2021-07-22 07:50:53 -04:00
|
|
|
|
ESP32-S2-DevKitC-1 <../hw-reference/esp32s2/user-guide-s2-devkitc-1>
|
2020-05-08 08:27:34 -04:00
|
|
|
|
ESP32-S2-Kaluga-Kit <../hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit>
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2021-02-01 20:19:58 -05:00
|
|
|
|
.. only:: esp32c3
|
|
|
|
|
|
2021-02-04 23:00:40 -05:00
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2021-02-01 20:19:58 -05:00
|
|
|
|
|
2021-02-04 23:00:40 -05:00
|
|
|
|
ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1>
|
2021-03-10 06:39:55 -05:00
|
|
|
|
ESP32-C3-DevKitC-02 <../hw-reference/esp32c3/user-guide-devkitc-02>
|
2021-02-01 20:19:58 -05:00
|
|
|
|
|
2021-06-30 06:05:36 -04:00
|
|
|
|
|
2021-06-22 04:55:32 -04:00
|
|
|
|
.. only:: esp32s3
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
ESP32-S3-DevKitC-1 <../hw-reference/esp32s3/user-guide-devkitc-1>
|
2021-11-17 06:13:34 -05:00
|
|
|
|
ESP32-S3-DevKitM-1 <../hw-reference/esp32s3/user-guide-devkitm-1>
|
2021-06-22 04:55:32 -04:00
|
|
|
|
|
2022-05-19 11:22:24 -04:00
|
|
|
|
.. only:: esp32c2
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
ESP8684-DevKitM-1 <https://docs.espressif.com/projects/espressif-esp-dev-kits/zh_CN/latest/esp8684/esp8684-devkitm-1/index.html>
|
|
|
|
|
|
2019-10-10 04:52:07 -04:00
|
|
|
|
.. _get-started-get-prerequisites:
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
软件:
|
|
|
|
|
~~~~~~~~
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
如需在 **{IDF_TARGET_NAME}** 上使用 ESP-IDF,请安装以下软件:
|
2020-02-18 06:06:27 -05:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
* 设置 **工具链**,用于编译 {IDF_TARGET_NAME} 代码;
|
|
|
|
|
* **编译构建工具** —— CMake 和 Ninja 编译构建工具,用于编译 {IDF_TARGET_NAME} **应用程序**;
|
|
|
|
|
* 获取 **ESP-IDF** 软件开发框架。该框架已经基本包含 {IDF_TARGET_NAME} 使用的 API(软件库和源代码)和运行 **工具链** 的脚本;
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
.. figure:: ../../_static/what-you-need.png
|
2019-07-23 05:45:41 -04:00
|
|
|
|
:align: center
|
2022-01-15 07:29:02 -05:00
|
|
|
|
:alt: Development of applications for {IDF_TARGET_NAME}
|
2019-07-23 05:45:41 -04:00
|
|
|
|
:figclass: align-center
|
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
.. _get-started-step-by-step:
|
|
|
|
|
.. _get-started-how-to-get-esp-idf:
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
安装
|
|
|
|
|
============
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
我们提供以下方法帮助安装所有需要的软件,可根据需要选择其中之一。
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
IDE
|
|
|
|
|
~~~~~~
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
.. note:: 建议您通过自己喜欢的集成开发环境 (IDE) 安装 ESP-IDF。
|
2020-11-25 01:45:26 -05:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2020-11-25 01:45:26 -05:00
|
|
|
|
|
2022-04-15 10:26:21 -04:00
|
|
|
|
Eclipse Plugin <eclipse-setup>
|
|
|
|
|
VSCode Extension <vscode-setup>
|
2020-11-25 01:45:26 -05:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
手动安装
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~
|
2020-11-25 01:45:26 -05:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
请根据您的操作系统选择对应的手动安装流程。
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-02-14 05:17:08 -05:00
|
|
|
|
.. toctree::
|
2022-01-15 07:29:02 -05:00
|
|
|
|
:maxdepth: 1
|
2019-07-23 05:45:41 -04:00
|
|
|
|
|
2022-04-15 10:26:21 -04:00
|
|
|
|
Windows Installer <windows-setup>
|
|
|
|
|
Linux and macOS <linux-macos-setup>
|
2019-10-10 04:52:07 -04:00
|
|
|
|
|
2022-01-15 07:29:02 -05:00
|
|
|
|
编译第一个工程
|
|
|
|
|
===================
|
2019-10-10 04:52:07 -04:00
|
|
|
|
|
2022-05-07 05:15:18 -04:00
|
|
|
|
如果您已经安装好 ESP-IDF 且没有使用集成开发环境 (IDE),请在命令提示行中按照 :ref:`在 Windows 中开始创建工程 <get-started-windows-first-steps>` 或 :ref:`在 Linux 和 macOS 中开始创建工程 <get-started-linux-macos-first-steps>` 编译第一个工程。
|
2022-02-20 03:45:43 -05:00
|
|
|
|
|
|
|
|
|
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
|