mirror of
https://github.com/espressif/esp-idf.git
synced 2026-04-27 19:13:21 +00:00
docs: update get started for downloading eim
This commit is contained in:
Binary file not shown.
|
After Width: | Height: | Size: 126 KiB |
@@ -2,6 +2,8 @@
|
|||||||
Start a Project on Linux and macOS from Command Line
|
Start a Project on Linux and macOS from Command Line
|
||||||
****************************************************
|
****************************************************
|
||||||
|
|
||||||
|
:link_to_translation:`zh_CN:[中文]`
|
||||||
|
|
||||||
This guide helps you to start a new project on the {IDF_TARGET_NAME} and build, flash, and monitor the device output on Linux and macOS.
|
This guide helps you to start a new project on the {IDF_TARGET_NAME} and build, flash, and monitor the device output on Linux and macOS.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ For other installation methods, install the `required prerequisites <https://doc
|
|||||||
|
|
||||||
Python 3.10 is the minimum supported version for ESP-IDF.
|
Python 3.10 is the minimum supported version for ESP-IDF.
|
||||||
|
|
||||||
However, for `Offline Installation`_, EIM requires **Python 3.11 or versions later**.
|
For the Python version required by the EIM, please refer to the `EIM documentation <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_.
|
||||||
|
|
||||||
|
|
||||||
Step 2: Install the EIM
|
Step 2: Install the EIM
|
||||||
@@ -30,11 +30,23 @@ Step 2: Install the EIM
|
|||||||
|
|
||||||
You can install the EIM using one of the following methods:
|
You can install the EIM using one of the following methods:
|
||||||
|
|
||||||
|
- `Download the EIM`_
|
||||||
- `Debian-Based Linux Installation via APT`_
|
- `Debian-Based Linux Installation via APT`_
|
||||||
- `RPM-Based Linux Installation via DNF`_
|
- `RPM-Based Linux Installation via DNF`_
|
||||||
- `Download the EIM Installer`_
|
|
||||||
|
|
||||||
Installing via APT or DNF allows you to easily keep EIM up to date.
|
Installing via APT or DNF allows you to easily keep EIM up to date with a single command.
|
||||||
|
|
||||||
|
|
||||||
|
Download the EIM
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. figure:: ../../_static/get-started-eim-download.drawio.png
|
||||||
|
:alt: EIM Download Page
|
||||||
|
:align: left
|
||||||
|
:width: 35%
|
||||||
|
:target: https://dl.espressif.com/dl/eim/
|
||||||
|
|
||||||
|
You can choose either an online or offline installer, available in Graphical User Interface (GUI) or Command Line Interface (CLI) versions.
|
||||||
|
|
||||||
|
|
||||||
.. _install-eim-linux-apt:
|
.. _install-eim-linux-apt:
|
||||||
@@ -91,12 +103,6 @@ Then, install the EIM Command Line Interface (CLI) alone, or together with Graph
|
|||||||
sudo dnf install eim-cli
|
sudo dnf install eim-cli
|
||||||
|
|
||||||
|
|
||||||
Download the EIM Installer
|
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
Alternatively, download the EIM installer for Linux from the `Espressif Download Page <https://dl.espressif.com/dl/eim/>`__, which provides both online and offline installers available in both CLI and GUI versions.
|
|
||||||
|
|
||||||
|
|
||||||
Step 3: Install ESP-IDF Using EIM
|
Step 3: Install ESP-IDF Using EIM
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
|
|||||||
@@ -24,13 +24,36 @@ Install the required prerequisites via `Homebrew <https://brew.sh/>`_:
|
|||||||
|
|
||||||
Python 3.10 is the minimum supported version for ESP-IDF.
|
Python 3.10 is the minimum supported version for ESP-IDF.
|
||||||
|
|
||||||
However, for `Offline Installation`_, EIM requires **Python 3.11 or versions later**.
|
For the Python version required by the EIM, please refer to the `EIM documentation <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_.
|
||||||
|
|
||||||
|
|
||||||
Step 2: Install the EIM
|
Step 2: Install the EIM
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
Add the EIM repository to the Homebrew to make it available for installation:
|
You can install the EIM using one of the following methods:
|
||||||
|
|
||||||
|
- `Download the EIM`_
|
||||||
|
- `Install the EIM with Package Manager Homebrew`_
|
||||||
|
|
||||||
|
Installing EIM with Homebrew allows you to easily keep EIM up to date with a single command.
|
||||||
|
|
||||||
|
|
||||||
|
Download the EIM
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. figure:: ../../_static/get-started-eim-download.drawio.png
|
||||||
|
:alt: EIM Download Page
|
||||||
|
:align: left
|
||||||
|
:width: 35%
|
||||||
|
:target: https://dl.espressif.com/dl/eim/
|
||||||
|
|
||||||
|
You can choose either an online or offline installer, available in Graphical User Interface (GUI) or Command Line Interface (CLI) versions.
|
||||||
|
|
||||||
|
|
||||||
|
Install the EIM with Package Manager Homebrew
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Add the EIM repository to the `Homebrew <https://brew.sh/>`__ to make it available for installation:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@@ -48,12 +71,6 @@ Then, install the EIM Graphical User Interface (GUI) or Command Line Interface (
|
|||||||
|
|
||||||
brew install eim
|
brew install eim
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
Installing via Homebrew makes it easier to keep EIM up to date.
|
|
||||||
|
|
||||||
Alternatively, download the EIM installer for macOS from the `Espressif Download Page <https://dl.espressif.com/dl/eim/>`__, which provides both online and offline installers available in both CLI and GUI versions.
|
|
||||||
|
|
||||||
|
|
||||||
Step 3: Install ESP-IDF Using EIM
|
Step 3: Install ESP-IDF Using EIM
|
||||||
=================================
|
=================================
|
||||||
|
|||||||
@@ -11,29 +11,57 @@ This section describes how to install ESP-IDF and its required tools on Windows
|
|||||||
This document describes the default and recommended way to install ESP-IDF v6.0 and newer versions. ESP-IDF also supports the :doc:`legacy method for updating ESP-IDF tools on Windows <windows-setup-update-legacy>`.
|
This document describes the default and recommended way to install ESP-IDF v6.0 and newer versions. ESP-IDF also supports the :doc:`legacy method for updating ESP-IDF tools on Windows <windows-setup-update-legacy>`.
|
||||||
|
|
||||||
|
|
||||||
Step 1: Install the EIM
|
Step 1: Install the Prerequisites (Optional)
|
||||||
|
============================================
|
||||||
|
|
||||||
|
During ESP-IDF installation, the EIM automatically checks for required prerequisites and prompts you to install any missing prerequisites.
|
||||||
|
|
||||||
|
If automatic installation fails, you can install these prerequisites manually:
|
||||||
|
|
||||||
|
- `Git <https://git-scm.com/install/windows>`_
|
||||||
|
- `Python <https://www.python.org/downloads/windows/>`_
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Python 3.10 is the minimum supported version for ESP-IDF.
|
||||||
|
|
||||||
|
For the Python version required by the EIM, please refer to the `EIM documentation <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_.
|
||||||
|
|
||||||
|
|
||||||
|
Step 2: Install the EIM
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
Install the EIM Graphical User Interface (GUI) or Command Line Interface (CLI) via `WinGet <https://learn.microsoft.com/en-us/windows/package-manager/winget/>`__:
|
You can install the EIM using one of the following methods:
|
||||||
|
|
||||||
- GUI:
|
- Download the EIM
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
winget install Espressif.EIM
|
.. figure:: ../../_static/get-started-eim-download.drawio.png
|
||||||
|
:alt: EIM Download Page
|
||||||
|
:align: left
|
||||||
|
:width: 35%
|
||||||
|
:target: https://dl.espressif.com/dl/eim/
|
||||||
|
|
||||||
- CLI:
|
You can choose either an online or offline installer, available in Graphical User Interface (GUI) or Command Line Interface (CLI) versions.
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
winget install Espressif.EIM-CLI
|
- Install the EIM with Package Manager `WinGet <https://learn.microsoft.com/en-us/windows/package-manager/winget/>`__
|
||||||
|
|
||||||
.. note::
|
- Install the Graphical User Interface (GUI) or Command Line Interface (CLI):
|
||||||
|
|
||||||
Installing via WinGet makes it easier to keep EIM up to date.
|
- GUI:
|
||||||
|
|
||||||
Alternatively, download the EIM installer for Windows from the `Espressif Download Page <https://dl.espressif.com/dl/eim/>`__, which provides both online and offline installers available in both CLI and GUI versions.
|
.. code-block:: bash
|
||||||
|
|
||||||
|
winget install Espressif.EIM
|
||||||
|
- CLI:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
winget install Espressif.EIM-CLI
|
||||||
|
|
||||||
|
- This method makes it easy to keep EIM up to date with a single command.
|
||||||
|
|
||||||
|
|
||||||
Step 2: Install ESP-IDF Using EIM
|
Step 3: Install ESP-IDF Using EIM
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
.. include:: eim-install-idf.rst
|
.. include:: eim-install-idf.rst
|
||||||
|
|||||||
@@ -2,6 +2,8 @@
|
|||||||
Start a Project on Windows from Command Line
|
Start a Project on Windows from Command Line
|
||||||
********************************************
|
********************************************
|
||||||
|
|
||||||
|
:link_to_translation:`zh_CN:[中文]`
|
||||||
|
|
||||||
This guide helps you to start a new project on the {IDF_TARGET_NAME} and build, flash, and monitor the device output on Windows.
|
This guide helps you to start a new project on the {IDF_TARGET_NAME} and build, flash, and monitor the device output on Windows.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,8 @@
|
|||||||
在 Linux 或 macOS 上通过命令行构建项目
|
在 Linux 或 macOS 上通过命令行构建项目
|
||||||
*****************************************************
|
*****************************************************
|
||||||
|
|
||||||
|
:link_to_translation:`en:[English]`
|
||||||
|
|
||||||
本指南将介绍如何使用命令行在 {IDF_TARGET_NAME} 上创建新项目,构建、烧录和监控设备输出。
|
本指南将介绍如何使用命令行在 {IDF_TARGET_NAME} 上创建新项目,构建、烧录和监控设备输出。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
在 Linux 上安装 ESP-IDF 及工具链
|
在 Linux 上安装 ESP-IDF 及工具链
|
||||||
************************************************
|
************************************************
|
||||||
|
|
||||||
:link_to_translation:`zh_CN:[中文]`
|
:link_to_translation:`en:[English]`
|
||||||
|
|
||||||
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 Linux 发行版(例如 Ubuntu)上安装 ESP-IDF 及其所需工具。
|
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 Linux 发行版(例如 Ubuntu)上安装 ESP-IDF 及其所需工具。
|
||||||
|
|
||||||
@@ -22,7 +22,7 @@
|
|||||||
|
|
||||||
ESP-IDF 要求 Python 版本至少为 3.10。
|
ESP-IDF 要求 Python 版本至少为 3.10。
|
||||||
|
|
||||||
但如需使用 EIM 进行 `离线安装 <https://docs.espressif.com/projects/idf-im-ui/en/latest/offline_installation.html>`_,则必须使用 **Python 3.11 或更高版本**。
|
EIM 所需的 Python 版本,请参考 `EIM 文档 <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_。
|
||||||
|
|
||||||
|
|
||||||
第二步:安装 EIM
|
第二步:安装 EIM
|
||||||
@@ -30,13 +30,25 @@
|
|||||||
|
|
||||||
您可以使用以下任一方法安装 EIM:
|
您可以使用以下任一方法安装 EIM:
|
||||||
|
|
||||||
|
- `下载 EIM`_
|
||||||
- `通过 APT 安装(Debian 发行版)`_
|
- `通过 APT 安装(Debian 发行版)`_
|
||||||
- `通过 DNF 安装(RPM 发行版)`_
|
- `通过 DNF 安装(RPM 发行版)`_
|
||||||
- `下载 EIM 安装包`_
|
|
||||||
|
|
||||||
通过 APT 或 DNF 安装 EIM 便于后续升级更新。
|
通过 APT 或 DNF 安装 EIM 便于后续升级更新。
|
||||||
|
|
||||||
|
|
||||||
|
下载 EIM
|
||||||
|
~~~~~~~~~
|
||||||
|
|
||||||
|
.. figure:: ../../_static/get-started-eim-download.drawio.png
|
||||||
|
:alt: EIM 下载页面
|
||||||
|
:align: left
|
||||||
|
:width: 35%
|
||||||
|
:target: https://dl.espressif.com/dl/eim/
|
||||||
|
|
||||||
|
可选择下载在线或离线安装程序的图形用户界面 (GUI) 或命令行界面 (CLI) 版本。
|
||||||
|
|
||||||
|
|
||||||
.. _install-eim-linux-apt:
|
.. _install-eim-linux-apt:
|
||||||
|
|
||||||
通过 APT 安装(Debian 发行版)
|
通过 APT 安装(Debian 发行版)
|
||||||
@@ -91,12 +103,6 @@
|
|||||||
sudo dnf install eim-cli
|
sudo dnf install eim-cli
|
||||||
|
|
||||||
|
|
||||||
下载 EIM 安装包
|
|
||||||
~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
您也可以从 `Espressif 下载页面 <https://dl.espressif.com/dl/eim/>`__ 下载适用于 Linux 的 EIM 安装包,该页面提供了 CLI 和 GUI 版本的在线和离线安装程序。
|
|
||||||
|
|
||||||
|
|
||||||
第三步:使用 EIM 安装 ESP-IDF
|
第三步:使用 EIM 安装 ESP-IDF
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
在 macOS 上安装 ESP-IDF 及工具链
|
在 macOS 上安装 ESP-IDF 及工具链
|
||||||
************************************************
|
************************************************
|
||||||
|
|
||||||
:link_to_translation:`zh_CN:[中文]`
|
:link_to_translation:`en:[English]`
|
||||||
|
|
||||||
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 macOS 上安装 ESP-IDF 及其所需工具。
|
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 macOS 上安装 ESP-IDF 及其所需工具。
|
||||||
|
|
||||||
@@ -24,13 +24,36 @@
|
|||||||
|
|
||||||
ESP-IDF 要求 Python 版本至少为 3.10。
|
ESP-IDF 要求 Python 版本至少为 3.10。
|
||||||
|
|
||||||
但如需使用 EIM 进行 `离线安装 <https://docs.espressif.com/projects/idf-im-ui/en/latest/offline_installation.html>`_,则必须使用 **Python 3.11 或更高版本**。
|
EIM 所需的 Python 版本,请参考 `EIM 文档 <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_。
|
||||||
|
|
||||||
|
|
||||||
第二步:安装 EIM
|
第二步:安装 EIM
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
将 EIM 仓库添加到 Homebrew 中,以便后续使用 Homebrew 安装 EIM:
|
您可以使用以下任一方法安装 EIM:
|
||||||
|
|
||||||
|
- `下载 EIM`_
|
||||||
|
- `通过 Homebrew 安装 EIM`_
|
||||||
|
|
||||||
|
如果通过 Homebrew 安装 EIM,后续运行单个命令,即可轻松升级更新 EIM。
|
||||||
|
|
||||||
|
|
||||||
|
下载 EIM
|
||||||
|
~~~~~~~~~
|
||||||
|
|
||||||
|
.. figure:: ../../_static/get-started-eim-download.drawio.png
|
||||||
|
:alt: EIM 下载页面
|
||||||
|
:align: left
|
||||||
|
:width: 35%
|
||||||
|
:target: https://dl.espressif.com/dl/eim/
|
||||||
|
|
||||||
|
可选择下载在线或离线安装程序的图形用户界面 (GUI) 或命令行界面 (CLI) 版本。
|
||||||
|
|
||||||
|
|
||||||
|
通过 Homebrew 安装 EIM
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
将 EIM 仓库添加到 `Homebrew <https://brew.sh/>`__ 中,以便后续使用 Homebrew 安装 EIM:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@@ -48,12 +71,6 @@
|
|||||||
|
|
||||||
brew install eim
|
brew install eim
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
通过 Homebrew 安装 EIM 便于后续升级更新。
|
|
||||||
|
|
||||||
您也可以从 `Espressif 下载页面 <https://dl.espressif.com/dl/eim/>`__ 下载适用于 macOS 的 EIM 安装包,该页面提供了 CLI 和 GUI 版本的在线和离线安装程序。
|
|
||||||
|
|
||||||
|
|
||||||
第三步:使用 EIM 安装 ESP-IDF
|
第三步:使用 EIM 安装 ESP-IDF
|
||||||
==============================
|
==============================
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
在 Windows 上安装 ESP-IDF 及工具链
|
在 Windows 上安装 ESP-IDF 及工具链
|
||||||
************************************************
|
************************************************
|
||||||
|
|
||||||
:link_to_translation:`zh_CN:[中文]`
|
:link_to_translation:`en:[English]`
|
||||||
|
|
||||||
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 Windows 上安装 ESP-IDF 及其所需工具。
|
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 Windows 上安装 ESP-IDF 及其所需工具。
|
||||||
|
|
||||||
@@ -11,29 +11,57 @@
|
|||||||
本章节描述了 ESP-IDF v6.0 及以上版本的默认和推荐安装方式。ESP-IDF 仍支持 :doc:`Windows 上更新 ESP-IDF 的传统方法 <windows-setup-update-legacy>`。
|
本章节描述了 ESP-IDF v6.0 及以上版本的默认和推荐安装方式。ESP-IDF 仍支持 :doc:`Windows 上更新 ESP-IDF 的传统方法 <windows-setup-update-legacy>`。
|
||||||
|
|
||||||
|
|
||||||
第一步:安装 EIM
|
第一步:安装依赖包(可选)
|
||||||
|
==========================
|
||||||
|
|
||||||
|
安装 ESP-IDF 时,EIM 会自动检查所需的依赖包。如果检查到依赖包缺失,EIM 会在用户确认后自动安装缺失的依赖包。
|
||||||
|
|
||||||
|
如果自动安装失败,可以手动安装以下依赖包:
|
||||||
|
|
||||||
|
- `Git <https://git-scm.com/install/windows>`_
|
||||||
|
- `Python <https://www.python.org/downloads/windows/>`_
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Python 3.10 是 ESP-IDF 支持的最低版本。
|
||||||
|
|
||||||
|
EIM 所需的 Python 版本,请参考 `EIM 文档 <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_。
|
||||||
|
|
||||||
|
|
||||||
|
第二步:安装 EIM
|
||||||
=================
|
=================
|
||||||
|
|
||||||
通过 `WinGet <https://learn.microsoft.com/en-us/windows/package-manager/winget/>`__ 安装 EIM 的图形用户界面 (GUI) 或命令行界面 (CLI):
|
您可以使用以下任一方法安装 EIM:
|
||||||
|
|
||||||
- GUI:
|
- 下载 EIM
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
winget install Espressif.EIM
|
.. figure:: ../../_static/get-started-eim-download.drawio.png
|
||||||
|
:alt: EIM 下载页面
|
||||||
|
:align: left
|
||||||
|
:width: 35%
|
||||||
|
:target: https://dl.espressif.com/dl/eim/
|
||||||
|
|
||||||
- CLI:
|
可选择下载在线或离线安装程序的图形用户界面 (GUI) 或命令行界面 (CLI) 版本。
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
winget install Espressif.EIM-CLI
|
- 使用 `WinGet 包管理器 <https://learn.microsoft.com/zh-cn/windows/package-manager/>`_ 安装 EIM
|
||||||
|
|
||||||
.. note::
|
- 安装图形用户界面 (GUI) 或命令行界面 (CLI):
|
||||||
|
|
||||||
通过 WinGet 安装 EIM 便于后续升级更新。
|
- GUI:
|
||||||
|
|
||||||
您也可以从 `Espressif 下载页面 <https://dl.espressif.com/dl/eim/>`__ 下载适用于 Windows 的 EIM 安装包,该页面提供了 CLI 和 GUI 版本的在线和离线安装程序。
|
.. code-block:: bash
|
||||||
|
|
||||||
|
winget install Espressif.EIM
|
||||||
|
- CLI:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
winget install Espressif.EIM-CLI
|
||||||
|
|
||||||
|
- 通过运行单个命令,轻松升级更新 EIM。
|
||||||
|
|
||||||
|
|
||||||
第二步:使用 EIM 安装 ESP-IDF
|
第三步:使用 EIM 安装 ESP-IDF
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
.. include:: eim-install-idf.rst
|
.. include:: eim-install-idf.rst
|
||||||
|
|||||||
@@ -2,6 +2,8 @@
|
|||||||
在 Windows 上通过命令行构建项目
|
在 Windows 上通过命令行构建项目
|
||||||
********************************************
|
********************************************
|
||||||
|
|
||||||
|
:link_to_translation:`en:[English]`
|
||||||
|
|
||||||
本指南将介绍如何使用命令行在 Windows 上创建 {IDF_TARGET_NAME} 项目,构建、烧录和监控设备输出。
|
本指南将介绍如何使用命令行在 Windows 上创建 {IDF_TARGET_NAME} 项目,构建、烧录和监控设备输出。
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user