# 快速入门

[English]

本文档旨在指导用户搭建 ESP32-S31 硬件开发的软件环境，通过一个简单的示例展示如何使用 ESP-IDF (Espressif IoT Development Framework) 配置菜单，并编译、下载固件至 ESP32-S31 开发板等步骤。

备注

这是 ESP-IDF master 分支（最新版本）的文档，该版本在持续开发中。还有 稳定版本 的文档，以及其他版本的文档 ESP-IDF 版本简介 供参考。

## 概述

ESP32-S31 SoC 芯片支持以下功能：

ESP32-S31 采用 40 nm 工艺制成，具有最佳的功耗性能、射频性能、安全性和可靠性，适用于各种应用场景和不同功耗需求。

乐鑫为用户提供完整的软、硬件资源，进行 ESP32-S31 硬件设备的开发。其中，乐鑫的软件开发环境 ESP-IDF 旨在协助用户快速开发物联网 (IoT) 应用，可满足用户对 Wi-Fi、蓝牙、低功耗等方面的要求。

## 准备工作

### 硬件：

- 一款 ESP32-S31 开发板

- USB 数据线 （A 转 Micro-B）

- 电脑（Windows、Linux 或 macOS）

备注

目前一些开发板使用的是 USB Type C 接口。请确保使用合适的数据线来连接开发板！

以下是 ESP32-S31 官方开发板，点击链接可了解更多硬件信息。

### 软件：

如需在 ESP32-S31 上使用 ESP-IDF，请安装以下软件：

> - 设置 工具链，用于编译 ESP32-S31 代码；

> - 编译构建工具 —— CMake 和 Ninja 编译构建工具，用于编译 ESP32-S31 应用程序；

> - 获取 ESP-IDF 软件开发框架。该框架已经基本包含 ESP32-S31 使用的 API（软件库和源代码）和运行 工具链 的脚本；

## 安装

请使用 ESP-IDF 安装管理器 (EIM) 来安装 ESP-IDF、构建工具和相关工具链，该管理器支持多种操作系统。

EIM 提供两种安装方式：

- 图形用户界面 (GUI)：用户友好，适合大多数用户。

- 命令行界面 (CLI)：适用于 CI/CD 流水线和自动化安装。

- 在 Windows 上安装 ESP-IDF 及工具链
- 在 Linux 上安装 ESP-IDF 及工具链
- 在 macOS 上安装 ESP-IDF 及工具链

## 构建首个项目

安装 ESP-IDF 后，您可选择在集成开发环境 (IDE) 中或通过命令行来构建首个项目。

### 在 IDE 中构建

通过 EIM 安装的 ESP-IDF 版本可搭配以下 IDE 使用，获得图形化开发体验：

- 基于 Eclipse CDT 的 Espressif-IDE

  > 该 IDE 已集成 IDF Eclipse 插件、必备 Eclipse CDT 插件和其他 Eclipse 平台插件，可支持 ESP-IDF 应用的开发和构建。

- 安装 ESP-IDF 拓展 的 Visual Studio Code

  > 通过安装拓展，您可直接在 Visual Studio Code 中开发、构建、烧录和监视 ESP-IDF 应用程序。

关于 IDE 的具体配置与使用方法，请参阅上述对应的文档。

### 通过命令行构建

如果使用命令行构建项目、构建、烧录至 ESP32-S31、监视设备输出，请根据您的操作系统参考以下说明：

- 在 Windows 上通过命令行构建项目
- 在 Linux 或 macOS 上通过命令行构建项目

备注

如果尚未安装 ESP-IDF，请跳转至 安装，按照说明先安装所有必需的软件。

## 卸载 ESP-IDF

如需卸载通过 EIM 安装的 ESP-IDF 及相关工具，可使用图形用户界面 (GUI) 或命令行界面 (CLI) 两种方式。

### 使用 EIM GUI 卸载

启动 ESP-IDF 安装管理器。在 `管理安装` 下，点击 `打开仪表板`。

EIM 打开仪表板

如需删除特定 ESP-IDF 版本，请在该版本下点击 `移除` 按键。

如果删除所有 ESP-IDF 版本，请点击页面底部的 `清除所有` 按键。

EIM 卸载 ESP-IDF

### 使用 EIM CLI 卸载

如需删除特定 ESP-IDF 版本，例如 v5.4.2，请在终端中运行以下命令：

    eim remove v5.4.2

如需删除所有 ESP-IDF 版本，请在终端中运行以下命令：

    eim purge

## 相关文档

- ESP-IDF 安装管理器 (EIM) 文档

- Espressif-IDE (ESP-IDF Eclipse 插件) GitHub 仓库

- VSCode ESP-IDF 扩展 GitHub 仓库

此文档对您有帮助吗？

- 反馈已收到，谢谢！
- 如果您有其他意见，欢迎填写乐鑫文档反馈表。

- 我们重视您的反馈。
- 您可以填写乐鑫文档反馈表告诉我们如何改进该文档。