diff --git a/docs/en/libraries-and-frameworks/libs-frameworks.rst b/docs/en/libraries-and-frameworks/libs-frameworks.rst index 8bf9a7add4..5aa8fe3d2c 100644 --- a/docs/en/libraries-and-frameworks/libs-frameworks.rst +++ b/docs/en/libraries-and-frameworks/libs-frameworks.rst @@ -104,4 +104,5 @@ The `ESP-BSP `_ repository contains Board ESP-IDF-CXX ----------- -`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 the ESP Component Registry. Please check the project's `README.md `_ for more information. +`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 `__. Please check the project's `README.md `_ for more information. + diff --git a/docs/zh_CN/api-guides/cplusplus.rst b/docs/zh_CN/api-guides/cplusplus.rst index 50d9525bbe..1bd5ca18fa 100644 --- a/docs/zh_CN/api-guides/cplusplus.rst +++ b/docs/zh_CN/api-guides/cplusplus.rst @@ -19,7 +19,7 @@ ESP-IDF 支持以下 C++ 功能： ``esp-idf-cxx`` 组件 ------------------------- -`esp-idf-cxx `_ 组件为一些 ESP-IDF 中的功能提供了更高级别的 C++ API，该组件可以从 `ESP-IDF 组件注册表 `_ 中获取。 +`esp-idf-cxx `_ 组件为一些 ESP-IDF 中的功能提供了更高级别的 C++ API，该组件可以从 `乐鑫组件注册表 `_ 中获取。 C++ 语言标准 diff --git a/docs/zh_CN/api-guides/tools/idf-component-manager.rst b/docs/zh_CN/api-guides/tools/idf-component-manager.rst index 9ade99e8d4..0efcf519fb 100644 --- a/docs/zh_CN/api-guides/tools/idf-component-manager.rst +++ b/docs/zh_CN/api-guides/tools/idf-component-manager.rst @@ -4,7 +4,7 @@ IDF 组件管理器 :link_to_translation:`en:[English]` -IDF 组件管理器工具用于下载 ESP-IDF CMake 项目的依赖项，该下载在 CMake 运行期间自动完成。IDF 组件管理器可以从 `组件注册表 `__ 或 Git 仓库获取组件。 +IDF 组件管理器工具用于下载 ESP-IDF CMake 项目的依赖项，该下载在 CMake 运行期间自动完成。IDF 组件管理器可以从 `乐鑫组件注册表 `__ 或 Git 仓库获取组件。 要获取组件列表，请参阅 ``__. @@ -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` 是组件的版本范围（详情请参阅 `版本文档 `__），而 `example` 代表示例名称。在 `乐鑫组件注册表 `__ 中，可以找到各组件的示例列表，以及启动组件示例的相应命令。 +乐鑫组件注册表中，部分组件包含示例项目。要从示例创建一个新项目，可以运行命令 ``idf.py create-project-from-example EXAMPLE``。``EXAMPLE`` 参数格式为 ``namespace/name=1.0.0:example``，`namespace/name` 代表组件名称，`=1.0.0` 是组件的版本范围（详情请参阅 `版本文档 `__），而 `example` 代表示例名称。在 `乐鑫组件注册表 `__ 中，可以找到各组件的示例列表，以及启动组件示例的相应命令。 在清单文件中定义依赖项 ===================================== 通过在文本编辑器直接编辑，你可以轻松定义清单文件 ``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： diff --git a/docs/zh_CN/api-reference/network/esp_eth.rst b/docs/zh_CN/api-reference/network/esp_eth.rst index 1ed9aca6a7..28414f5033 100644 --- a/docs/zh_CN/api-reference/network/esp_eth.rst +++ b/docs/zh_CN/api-reference/network/esp_eth.rst @@ -571,7 +571,7 @@ ESP-IDF 以太网驱动程序所需的大部分 PHY 管理功能都已涵盖在 3. 定义针对芯片的特定管理回调功能。 4. 初始化 IEEE 802.3 父对象并重新分配针对芯片的特定管理回调功能。 -实现新的自定义 PHY 驱动程序后，你可以通过 `ESP-IDF 组件管理中心 `_ 将驱动分享给其他用户。 +实现新的自定义 PHY 驱动程序后，你可以通过 `乐鑫组件注册表 `_ 将驱动分享给其他用户。 .. ---------------------------- API Reference ---------------------------------- diff --git a/docs/zh_CN/api-reference/peripherals/usb_device.rst b/docs/zh_CN/api-reference/peripherals/usb_device.rst index 1b814a6dcd..d98b8b228b 100644 --- a/docs/zh_CN/api-reference/peripherals/usb_device.rst +++ b/docs/zh_CN/api-reference/peripherals/usb_device.rst @@ -14,7 +14,7 @@ USB 设备栈 USB 设备栈（以下简称设备栈）支持在 {IDF_TARGET_NAME} 上启用 USB 设备支持。通过使用设备栈，可以为 {IDF_TARGET_NAME} 烧录任意具有明确定义的 USB 设备功能（如键盘、鼠标、摄像头）、自定义功能（也称特定供应商类别）或上述功能的组合（也称复合设备）。 -设备栈基于 TinyUSB 栈构建，但对 TinyUSB 进行了一些小的功能扩展和修改，使其更好地集成到 ESP-IDF。设备栈通过 `ESP-IDF 组件注册器 `__ 作为托管组件分发。 +设备栈基于 TinyUSB 栈构建，但对 TinyUSB 进行了一些小的功能扩展和修改，使其更好地集成到 ESP-IDF。设备栈通过 `乐鑫组件注册表 `__ 作为托管组件分发。 功能列表 -------- @@ -63,7 +63,7 @@ USB 设备栈（以下简称设备栈）支持在 {IDF_TARGET_NAME} 上启用 US 组件依赖项 ------------- -设备栈通过 `ESP-IDF 组件注册器 `__ 分发，使用前，请使用以下命令将设备栈组件添加为依赖项： +设备栈通过 `乐鑫组件注册表 `__ 分发，使用前，请使用以下命令将设备栈组件添加为依赖项： .. code:: bash diff --git a/docs/zh_CN/api-reference/peripherals/usb_host.rst b/docs/zh_CN/api-reference/peripherals/usb_host.rst index 967f107630..e1b0ea1532 100644 --- a/docs/zh_CN/api-reference/peripherals/usb_host.rst +++ b/docs/zh_CN/api-reference/peripherals/usb_host.rst @@ -367,7 +367,7 @@ USB 主机栈提供了大量示例，展示了如何通过使用主机库 API CDC-ACM """"""" -* 通信设备 Class（抽象控制模型）的主机 Class 驱动程序通过 `ESP-IDF 组件注册器 `__ 作为受管理的组件分发。 +* 通信设备 Class（抽象控制模型）的主机 Class 驱动程序通过 `乐鑫组件注册表 `__ 作为受管理的组件分发。 * 示例 :example:`peripherals/usb/host/cdc/cdc_acm_host` 使用 CDC-ACM 主机驱动程序组件，与 CDC-ACM 设备通信。 * 示例 :example:`peripherals/usb/host/cdc/cdc_acm_vcp` 展示了如何扩展 CDC-ACM 主机驱动程序，与虚拟串口设备交互。 * 示例 `esp_modem `__ 中也使用了 CDC-ACM 驱动程序，该程序在这些示例中与蜂窝模块通信。 @@ -375,19 +375,19 @@ CDC-ACM MSC """ -* 大容量存储 Class（仅支持批量传输）的主机 Class 驱动程序已部署到 `ESP-IDF 组件注册器 `__。 +* 大容量存储 Class（仅支持批量传输）的主机 Class 驱动程序已部署到 `乐鑫组件注册表 `__。 * 示例 :example:`peripherals/usb/host/msc` 展示了如何使用 MSC 主机驱动程序读写 USB flash 驱动。 HID """ -* HID（人机接口设备）的主机 class 驱动作为托管组件通过 `ESP-IDF 组件注册器 `__ 分发。 +* HID（人机接口设备）的主机 class 驱动作为托管组件通过 `乐鑫组件注册表 `__ 分发。 * 示例 :example:`peripherals/usb/host/hid` 展示了从具有多个接口的 USB HID 设备接收报告的可能性。 UVC """ -* USB 视频设备 Class 的主机 Class 驱动程序作为托管组件通过 `ESP-IDF 组件注册器 `__ 分发。 +* USB 视频设备 Class 的主机 Class 驱动程序作为托管组件通过 `乐鑫组件注册表 `__ 分发。 * 示例 :example:`peripherals/usb/host/uvc` 展示了如何使用 UVC 主机驱动程序接收来自 USB 摄像头的视频流，并可选择将该流通过 Wi-Fi 转发。 .. ---------------------------------------------- USB Host Menuconfig -------------------------------------------------- diff --git a/docs/zh_CN/get-started/start-project.rst b/docs/zh_CN/get-started/start-project.rst index e8462c1b83..ee65b569d6 100644 --- a/docs/zh_CN/get-started/start-project.rst +++ b/docs/zh_CN/get-started/start-project.rst @@ -175,7 +175,7 @@ ESP-IDF 支持 Python 3.8 及以上版本，建议升级操作系统到最新版 一般来说，BSP 支持开发板上所有硬件组件。除了管脚定义和初始化功能外，BSP 还附带如传感器、显示器、音频编解码器等外部元件的驱动程序。 - BSP 通过 :doc:`IDF 组件管理器 ` 发布，可以前往 `IDF 组件注册器 `_ 进行下载。 + BSP 通过 :doc:`IDF 组件管理器 ` 发布，可以前往 `乐鑫组件注册表 `_ 进行下载。 .. only:: esp32 diff --git a/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst index 0e5eada204..c93bfbb306 100644 --- a/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst +++ b/docs/zh_CN/hw-reference/esp32/get-started-wrover-kit.rst @@ -427,7 +427,7 @@ USB 供电 使能 UART 通信 现在，请前往 :doc:`../../get-started/index` 中的 :ref:`get-started-step-by-step` 章节，查看如何设置开发环境，并尝试将示例项目烧录至你的开发板。 -你可以在 `ESP-IDF 组件注册器 `_ 中下载板级支持包 (BSP)。 +你可以在 `乐鑫组件注册表 `_ 中下载板级支持包 (BSP)。 以下链接提供了与 ESP-WROVER-KIT 开发板硬件相关的示例： diff --git a/docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst b/docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst index 7e0ce4111c..b2a818aa1c 100644 --- a/docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst +++ b/docs/zh_CN/libraries-and-frameworks/libs-frameworks.rst @@ -84,7 +84,7 @@ ESP-IoT-Solution 支持： ESP-Protocols ----------------------------------------- -`ESP-Protocols `_ 库包含 ESP-IDF 的协议组件集。ESP-Protocols 中的代码以独立组件存在，可以轻松地集成到 ESP-IDF 项目中。此外，每个组件都可以在 `ESP-IDF 组件注册表 `_ 中找到。 +`ESP-Protocols `_ 库包含 ESP-IDF 的协议组件集。ESP-Protocols 中的代码以独立组件存在，可以轻松地集成到 ESP-IDF 项目中。此外，每个组件都可以在 `乐鑫组件注册表 `__ 中找到。 ESP-Protocols 组件： @@ -104,4 +104,4 @@ ESP-BSP ESP-IDF-CXX ---------------------------------------------------------- -`ESP-IDF-CXX `_ 包含了 ESP-IDF 的部分 C++ 封装，重点在实现易用性、安全性、自动资源管理，以及将错误检查转移到编译过程中，以避免运行时失败。它还提供了 ESP 定时器、I2C、SPI、GPIO 等外设或 ESP-IDF 其他功能的 C++ 类。ESP-IDF-CXX 作为组件可以从 `组件注册表 `_ 中获取。详情请参阅 `README.md `_。 +`ESP-IDF-CXX `_ 包含了 ESP-IDF 的部分 C++ 封装，重点在实现易用性、安全性、自动资源管理，以及将错误检查转移到编译过程中，以避免运行时失败。它还提供了 ESP 定时器、I2C、SPI、GPIO 等外设或 ESP-IDF 其他功能的 C++ 类。ESP-IDF-CXX 作为组件可以从 `乐鑫组件注册表 `__ 中获取。详情请参阅 `README.md `_。 diff --git a/docs/zh_CN/migration-guides/release-5.x/5.0/protocols.rst b/docs/zh_CN/migration-guides/release-5.x/5.0/protocols.rst index 7e9486521c..47da66f267 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.0/protocols.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.0/protocols.rst @@ -205,7 +205,7 @@ ESP-Modbus espressif/esp-modbus: version: "^1.0" -可以前往 `组件管理器注册表 `__ 找到 ``ESP-Modbus`` 组件。更多有关如何设置组件管理器的信息，请参考 `组件管理器文档 `__。 +可以前往 `乐鑫组件注册表 `__ 找到 ``ESP-Modbus`` 组件。更多有关如何设置组件管理器的信息，请参考 `组件管理器文档 `__。 对于使用 ESP-IDF v4.x 及以后版本的应用程序，需要通过添加组件管理器清单文件 ``idf_component.yml`` 拉取新版 ``ESP-Modbus`` 组件。同时，在编译时，应去掉已过时的 ``freemodbus`` 组件。此项操作可通过项目 ``CMakeLists.txt`` 中的以下语句实现： diff --git a/docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst b/docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst index 3f4427ddd4..ebdbcdc10a 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst @@ -1,12 +1,12 @@ 从 ESP-IDF 中移出或弃用的组件 -================================ +============================= :link_to_translation:`en:[English]` -移至 ESP Component Registry 的组件 -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +移至乐鑫组件注册表的组件 +^^^^^^^^^^^^^^^^^^^^^^^^ -以下组件已经从 ESP-IDF 中迁出至 `ESP Component Registry `_： +以下组件已经从 ESP-IDF 中迁出至 `乐鑫组件注册表 `_： * `libsodium `_ * `cbor `_ @@ -47,7 +47,7 @@ ESP-IDF v4.x 版本中已不再使用以下组件，这些组件已弃用： .. note:: - 不再支持 OpenSSL-API 组件。ESP Component Registry 中也没有该组件。请直接使用 :doc:`ESP-TLS ` 或 :component:`mbedtls` API。 + 不再支持 OpenSSL-API 组件。乐鑫组件注册表中也没有该组件。请直接使用 :doc:`ESP-TLS ` 或 :component:`mbedtls` API。 .. note:: diff --git a/docs/zh_CN/migration-guides/release-5.x/5.3/peripherals.rst b/docs/zh_CN/migration-guides/release-5.x/5.3/peripherals.rst index 77eb0728c4..e3ff5bea29 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.3/peripherals.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.3/peripherals.rst @@ -54,7 +54,7 @@ ATECC608A 安全元素接口示例现已移至 GitHub 上的 `esp-cryptoauthlib 仓库 `_ 中。 -该示例也是组件管理器注册表中 `esp-cryptoauthlib `_ 的一部分。 +该示例也是乐鑫组件注册表中 `esp-cryptoauthlib `_ 的一部分。 I2S -------