mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'docs/consistent_naming_convention_for_ESP_Component_Registry' into 'master'
docs: Consistent naming convention for ESP Component Registry See merge request espressif/esp-idf!31205
This commit is contained in:
commit
1870eaa2ba
@ -1,5 +1,5 @@
|
||||
menu "LCD and Touch Panel"
|
||||
comment "LCD Touch Drivers are maintained in the IDF Component Registry"
|
||||
comment "LCD Touch Drivers are maintained in the ESP Component Registry"
|
||||
|
||||
menu "LCD Peripheral Configuration"
|
||||
config LCD_PANEL_IO_FORMAT_BUF_SIZE
|
||||
|
@ -19,7 +19,7 @@ The following C++ features are supported:
|
||||
``esp-idf-cxx`` Component
|
||||
-------------------------
|
||||
|
||||
`esp-idf-cxx <https://github.com/espressif/esp-idf-cxx>`_ component provides higher-level C++ APIs for some of the ESP-IDF features. This component is available from the `ESP-IDF Component Registry <https://components.espressif.com/components/espressif/esp-idf-cxx>`_.
|
||||
`esp-idf-cxx <https://github.com/espressif/esp-idf-cxx>`_ component provides higher-level C++ APIs for some of the ESP-IDF features. This component is available from the `ESP Component Registry <https://components.espressif.com/components/espressif/esp-idf-cxx>`_.
|
||||
|
||||
|
||||
C++ Language Standard
|
||||
|
@ -4,7 +4,7 @@ IDF Component Manager
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
The IDF Component Manager is a tool that downloads dependencies for any ESP-IDF CMake project. The download happens automatically during a run of CMake. It can source components either from the `component registry <https://components.espressif.com>`__ or from a Git repository.
|
||||
The IDF Component Manager is a tool that downloads dependencies for any ESP-IDF CMake project. The download happens automatically during a run of CMake. It can source components either from the `ESP Component Registry <https://components.espressif.com>`__ or from a Git repository.
|
||||
|
||||
A list of components can be found on `<https://components.espressif.com/>`__.
|
||||
|
||||
@ -29,7 +29,7 @@ To add a dependency to a component (e.g., ``my_component``) in your ESP-IDF proj
|
||||
|
||||
.. note::
|
||||
|
||||
The command ``add-dependency`` adds dependencies to your project explicitly from the `Espressif Component Registry <https://components.espressif.com/>`__.
|
||||
The command ``add-dependency`` adds dependencies to your project explicitly from the `ESP Component Registry <https://components.espressif.com/>`__.
|
||||
|
||||
To update dependencies of the ESP-IDF project, you can run the command ``idf.py update-dependencies``. You can also specify the path to the project directory using ``--project-dir PATH``.
|
||||
|
||||
@ -50,19 +50,19 @@ You may set the build property ``DEPENDENCIES_LOCK`` to specify the lock-file pa
|
||||
Creating a Project From an Example
|
||||
==================================
|
||||
|
||||
Some components on the registry contain example projects. To create a new project from an example you can run the command ``idf.py create-project-from-example EXAMPLE``. The ``EXAMPLE`` argument should be in the format ``namespace/name=1.0.0:example`` where `namespace/name` is the name of the component, `=1.0.0` is a version range of the component (see the `Versioning Documentation <https://docs.espressif.com/projects/idf-component-manager/en/latest/reference/versioning.html>`__) and `example` is the example's name. You can find the list of examples for every component and the command to start a project for it in the `Espressif Component Registry <https://components.espressif.com/>`__.
|
||||
Some components in the ESP Component Registry contain example projects. To create a new project from an example you can run the command ``idf.py create-project-from-example EXAMPLE``. The ``EXAMPLE`` argument should be in the format ``namespace/name=1.0.0:example`` where `namespace/name` is the name of the component, `=1.0.0` is a version range of the component (see the `Versioning Documentation <https://docs.espressif.com/projects/idf-component-manager/en/latest/reference/versioning.html>`__) and `example` is the example's name. You can find the list of examples for every component and the command to start a project for it in the `ESP Component Registry <https://components.espressif.com/>`__.
|
||||
|
||||
Defining Dependencies in the Manifest
|
||||
=====================================
|
||||
|
||||
You can easily define dependencies in the manifest file ``idf_component.yml`` by editing it directly in the text editor. Below are some basic examples that demonstrate how to define dependencies.
|
||||
|
||||
You can define a dependency from the registry by specifying the component name and the version range:
|
||||
You can define a dependency from the ESP Component Registry by specifying the component name and the version range:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
dependencies:
|
||||
# Define a dependency from the registry (https://components.espressif.com/component/example/cmp)
|
||||
# Define a dependency from the ESP Component Registry (https://components.espressif.com/component/example/cmp)
|
||||
example/cmp: ">=1.0.0"
|
||||
|
||||
To define a dependency from a Git repository, provide the path to the component within the repository and the repository's URL:
|
||||
|
@ -571,7 +571,7 @@ The majority of PHY management functionality required by the ESP-IDF Ethernet dr
|
||||
3. Define chip-specific management call-back functions.
|
||||
4. Initialize parent IEEE 802.3 object and re-assign chip-specific management call-back functions.
|
||||
|
||||
Once you finish the new custom PHY driver implementation, consider sharing it among other users via `IDF Component Registry <https://components.espressif.com/>`_.
|
||||
Once you finish the new custom PHY driver implementation, consider sharing it among other users via `ESP Component Registry <https://components.espressif.com/>`_.
|
||||
|
||||
.. ---------------------------- API Reference ----------------------------------
|
||||
|
||||
|
@ -35,7 +35,7 @@ This document will discuss how to create the control plane and data plane, as me
|
||||
|
||||
.. note::
|
||||
|
||||
ESP-IDF provides only a limited number of LCD device controller drivers out of the box (e.g., ST7789). More drivers are available in the `Espressif Component Registry <https://components.espressif.com/components?q=esp_lcd>`__.
|
||||
ESP-IDF provides only a limited number of LCD device controller drivers out of the box (e.g., ST7789). More drivers are available in the `ESP Component Registry <https://components.espressif.com/components?q=esp_lcd>`__.
|
||||
|
||||
LCD Control Panel Operations
|
||||
----------------------------
|
||||
|
@ -14,7 +14,7 @@ Overview
|
||||
|
||||
The ESP-IDF USB Device Stack (hereinafter referred to as the Device Stack) enables USB Device support on {IDF_TARGET_NAME}. By using the Device Stack, {IDF_TARGET_NAME} can be programmed with any well defined USB device functions (e.g., keyboard, mouse, camera), a custom function (aka vendor-specific class), or a combination of those functions (aka a composite device).
|
||||
|
||||
The Device Stack is built around the TinyUSB stack, but extends TinyUSB with some minor features and modifications for better integration with ESP-IDF. The Device stack is distributed as a managed component via the `ESP-IDF Component Registry <https://components.espressif.com/components/espressif/esp_tinyusb>`__.
|
||||
The Device Stack is built around the TinyUSB stack, but extends TinyUSB with some minor features and modifications for better integration with ESP-IDF. The Device stack is distributed as a managed component via the `ESP Component Registry <https://components.espressif.com/components/espressif/esp_tinyusb>`__.
|
||||
|
||||
Features
|
||||
--------
|
||||
@ -63,7 +63,7 @@ The basis of the Device Stack is TinyUSB, where the Device Stack implements the
|
||||
Component Dependency
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The Device Stack is distributed via the `ESP-IDF Component Registry <https://components.espressif.com/components/espressif/esp_tinyusb>`__. Thus, to use it, please add the Device Stack component as dependency using the following command:
|
||||
The Device Stack is distributed via the `ESP Component Registry <https://components.espressif.com/components/espressif/esp_tinyusb>`__. Thus, to use it, please add the Device Stack component as dependency using the following command:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
|
@ -367,7 +367,7 @@ The USB Host Stack provides a number of examples that implement host class drive
|
||||
CDC-ACM
|
||||
"""""""
|
||||
|
||||
* A host class driver for the Communication Device Class (Abstract Control Model) is distributed as a managed component via the `ESP-IDF Component Registry <https://components.espressif.com/component/espressif/usb_host_cdc_acm>`__.
|
||||
* A host class driver for the Communication Device Class (Abstract Control Model) is distributed as a managed component via the `ESP Component Registry <https://components.espressif.com/component/espressif/usb_host_cdc_acm>`__.
|
||||
* The :example:`peripherals/usb/host/cdc/cdc_acm_host` example uses the CDC-ACM host driver component to communicate with CDC-ACM devices.
|
||||
* The :example:`peripherals/usb/host/cdc/cdc_acm_vcp` example shows how can you extend the CDC-ACM host driver to interface Virtual COM Port devices.
|
||||
* The CDC-ACM driver is also used in `esp_modem examples <https://github.com/espressif/esp-protocols/tree/master/components/esp_modem/examples>`__, where it is used for communication with cellular modems.
|
||||
@ -375,19 +375,19 @@ CDC-ACM
|
||||
MSC
|
||||
"""
|
||||
|
||||
* A host class driver for the Mass Storage Class (Bulk-Only Transport) is deployed to `ESP-IDF Component Registry <https://components.espressif.com/component/espressif/usb_host_msc>`__.
|
||||
* A host class driver for the Mass Storage Class (Bulk-Only Transport) is deployed to `ESP Component Registry <https://components.espressif.com/component/espressif/usb_host_msc>`__.
|
||||
* The :example:`peripherals/usb/host/msc` example demonstrates the usage of the MSC host driver to read and write to a USB flash drive.
|
||||
|
||||
HID
|
||||
"""
|
||||
|
||||
* A host class driver for the HID (Human interface device) is distributed as a managed component via the `ESP-IDF Component Registry <https://components.espressif.com/components/espressif/usb_host_hid>`__.
|
||||
* A host class driver for the HID (Human interface device) is distributed as a managed component via the `ESP Component Registry <https://components.espressif.com/components/espressif/usb_host_hid>`__.
|
||||
* The :example:`peripherals/usb/host/hid` example demonstrates the possibility to receive reports from a USB HID device with several interfaces.
|
||||
|
||||
UVC
|
||||
"""
|
||||
|
||||
* A host class driver for the USB Video Device Class is distributed as a managed component via the `ESP-IDF Component Registry <https://components.espressif.com/component/espressif/usb_host_uvc>`__.
|
||||
* A host class driver for the USB Video Device Class is distributed as a managed component via the `ESP Component Registry <https://components.espressif.com/component/espressif/usb_host_uvc>`__.
|
||||
* The :example:`peripherals/usb/host/uvc` example demonstrates the usage of the UVC host driver to receive a video stream from a USB camera and optionally forward that stream over Wi-Fi.
|
||||
|
||||
.. ---------------------------------------------- USB Host Menuconfig --------------------------------------------------
|
||||
|
@ -175,7 +175,7 @@ ESP-IDF supports Python 3.8 or newer. It is recommended to upgrade your operatin
|
||||
|
||||
A BSP typically supports all of the hardware components provided on development board. Apart from the pinout definition and initialization functions, a BSP ships with drivers for the external components such as sensors, displays, audio codecs etc.
|
||||
|
||||
The BSPs are distributed via :doc:`IDF Component Manager </api-guides/tools/idf-component-manager>`, so they can be found in `IDF Component Registry <https://components.espressif.com>`_.
|
||||
The BSPs are distributed via :doc:`IDF Component Manager </api-guides/tools/idf-component-manager>`, so they can be found in `ESP Component Registry <https://components.espressif.com>`_.
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
|
@ -427,7 +427,7 @@ Now to Development
|
||||
|
||||
Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an example project onto your board.
|
||||
|
||||
A Board Support Package can be found in `IDF Component Registry <https://components.espressif.com/component/espressif/esp_wrover_kit>`_.
|
||||
A Board Support Package can be found in `ESP Component Registry <https://components.espressif.com/component/espressif/esp_wrover_kit>`_.
|
||||
|
||||
The application examples that use some hardware specific to your ESP-WROVER-KIT can be found below.
|
||||
|
||||
|
@ -223,7 +223,7 @@ Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-starte
|
||||
|
||||
The programming guide and application examples for your ESP32-S2-Kaluga-1 kit can be found in `esp-dev-kits <https://github.com/espressif/esp-dev-kits/tree/master/esp32-s2-kaluga-1>`_ repository on GitHub.
|
||||
|
||||
A Board Support Package can be found in `IDF Component Registry <https://components.espressif.com/component/espressif/esp32_s2_kaluga_kit>`_.
|
||||
A Board Support Package can be found in `ESP Component Registry <https://components.espressif.com/component/espressif/esp32_s2_kaluga_kit>`_.
|
||||
|
||||
|
||||
Contents and Packaging
|
||||
|
@ -84,7 +84,7 @@ This solution is available on Github: `ESP-IoT-Solution on GitHub <https://githu
|
||||
ESP-Protocols
|
||||
-------------
|
||||
|
||||
The `ESP-Protocols <https://github.com/espressif/esp-protocols>`_ repository contains a collection of protocol components for ESP-IDF. The code within ESP-Protocols is organized into separate components, allowing them to be easily integrated into an ESP-IDF project. Additionally, each component is available in `IDF Component Registry <https://components.espressif.com/>`_.
|
||||
The `ESP-Protocols <https://github.com/espressif/esp-protocols>`_ repository contains a collection of protocol components for ESP-IDF. The code within ESP-Protocols is organized into separate components, allowing them to be easily integrated into an ESP-IDF project. Additionally, each component is available in `ESP Component Registry <https://components.espressif.com/>`_.
|
||||
|
||||
ESP-Protocols components:
|
||||
|
||||
@ -104,4 +104,5 @@ The `ESP-BSP <https://github.com/espressif/esp-bsp>`_ repository contains Board
|
||||
ESP-IDF-CXX
|
||||
-----------
|
||||
|
||||
`ESP-IDF-CXX <https://github.com/espressif/esp-idf-cxx>`_ contains C++ wrappers for part of ESP-IDF. The focuses are on ease of use, safety, automatic resource management. They also move error checking from runtime to compile time to prevent running failure. There are C++ classes for ESP-Timer, I2C, SPI, GPIO and other peripherals or features of ESP-IDF. ESP-IDF-CXX is `available as a component <https://components.espressif.com/components/espressif/esp-idf-cxx>`_ from the component registry. Please check the project's `README.md <https://github.com/espressif/esp-idf-cxx/blob/main/README.md>`_ for more information.
|
||||
`ESP-IDF-CXX <https://github.com/espressif/esp-idf-cxx>`_ contains C++ wrappers for part of ESP-IDF. The focuses are on ease of use, safety, automatic resource management. They also move error checking from runtime to compile time to prevent running failure. There are C++ classes for ESP-Timer, I2C, SPI, GPIO and other peripherals or features of ESP-IDF. ESP-IDF-CXX is available as a component from `ESP Component Registry <https://components.espressif.com/components/espressif/esp-idf-cxx>`__. Please check the project's `README.md <https://github.com/espressif/esp-idf-cxx/blob/main/README.md>`_ for more information.
|
||||
|
||||
|
@ -205,7 +205,7 @@ The ``main`` component folder of the new application shall include the component
|
||||
espressif/esp-modbus:
|
||||
version: "^1.0"
|
||||
|
||||
The ``esp-modbus`` component can be found in `component manager registry <https://components.espressif.com/component/espressif/esp-modbus>`__. Refer to `component manager documentation <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html>`__ for more information on how to set up the component manager.
|
||||
The ``esp-modbus`` component can be found in `ESP Component Registry <https://components.espressif.com/component/espressif/esp-modbus>`__. Refer to `component manager documentation <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html>`__ for more information on how to set up the component manager.
|
||||
|
||||
For applications targeting v4.x releases of ESP-IDF that need to use new ``esp-modbus`` component, adding the component manager manifest file ``idf_component.yml`` will be sufficient to pull in the new component. However, users should also exclude the legacy ``freemodbus`` component from the build. This can be achieved using the statement below in the project's ``CMakeLists.txt``:
|
||||
|
||||
|
@ -3,10 +3,10 @@ Removed or Deprecated Components
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
Components Moved to ESP-IDF Component Registry
|
||||
Components Moved to ESP Component Registry
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Following components are removed from ESP-IDF and moved to `ESP-IDF Component Registry <https://components.espressif.com/>`_:
|
||||
Following components are removed from ESP-IDF and moved to `ESP Component Registry <https://components.espressif.com/>`_:
|
||||
|
||||
* `libsodium <https://components.espressif.com/component/espressif/libsodium>`_
|
||||
* `cbor <https://components.espressif.com/component/espressif/cbor>`_
|
||||
@ -47,7 +47,7 @@ The following components are removed since they were deprecated in ESP-IDF v4.x:
|
||||
|
||||
.. note::
|
||||
|
||||
OpenSSL-API component is no longer supported. It is not available in the IDF Component Registry, either. Please use :doc:`ESP-TLS </api-reference/protocols/esp_tls>` or :component:`mbedtls` API directly.
|
||||
OpenSSL-API component is no longer supported. It is not available in the ESP Component Registry, either. Please use :doc:`ESP-TLS </api-reference/protocols/esp_tls>` or :component:`mbedtls` API directly.
|
||||
|
||||
.. note::
|
||||
|
||||
|
@ -54,7 +54,7 @@ Secure Element
|
||||
|
||||
The ATECC608A secure element interfacing example has been moved to `ESP Cryptoauthlib Repository <https://github.com/espressif/esp-cryptoauthlib/tree/master/examples/atecc608_ecdsa>`_ on GitHub.
|
||||
|
||||
This example is also part of the `esp-cryptoauthlib <https://components.espressif.com/component/espressif/esp-cryptoauthlib>`_ in the component manager registry.
|
||||
This example is also part of the `esp-cryptoauthlib <https://components.espressif.com/component/espressif/esp-cryptoauthlib>`_ in the ESP Component Registry.
|
||||
|
||||
I2S
|
||||
-------
|
||||
|
@ -19,7 +19,7 @@ ESP-IDF 支持以下 C++ 功能:
|
||||
``esp-idf-cxx`` 组件
|
||||
-------------------------
|
||||
|
||||
`esp-idf-cxx <https://github.com/espressif/esp-idf-cxx>`_ 组件为一些 ESP-IDF 中的功能提供了更高级别的 C++ API,该组件可以从 `ESP-IDF 组件注册表 <https://components.espressif.com/components/espressif/esp-idf-cxx>`_ 中获取。
|
||||
`esp-idf-cxx <https://github.com/espressif/esp-idf-cxx>`_ 组件为一些 ESP-IDF 中的功能提供了更高级别的 C++ API,该组件可以从 `乐鑫组件注册表 <https://components.espressif.com/components/espressif/esp-idf-cxx>`_ 中获取。
|
||||
|
||||
|
||||
C++ 语言标准
|
||||
|
@ -4,7 +4,7 @@ IDF 组件管理器
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
IDF 组件管理器工具用于下载 ESP-IDF CMake 项目的依赖项,该下载在 CMake 运行期间自动完成。IDF 组件管理器可以从 `组件注册表 <https://components.espressif.com>`__ 或 Git 仓库获取组件。
|
||||
IDF 组件管理器工具用于下载 ESP-IDF CMake 项目的依赖项,该下载在 CMake 运行期间自动完成。IDF 组件管理器可以从 `乐鑫组件注册表 <https://components.espressif.com>`__ 或 Git 仓库获取组件。
|
||||
|
||||
要获取组件列表,请参阅 `<https://components.espressif.com/>`__.
|
||||
|
||||
@ -50,19 +50,19 @@ IDF 组件管理器工具用于下载 ESP-IDF CMake 项目的依赖项,该下
|
||||
从示例创建项目
|
||||
================================
|
||||
|
||||
组件注册表中,部分组件包含示例项目。要从示例创建一个新项目,可以运行命令 ``idf.py create-project-from-example EXAMPLE``。``EXAMPLE`` 参数格式为 ``namespace/name=1.0.0:example``,`namespace/name` 代表组件名称,`=1.0.0` 是组件的版本范围(详情请参阅 `版本文档 <https://docs.espressif.com/projects/idf-component-manager/en/latest/reference/versioning.html>`__),而 `example` 代表示例名称。在 `乐鑫组件注册表 <https://components.espressif.com/>`__ 中,可以找到各组件的示例列表,以及启动组件示例的相应命令。
|
||||
乐鑫组件注册表中,部分组件包含示例项目。要从示例创建一个新项目,可以运行命令 ``idf.py create-project-from-example EXAMPLE``。``EXAMPLE`` 参数格式为 ``namespace/name=1.0.0:example``,`namespace/name` 代表组件名称,`=1.0.0` 是组件的版本范围(详情请参阅 `版本文档 <https://docs.espressif.com/projects/idf-component-manager/en/latest/reference/versioning.html>`__),而 `example` 代表示例名称。在 `乐鑫组件注册表 <https://components.espressif.com/>`__ 中,可以找到各组件的示例列表,以及启动组件示例的相应命令。
|
||||
|
||||
在清单文件中定义依赖项
|
||||
=====================================
|
||||
|
||||
通过在文本编辑器直接编辑,你可以轻松定义清单文件 ``idf_component.yml`` 中的依赖项。以下是有关定义依赖项的简单示例:
|
||||
|
||||
你可以通过指定组件名称和版本范围,定义来自注册表的依赖项:
|
||||
你可以通过指定组件名称和版本范围,定义来自乐鑫组件注册表的依赖项:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
dependencies:
|
||||
# 定义来自注册表 (https://components.espressif.com/component/example/cmp) 的依赖项
|
||||
# 定义来自乐鑫组件注册表 (https://components.espressif.com/component/example/cmp) 的依赖项
|
||||
example/cmp: ">=1.0.0"
|
||||
|
||||
要从 Git 仓库定义依赖关系,请提供组件在仓库中的路径和仓库的 URL:
|
||||
|
@ -571,7 +571,7 @@ ESP-IDF 以太网驱动程序所需的大部分 PHY 管理功能都已涵盖在
|
||||
3. 定义针对芯片的特定管理回调功能。
|
||||
4. 初始化 IEEE 802.3 父对象并重新分配针对芯片的特定管理回调功能。
|
||||
|
||||
实现新的自定义 PHY 驱动程序后,你可以通过 `ESP-IDF 组件管理中心 <https://components.espressif.com/>`_ 将驱动分享给其他用户。
|
||||
实现新的自定义 PHY 驱动程序后,你可以通过 `乐鑫组件注册表 <https://components.espressif.com/>`_ 将驱动分享给其他用户。
|
||||
|
||||
.. ---------------------------- API Reference ----------------------------------
|
||||
|
||||
|
@ -14,7 +14,7 @@ USB 设备栈
|
||||
|
||||
USB 设备栈(以下简称设备栈)支持在 {IDF_TARGET_NAME} 上启用 USB 设备支持。通过使用设备栈,可以为 {IDF_TARGET_NAME} 烧录任意具有明确定义的 USB 设备功能(如键盘、鼠标、摄像头)、自定义功能(也称特定供应商类别)或上述功能的组合(也称复合设备)。
|
||||
|
||||
设备栈基于 TinyUSB 栈构建,但对 TinyUSB 进行了一些小的功能扩展和修改,使其更好地集成到 ESP-IDF。设备栈通过 `ESP-IDF 组件注册器 <https://components.espressif.com/components/espressif/esp_tinyusb>`__ 作为托管组件分发。
|
||||
设备栈基于 TinyUSB 栈构建,但对 TinyUSB 进行了一些小的功能扩展和修改,使其更好地集成到 ESP-IDF。设备栈通过 `乐鑫组件注册表 <https://components.espressif.com/components/espressif/esp_tinyusb>`__ 作为托管组件分发。
|
||||
|
||||
功能列表
|
||||
--------
|
||||
@ -63,7 +63,7 @@ USB 设备栈(以下简称设备栈)支持在 {IDF_TARGET_NAME} 上启用 US
|
||||
组件依赖项
|
||||
-------------
|
||||
|
||||
设备栈通过 `ESP-IDF 组件注册器 <https://components.espressif.com/components/espressif/esp_tinyusb>`__ 分发,使用前,请使用以下命令将设备栈组件添加为依赖项:
|
||||
设备栈通过 `乐鑫组件注册表 <https://components.espressif.com/components/espressif/esp_tinyusb>`__ 分发,使用前,请使用以下命令将设备栈组件添加为依赖项:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
|
@ -367,7 +367,7 @@ USB 主机栈提供了大量示例,展示了如何通过使用主机库 API
|
||||
CDC-ACM
|
||||
"""""""
|
||||
|
||||
* 通信设备 Class(抽象控制模型)的主机 Class 驱动程序通过 `ESP-IDF 组件注册器 <https://components.espressif.com/component/espressif/usb_host_cdc_acm>`__ 作为受管理的组件分发。
|
||||
* 通信设备 Class(抽象控制模型)的主机 Class 驱动程序通过 `乐鑫组件注册表 <https://components.espressif.com/component/espressif/usb_host_cdc_acm>`__ 作为受管理的组件分发。
|
||||
* 示例 :example:`peripherals/usb/host/cdc/cdc_acm_host` 使用 CDC-ACM 主机驱动程序组件,与 CDC-ACM 设备通信。
|
||||
* 示例 :example:`peripherals/usb/host/cdc/cdc_acm_vcp` 展示了如何扩展 CDC-ACM 主机驱动程序,与虚拟串口设备交互。
|
||||
* 示例 `esp_modem <https://github.com/espressif/esp-protocols/tree/master/components/esp_modem/examples>`__ 中也使用了 CDC-ACM 驱动程序,该程序在这些示例中与蜂窝模块通信。
|
||||
@ -375,19 +375,19 @@ CDC-ACM
|
||||
MSC
|
||||
"""
|
||||
|
||||
* 大容量存储 Class(仅支持批量传输)的主机 Class 驱动程序已部署到 `ESP-IDF 组件注册器 <https://components.espressif.com/component/espressif/usb_host_msc>`__。
|
||||
* 大容量存储 Class(仅支持批量传输)的主机 Class 驱动程序已部署到 `乐鑫组件注册表 <https://components.espressif.com/component/espressif/usb_host_msc>`__。
|
||||
* 示例 :example:`peripherals/usb/host/msc` 展示了如何使用 MSC 主机驱动程序读写 USB flash 驱动。
|
||||
|
||||
HID
|
||||
"""
|
||||
|
||||
* HID(人机接口设备)的主机 class 驱动作为托管组件通过 `ESP-IDF 组件注册器 <https://components.espressif.com/components/espressif/usb_host_hid>`__ 分发。
|
||||
* HID(人机接口设备)的主机 class 驱动作为托管组件通过 `乐鑫组件注册表 <https://components.espressif.com/components/espressif/usb_host_hid>`__ 分发。
|
||||
* 示例 :example:`peripherals/usb/host/hid` 展示了从具有多个接口的 USB HID 设备接收报告的可能性。
|
||||
|
||||
UVC
|
||||
"""
|
||||
|
||||
* USB 视频设备 Class 的主机 Class 驱动程序作为托管组件通过 `ESP-IDF 组件注册器 <https://components.espressif.com/component/espressif/usb_host_uvc>`__ 分发。
|
||||
* USB 视频设备 Class 的主机 Class 驱动程序作为托管组件通过 `乐鑫组件注册表 <https://components.espressif.com/component/espressif/usb_host_uvc>`__ 分发。
|
||||
* 示例 :example:`peripherals/usb/host/uvc` 展示了如何使用 UVC 主机驱动程序接收来自 USB 摄像头的视频流,并可选择将该流通过 Wi-Fi 转发。
|
||||
|
||||
.. ---------------------------------------------- USB Host Menuconfig --------------------------------------------------
|
||||
|
@ -175,7 +175,7 @@ ESP-IDF 支持 Python 3.8 及以上版本,建议升级操作系统到最新版
|
||||
|
||||
一般来说,BSP 支持开发板上所有硬件组件。除了管脚定义和初始化功能外,BSP 还附带如传感器、显示器、音频编解码器等外部元件的驱动程序。
|
||||
|
||||
BSP 通过 :doc:`IDF 组件管理器 </api-guides/tools/idf-component-manager>` 发布,可以前往 `IDF 组件注册器 <https://components.espressif.com>`_ 进行下载。
|
||||
BSP 通过 :doc:`IDF 组件管理器 </api-guides/tools/idf-component-manager>` 发布,可以前往 `乐鑫组件注册表 <https://components.espressif.com>`_ 进行下载。
|
||||
|
||||
.. only:: esp32
|
||||
|
||||
|
@ -427,7 +427,7 @@ USB 供电 使能 UART 通信
|
||||
|
||||
现在,请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节,查看如何设置开发环境,并尝试将示例项目烧录至你的开发板。
|
||||
|
||||
你可以在 `ESP-IDF 组件注册器 <https://components.espressif.com>`_ 中下载板级支持包 (BSP)。
|
||||
你可以在 `乐鑫组件注册表 <https://components.espressif.com>`_ 中下载板级支持包 (BSP)。
|
||||
|
||||
以下链接提供了与 ESP-WROVER-KIT 开发板硬件相关的示例:
|
||||
|
||||
|
@ -84,7 +84,7 @@ ESP-IoT-Solution 支持:
|
||||
ESP-Protocols
|
||||
-----------------------------------------
|
||||
|
||||
`ESP-Protocols <https://github.com/espressif/esp-protocols>`_ 库包含 ESP-IDF 的协议组件集。ESP-Protocols 中的代码以独立组件存在,可以轻松地集成到 ESP-IDF 项目中。此外,每个组件都可以在 `ESP-IDF 组件注册表 <https://components.espressif.com/>`_ 中找到。
|
||||
`ESP-Protocols <https://github.com/espressif/esp-protocols>`_ 库包含 ESP-IDF 的协议组件集。ESP-Protocols 中的代码以独立组件存在,可以轻松地集成到 ESP-IDF 项目中。此外,每个组件都可以在 `乐鑫组件注册表 <https://components.espressif.com/>`__ 中找到。
|
||||
|
||||
ESP-Protocols 组件:
|
||||
|
||||
@ -104,4 +104,4 @@ ESP-BSP
|
||||
ESP-IDF-CXX
|
||||
----------------------------------------------------------
|
||||
|
||||
`ESP-IDF-CXX <https://github.com/espressif/esp-idf-cxx>`_ 包含了 ESP-IDF 的部分 C++ 封装,重点在实现易用性、安全性、自动资源管理,以及将错误检查转移到编译过程中,以避免运行时失败。它还提供了 ESP 定时器、I2C、SPI、GPIO 等外设或 ESP-IDF 其他功能的 C++ 类。ESP-IDF-CXX 作为组件可以从 `组件注册表 <https://components.espressif.com/components/espressif/esp-idf-cxx>`_ 中获取。详情请参阅 `README.md <https://github.com/espressif/esp-idf-cxx/blob/main/README.md>`_。
|
||||
`ESP-IDF-CXX <https://github.com/espressif/esp-idf-cxx>`_ 包含了 ESP-IDF 的部分 C++ 封装,重点在实现易用性、安全性、自动资源管理,以及将错误检查转移到编译过程中,以避免运行时失败。它还提供了 ESP 定时器、I2C、SPI、GPIO 等外设或 ESP-IDF 其他功能的 C++ 类。ESP-IDF-CXX 作为组件可以从 `乐鑫组件注册表 <https://components.espressif.com/components/espressif/esp-idf-cxx>`__ 中获取。详情请参阅 `README.md <https://github.com/espressif/esp-idf-cxx/blob/main/README.md>`_。
|
||||
|
@ -205,7 +205,7 @@ ESP-Modbus
|
||||
espressif/esp-modbus:
|
||||
version: "^1.0"
|
||||
|
||||
可以前往 `组件管理器注册表 <https://components.espressif.com/component/espressif/esp-modbus>`__ 找到 ``ESP-Modbus`` 组件。更多有关如何设置组件管理器的信息,请参考 `组件管理器文档 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html>`__。
|
||||
可以前往 `乐鑫组件注册表 <https://components.espressif.com/component/espressif/esp-modbus>`__ 找到 ``ESP-Modbus`` 组件。更多有关如何设置组件管理器的信息,请参考 `组件管理器文档 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html>`__。
|
||||
|
||||
对于使用 ESP-IDF v4.x 及以后版本的应用程序,需要通过添加组件管理器清单文件 ``idf_component.yml`` 拉取新版 ``ESP-Modbus`` 组件。同时,在编译时,应去掉已过时的 ``freemodbus`` 组件。此项操作可通过项目 ``CMakeLists.txt`` 中的以下语句实现:
|
||||
|
||||
|
@ -1,12 +1,12 @@
|
||||
从 ESP-IDF 中移出或弃用的组件
|
||||
================================
|
||||
=============================
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
移至 ESP-IDF Component Registry 的组件
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
移至乐鑫组件注册表的组件
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
以下组件已经从 ESP-IDF 中迁出至 `ESP-IDF Component Registry <https://components.espressif.com/>`_:
|
||||
以下组件已经从 ESP-IDF 中迁出至 `乐鑫组件注册表 <https://components.espressif.com/>`_:
|
||||
|
||||
* `libsodium <https://components.espressif.com/component/espressif/libsodium>`_
|
||||
* `cbor <https://components.espressif.com/component/espressif/cbor>`_
|
||||
@ -47,7 +47,7 @@ ESP-IDF v4.x 版本中已不再使用以下组件,这些组件已弃用:
|
||||
|
||||
.. note::
|
||||
|
||||
不再支持 OpenSSL-API 组件。ESP-IDF Component Registry 中也没有该组件。请直接使用 :doc:`ESP-TLS </api-reference/protocols/esp_tls>` 或 :component:`mbedtls` API。
|
||||
不再支持 OpenSSL-API 组件。乐鑫组件注册表中也没有该组件。请直接使用 :doc:`ESP-TLS </api-reference/protocols/esp_tls>` 或 :component:`mbedtls` API。
|
||||
|
||||
.. note::
|
||||
|
||||
|
@ -54,7 +54,7 @@
|
||||
|
||||
ATECC608A 安全元素接口示例现已移至 GitHub 上的 `esp-cryptoauthlib 仓库 <https://github.com/espressif/esp-cryptoauthlib/tree/master/examples/atecc608_ecdsa>`_ 中。
|
||||
|
||||
该示例也是组件管理器注册表中 `esp-cryptoauthlib <https://components.espressif.com/component/espressif/esp-cryptoauthlib>`_ 的一部分。
|
||||
该示例也是乐鑫组件注册表中 `esp-cryptoauthlib <https://components.espressif.com/component/espressif/esp-cryptoauthlib>`_ 的一部分。
|
||||
|
||||
I2S
|
||||
-------
|
||||
|
@ -3,7 +3,7 @@
|
||||
|
||||
# Using the component manager for downloading dependencies
|
||||
|
||||
This example demonstrates how to use [IDF Component Manager](https://pypi.org/project/idf-component-manager/) for downloading dependencies from [the component registry](https://components.espressif.com). More details and use cases of IDF Component Manager can be found in the programming guide under `API Guides` -> `Tools` -> `IDF Component Manager`.
|
||||
This example demonstrates how to use [IDF Component Manager](https://pypi.org/project/idf-component-manager/) for downloading dependencies from [ESP Component Registry](https://components.espressif.com). More details and use cases of IDF Component Manager can be found in the programming guide under `API Guides` -> `Tools` -> `IDF Component Manager`.
|
||||
|
||||
## How to use the example
|
||||
### Hardware Required
|
||||
|
@ -2,7 +2,7 @@ dependencies:
|
||||
# Required IDF version
|
||||
idf: ">=4.1"
|
||||
|
||||
# Defining a dependency from the registry:
|
||||
# Defining a dependency from the ESP Component Registry:
|
||||
# https://components.espressif.com/component/example/cmp
|
||||
example/cmp: "^3.3.3"
|
||||
|
||||
|
@ -38,7 +38,7 @@ The GPIO number used by this example can be changed in [lvgl_example_main.c](mai
|
||||
|
||||
Run `idf.py -p PORT build flash monitor` to build, flash and monitor the project. A scrolling text will show up on the LCD as expected.
|
||||
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from registry into `managed_components` folder.
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from the ESP Component Registry into `managed_components` folder.
|
||||
|
||||
(To exit the serial monitor, type ``Ctrl-]``.)
|
||||
|
||||
|
@ -11,7 +11,7 @@ The whole porting code is located in [i80_controller_example_main.c](main/i80_co
|
||||
|
||||
The UI will display two images (one Espressif logo and another Espressif text), which have been converted into C arrays by the [online converting tool](https://lvgl.io/tools/imageconverter), and will be compiled directly into application binary.
|
||||
|
||||
This example is constructed by [IDF component manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html), all the external dependency will be handled by the CMake build system automatically. In this case, it will help download the lvgl from [registry](https://components.espressif.com/component/lvgl/lvgl), with the version specified in the [manifest file](main/idf_component.yml).
|
||||
This example is constructed by [IDF component manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html), all the external dependency will be handled by the CMake build system automatically. In this case, it will help download the lvgl from the [ESP Component Registry](https://components.espressif.com/component/lvgl/lvgl), with the version specified in the [manifest file](main/idf_component.yml).
|
||||
|
||||
This example uses the [esp_timer](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/esp_timer.html) to generate the ticks needed by LVGL and uses a dedicated task to run the `lv_timer_handler()`. Since the LVGL APIs are not thread-safe, this example uses a mutex which be invoked before the call of `lv_timer_handler()` and released after it. The same mutex needs to be used in other tasks and threads around every LVGL (lv_...) related function call and code. For more porting guides, please refer to [LVGL porting doc](https://docs.lvgl.io/master/porting/index.html).
|
||||
|
||||
@ -76,7 +76,7 @@ Run `idf.py menuconfig` to open a terminal UI where you can tune specific config
|
||||
|
||||
Run `idf.py -p PORT build flash monitor` to build, flash and monitor the project. A fancy animation will show up on the LCD as expected.
|
||||
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from registry into `managed_components` folder.
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from the ESP Component Registry into `managed_components` folder.
|
||||
|
||||
(To exit the serial monitor, type ``Ctrl-]``.)
|
||||
|
||||
|
@ -57,7 +57,7 @@ Run `idf.py menuconfig` and go to `Example Configuration`:
|
||||
|
||||
Run `idf.py -p PORT build flash monitor` to build, flash and monitor the project. A LVGL widget should show up on the LCD as expected.
|
||||
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from registry into `managed_components` folder.
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from the ESP Component Registry into `managed_components` folder.
|
||||
|
||||
(To exit the serial monitor, type ``Ctrl-]``.)
|
||||
|
||||
|
@ -70,7 +70,7 @@ Run `idf.py menuconfig` and go to `Example Configuration`:
|
||||
|
||||
Run `idf.py -p PORT build flash monitor` to build, flash and monitor the project. A scatter chart will show up on the LCD as expected.
|
||||
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from registry into `managed_components` folder.
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from the ESP Component Registry into `managed_components` folder.
|
||||
|
||||
(To exit the serial monitor, type ``Ctrl-]``.)
|
||||
|
||||
|
@ -59,7 +59,7 @@ Especially, please pay attention to the level used to turn on the LCD backlight,
|
||||
|
||||
Run `idf.py -p PORT build flash monitor` to build, flash and monitor the project. A fancy animation will show up on the LCD as expected.
|
||||
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from registry into `managed_components` folder.
|
||||
The first time you run `idf.py` for the example will cost extra time as the build system needs to address the component dependencies and downloads the missing components from the ESP Component Registry into `managed_components` folder.
|
||||
|
||||
(To exit the serial monitor, type ``Ctrl-]``.)
|
||||
|
||||
|
@ -7,9 +7,9 @@
|
||||
|
||||
RMT peripheral has independent transmit and receive channels. We can simulate the [1-Wire](https://www.analog.com/en/technical-articles/guide-to-1wire-communication.html) bus by attaching a pair of transmit and receive channel to the same GPIO, and turning on the open-drain mode of the GPIO pad.
|
||||
|
||||
We've made the 1-Wire protocol implementation into a component called `onewire_bus`, which has been uploaded to the [component registry](https://components.espressif.com/components/espressif/onewire_bus).
|
||||
We've made the 1-Wire protocol implementation into a component called `onewire_bus`, which has been uploaded to the [ESP Component Registry](https://components.espressif.com/components/espressif/onewire_bus).
|
||||
|
||||
This example demonstrates how to use that `onewire_bus` library to read temperature from the [DS18B20](https://www.analog.com/media/en/technical-documentation/data-sheets/ds18b20.pdf) sensor. Likewise, the DS18B20 device is also made as a single component and pushed to the [component registry](https://components.espressif.com/components/espressif/ds18b20).
|
||||
This example demonstrates how to use that `onewire_bus` library to read temperature from the [DS18B20](https://www.analog.com/media/en/technical-documentation/data-sheets/ds18b20.pdf) sensor. Likewise, the DS18B20 device is also made as a single component and pushed to the [ESP Component Registry](https://components.espressif.com/components/espressif/ds18b20).
|
||||
|
||||
One of the amazing feature that offered by the `onewire_bus` driver is that, is can support enumerate the devices on the bus, thus you can connect multiple DS18B20 sensors to the same bus and read their temperature one by one.
|
||||
|
||||
|
@ -8,7 +8,7 @@
|
||||
This example shows how to extend CDC-ACM driver for Virtual Communication Port (VCP) devices,
|
||||
such as CP210x, FTDI FT23x or CH34x devices.
|
||||
|
||||
The drivers are fetched from [IDF Component Registry](https://components.espressif.com/) together with VCP service that automatically loads correct driver for plugged-in device.
|
||||
The drivers are fetched from [ESP Component Registry](https://components.espressif.com/) together with VCP service that automatically loads correct driver for plugged-in device.
|
||||
|
||||
## How to use example
|
||||
|
||||
|
@ -6,7 +6,7 @@
|
||||
## Note about iperf version
|
||||
The iperf example doesn't support all features in standard iperf. It's compatible with iperf version 2.x.
|
||||
|
||||
- Refer to the components registry iperf-cmd page for more information: https://components.espressif.com/components/espressif/iperf-cmd
|
||||
- Refer to the ESP Component Registry iperf-cmd page for more information: https://components.espressif.com/components/espressif/iperf-cmd
|
||||
|
||||
## Note about 80MHz flash frequency (ESP32)
|
||||
The iperf can get better throughput if the SPI flash frequency is set to 80MHz, but the system may crash in 80MHz mode for ESP-WROVER-KIT.
|
||||
|
Loading…
x
Reference in New Issue
Block a user