:link_to_translation:`en:[English]`
本文档旨在指导用户搭建 {IDF_TARGET_NAME} 硬件开发的软件环境,通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单,并编译、下载固件至 {IDF_TARGET_NAME} 开发板等步骤。
.. include-build-file:: inc/version-note.inc
{IDF_TARGET_NAME} SoC 芯片支持以下功能:
.. only:: esp32 * 2.4 GHz Wi-Fi * 蓝牙 * 高性能 Xtensa® 32 位 LX6 双核处理器 * 超低功耗协处理器 * 多种外设
.. only:: esp32s2 * 2.4 GHz Wi-Fi * 高性能 Xtensa® 32 位 LX7 单核处理器 * 运行 RISC-V 或 FSM 内核的超低功耗协处理器 * 多种外设 * 内置安全硬件 * USB OTG 接口
.. only:: esp32s3 * 2.4 GHz Wi-Fi * 低功耗蓝牙 * 高性能 Xtensa® 32 位 LX7 双核处理器 * 运行 RISC-V 或 FSM 内核的超低功耗协处理器 * 多种外设 * 内置安全硬件 * USB OTG 接口 * USB 串口/JTAG 控制器
.. only:: esp32c3 * 2.4 GHz Wi-Fi * 低功耗蓝牙 * 高性能 32 位 RISC-V 单核处理器 * 多种外设 * 内置安全硬件
.. only:: esp32c2 * 2.4 GHz Wi-Fi * 低功耗蓝牙 * 高性能 32 位 RISC-V 单核处理器 * 多种外设 * 适用于较简单、大批量生产的物联网应用
{IDF_TARGET_NAME} 采用 40 nm 工艺制成,具有最佳的功耗性能、射频性能、稳定性、通用性和可靠性,适用于各种应用场景和不同功耗需求。
乐鑫为用户提供完整的软、硬件资源,进行 {IDF_TARGET_NAME} 硬件设备的开发。其中,乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用,可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。
- 一款 {IDF_TARGET_NAME} 开发板
- USB 数据线 (A 转 Micro-B)
- 电脑(Windows、Linux 或 macOS)
Note
目前一些开发板使用的是 USB Type C 接口。请确保使用合适的数据线来连接开发板!
以下是 {IDF_TARGET_NAME} 官方开发板,点击链接可了解更多硬件信息。
.. only:: esp32 .. toctree:: :maxdepth: 1 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> ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1> ESP32-PICO-KIT-1 <../hw-reference/esp32/get-started-pico-kit-1> ESP32-PICO-DevKitM-2 <../hw-reference/esp32/get-started-pico-devkitm-2> ESP32-DevKitM-1 <../hw-reference/esp32/user-guide-devkitm-1>
.. only:: esp32s2 .. toctree:: :maxdepth: 1 ESP32-S2-Saola-1 <../hw-reference/esp32s2/user-guide-saola-1-v1.2> ESP32-S2-DevKitM-1(U) <../hw-reference/esp32s2/user-guide-devkitm-1-v1> ESP32-S2-DevKitC-1 <../hw-reference/esp32s2/user-guide-s2-devkitc-1> ESP32-S2-Kaluga-Kit <../hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit>
.. only:: esp32c3 .. toctree:: :maxdepth: 1 ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1> ESP32-C3-DevKitC-02 <../hw-reference/esp32c3/user-guide-devkitc-02>
.. only:: esp32s3 .. toctree:: :maxdepth: 1 ESP32-S3-DevKitC-1 <../hw-reference/esp32s3/user-guide-devkitc-1> ESP32-S3-DevKitM-1 <../hw-reference/esp32s3/user-guide-devkitm-1>
.. 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>
如需在 {IDF_TARGET_NAME} 上使用 ESP-IDF,请安装以下软件:
- 设置 工具链,用于编译 {IDF_TARGET_NAME} 代码;
- 编译构建工具 —— CMake 和 Ninja 编译构建工具,用于编译 {IDF_TARGET_NAME} 应用程序;
- 获取 ESP-IDF 软件开发框架。该框架已经基本包含 {IDF_TARGET_NAME} 使用的 API(软件库和源代码)和运行 工具链 的脚本;
我们提供以下方法帮助安装所有需要的软件,可根据需要选择其中之一。
Note
建议您通过自己喜欢的集成开发环境 (IDE) 安装 ESP-IDF。
请根据您的操作系统选择对应的手动安装流程。
.. toctree:: :maxdepth: 1 Windows Installer <windows-setup> Linux and macOS <linux-macos-setup>
如果您已经安装好 ESP-IDF 且没有使用集成开发环境 (IDE),请在命令提示行中按照 :ref:`在 Windows 中开始创建工程 <get-started-windows-first-steps>` 或 :ref:`在 Linux 和 macOS 中开始创建工程 <get-started-linux-macos-first-steps>` 编译第一个工程。
如需卸载 ESP-IDF,请参考 :ref:`idf-tools-uninstall`。