forked from espressif/esp-idf
Merge branch 'docs/sync_en_and_cn_docs' into 'master'
docs: Sync EN and CN docs without 'needs translation' label Closes DOC-12700 See merge request espressif/esp-idf!42919
This commit is contained in:
Shen Meng Jing
@@ -136,11 +136,11 @@ Mesh Models
|
||||
* Device Firmware Update Client models
|
||||
* Firmware Update Client model (Preview)
|
||||
* Firmware Distribution Client model (coming soon)
|
||||
|
||||
* Device Firmware Update Server models
|
||||
* Firmware Update Server model (Preview)
|
||||
* Firmware Distribution Server model (coming soon)
|
||||
|
||||
|
||||
Mesh Examples
|
||||
"""""""""""""
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ Application Examples
|
||||
|
||||
- :example:`wifi/wifi_aware/nan_publisher` demonstrates how to use the NAN protocol to publish a service for advertising a service to other devices in the vicinity, and how to respond to the devices that subscribes to the service.
|
||||
|
||||
- :example:`wifi/wifi_aware/nan_subscriber` demonstrates how to use the NAN protocol to discover other devices that publishes the required service in the proximity, and communicate with them either by sending a message or initiating a datapath.
|
||||
- :example:`wifi/wifi_aware/nan_subscriber` demonstrates how to use the NAN protocol to discover other devices that publish the required service in the proximity, and communicate with them either by sending a message or initiating a datapath.
|
||||
|
||||
- :example:`wifi/wifi_aware/usd_publisher` demonstrates how to use lightweight NAN Unsynchronized Service Discovery (NAN-USD) to advertise a service to nearby devices without forming NAN clusters. It walks through bringing up USD, publishing a service, responding to subscribers with follow-up messages, and returning to the idle state once discovery completes.
|
||||
- :example:`wifi/wifi_aware/usd_publisher` demonstrates how to use lightweight NAN Unsynchronized Service Discovery (NAN-USD) protocol to advertise a service to nearby devices without forming NAN clusters. It walks through bringing up USD, publishing a service, responding to subscribers with follow-up messages, and returning to the idle state once discovery completes.
|
||||
|
||||
- :example:`wifi/wifi_aware/usd_subscriber` demonstrates how to use the lightweight NAN Unsynchronized Service Discovery (NAN-USD) protocol to discover services advertised by nearby devices and interact with them. It covers enabling USD discovery, subscribing to services, handling follow-up exchanges, and terminating discovery after the session ends.
|
||||
|
||||
|
||||
@@ -518,6 +518,7 @@ After calling :cpp:func:`esp_isp_bf_configure`, you need to enable the ISP BF co
|
||||
|
||||
Calling :cpp:func:`esp_isp_bf_disable` does the opposite, that is, put the driver back to the **init** state.
|
||||
|
||||
|
||||
.. _isp-blc:
|
||||
|
||||
ISP BLC Controller
|
||||
|
||||
@@ -392,7 +392,7 @@ Application Examples
|
||||
- :example:`system/ulp/lp_core/lp_uart/lp_uart_echo` reads data written to a serial console and echoes it back. This example demonstrates the usage of the LP UART driver running on the LP core.
|
||||
- :example:`system/ulp/lp_core/lp_uart/lp_uart_print` shows how to print various statements from a program running on the LP core.
|
||||
- :example:`system/ulp/lp_core/lp_uart/lp_uart_char_seq_wakeup` shows how to trigger a wakeup using the LP UART specific character sequence wakeup mode.
|
||||
- :example:`system/ulp/lp_core/lp_mailbox` shows how to use the mailbox for both synchronous and asynchronous communication between the HP and LP cores. Depending on the target, the implementation may use the hardware mailbox controller (if available) or a pure software implementation based on software interrupts.
|
||||
- :example:`system/ulp/lp_core/lp_mailbox` shows how to use the mailbox for both synchronous and asynchronous communication between the HP and LP cores. Depending on the target, the implementation may use the hardware mailbox controller (if available) or a software-only implementation using interrupts.
|
||||
- :example:`system/ulp/lp_core/interrupt` shows how to register an interrupt handler on the LP core to receive an interrupt triggered by the main CPU.
|
||||
- :example:`system/ulp/lp_core/gpio_intr_pulse_counter` shows how to use GPIO interrupts to count pulses while the main CPU is in Deep-sleep mode.
|
||||
- :example:`system/ulp/lp_core/build_system/` demonstrates how to include custom ``CMakeLists.txt`` file for the ULP app.
|
||||
|
||||
@@ -78,7 +78,7 @@ Replace ``PRIO`` with an integer value. Lower values are executed earlier. This
|
||||
Changes in Configuration Files Syntax
|
||||
-------------------------------------
|
||||
|
||||
ESP-IDF v6 uses esp-idf-kconfig v3, which introduces several changes in the configuration (``Kconfig``) files. For the full list of changes, please refer to the `esp-idf-kconfig migration guide from v2.x to v3.x <https://docs.espressif.com/projects/esp-idf-kconfig/en/latest/developer-guide/migration-guide.html>`_.
|
||||
ESP-IDF v6 uses esp-idf-kconfig v3, which introduces several changes in the configuration (``Kconfig``) files. For the full list of changes, please refer to the `Migration Guide From esp-idf-kconfig v2.x to v3.x <https://docs.espressif.com/projects/esp-idf-kconfig/en/latest/developer-guide/migration-guide.html>`_.
|
||||
|
||||
Compiler Options
|
||||
----------------
|
||||
|
||||
@@ -57,7 +57,7 @@ This affects ESP-IDF users who use system-provided CMake and custom CMake.
|
||||
Unit-Test-App
|
||||
-------------
|
||||
|
||||
The legacy unit-test-app has been moved out of ESP-IDF repository as no ESP-IDF component longer uses it for running tests. It is now available at the `component registry <https://components.espressif.com/components/espressif/unit-test-app>`_ and a test app can be created using the ``idf.py create-project-from-example`` command:
|
||||
The legacy unit-test-app has been moved out of ESP-IDF repository as it is no longer used by any ESP-IDF component for running tests. It is now available at `The ESP Component Registry <https://components.espressif.com/components/espressif/unit-test-app>`__ and a test app can be created using the ``idf.py create-project-from-example`` command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -66,7 +66,7 @@ The legacy unit-test-app has been moved out of ESP-IDF repository as no ESP-IDF
|
||||
Catch
|
||||
-----
|
||||
|
||||
The header-only copy of Catch2 unit testing library previously located in tools/catch directory has been removed. To continue using Catch2 in your project, migrate to Catch2 3.x, available from the `ESP component registry <https://components.espressif.com/components/espressif/catch2>`_. For an example of migrating from Catch2 2.x to Catch2 3.x, see commit 79a2c15477dc327550ff46a64ee0f8b4679cc417.
|
||||
The header-only copy of Catch2 unit testing library previously located in tools/catch directory has been removed. To continue using Catch2 in your project, migrate to Catch2 3.x, available from `The ESP Component Registry <https://components.espressif.com/components/espressif/catch2>`__. For an example of migrating from Catch2 2.x to Catch2 3.x, see commit 79a2c15477dc327550ff46a64ee0f8b4679cc417.
|
||||
|
||||
Dropped ``idf.py size --legacy`` option
|
||||
---------------------------------------
|
||||
@@ -98,4 +98,3 @@ The ``--format json`` option has been replaced with ``--format json2``. The ``js
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
@@ -29,6 +29,7 @@ Mesh 核心
|
||||
* 私有信标
|
||||
* 子网桥
|
||||
* 次要增强
|
||||
* 设备固件更新（预览）
|
||||
|
||||
* 多个客户端模型同时运行
|
||||
* 支持多个客户端模型同时向不同节点发送数据包
|
||||
@@ -132,6 +133,14 @@ Mesh 模型
|
||||
* 灯光 LC 服务器
|
||||
* 灯光 LC 设置服务器
|
||||
|
||||
* 设备固件更新客户端模型
|
||||
* 固件更新客户端模型（预览）
|
||||
* 固件分发客户端模型（即将推出）
|
||||
|
||||
* 设备固件更新服务器模型
|
||||
* 固件更新服务器模型（预览）
|
||||
* 固件分发服务器模型（即将推出）
|
||||
|
||||
Mesh 示例
|
||||
"""""""""""
|
||||
|
||||
|
||||
@@ -18,6 +18,10 @@ Wi-Fi Aware\ :sup:`TM`，也可称为 NAN (Neighbor Awareness Networking) 协议
|
||||
|
||||
- :example:`wifi/wifi_aware/nan_subscriber` 演示如何使用 NAN 协议发现附近发布所需服务的其他设备，并通过发送消息或启动数据路径与它们进行通信。
|
||||
|
||||
- :example:`wifi/wifi_aware/usd_publisher` 演示了如何使用轻量级 NAN 非同步服务发现 (NAN-USD) 协议向附近设备发布服务而无需形成 NAN 集群。示例讲解了如何启动 USD、发布服务、通过后续消息响应订阅者，以及在发现完成后返回空闲状态。
|
||||
|
||||
- :example:`wifi/wifi_aware/usd_subscriber` 演示了如何使用轻量级 NAN 非同步服务发现 (NAN-USD) 协议发现附近设备发布的服务并与之交互。示例讲解了如何启用 USD 发现、订阅服务、处理后续消息交换，以及在会话结束后终止发现。
|
||||
|
||||
API 参考
|
||||
-------------
|
||||
|
||||
|
||||
@@ -399,7 +399,7 @@ ISP AE 控制器
|
||||
|
||||
.. code-block:: c
|
||||
|
||||
esp_isp_ae_config_t ae_config = {
|
||||
esp_isp_ae_config_t ae_config = {
|
||||
.sample_point = ISP_AE_SAMPLE_POINT_AFTER_DEMOSAIC,
|
||||
};
|
||||
isp_ae_ctlr_t ae_ctlr = NULL;
|
||||
|
||||
@@ -237,6 +237,7 @@ ULP LP 内核支持的外设
|
||||
* LP I2C
|
||||
* LP UART
|
||||
:SOC_LP_SPI_SUPPORTED: * LP SPI
|
||||
:SOC_LP_MAILBOX_SUPPORTED: * LP 邮箱
|
||||
|
||||
.. only:: CONFIG_ESP_ROM_HAS_LP_ROM
|
||||
|
||||
@@ -391,6 +392,7 @@ LP 内核调试特性
|
||||
- :example:`system/ulp/lp_core/lp_uart/lp_uart_echo` 展示了低功耗内核上运行的 LP UART 驱动程序如何读取并回显写入串行控制台的数据。
|
||||
- :example:`system/ulp/lp_core/lp_uart/lp_uart_print` 展示了如何在低功耗内核上使用串口打印功能。
|
||||
- :example:`system/ulp/lp_core/lp_uart/lp_uart_char_seq_wakeup` 展示了如何使用 LP UART 特定字符序列唤醒模式触发唤醒。
|
||||
- :example:`system/ulp/lp_core/lp_mailbox` 展示了如何在 HP 内核和 LP 内核之间使用邮箱进行同步和异步通信。根据目标设备的不同，示例实现可能会使用硬件邮箱控制器（如果可用），或者使用基于中断的纯软件实现。
|
||||
- :example:`system/ulp/lp_core/interrupt` 展示了如何在 LP 内核上注册中断处理程序，接收由主 CPU 触发的中断。
|
||||
- :example:`system/ulp/lp_core/gpio_intr_pulse_counter` 展示了如何在主 CPU 处于 Deep-sleep 模式时，使用 GPIO 中断为脉冲计数。
|
||||
- :example:`system/ulp/lp_core/build_system/` 演示了如何为 ULP 应用程序添加自定义的 ``CMakeLists.txt`` 文件。
|
||||
@@ -423,6 +425,7 @@ LP 内核 API 参考
|
||||
.. include-build-file:: inc/ulp_lp_core_gpio.inc
|
||||
.. include-build-file:: inc/ulp_lp_core_i2c.inc
|
||||
.. include-build-file:: inc/ulp_lp_core_uart.inc
|
||||
.. include-build-file:: inc/ulp_lp_core_mailbox.inc
|
||||
.. include-build-file:: inc/ulp_lp_core_print.inc
|
||||
.. include-build-file:: inc/ulp_lp_core_interrupts.inc
|
||||
|
||||
|
||||
@@ -79,3 +79,8 @@
|
||||
------------------
|
||||
|
||||
ESP-IDF v6 使用了 esp-idf-kconfig v3，对配置文件 ``Kconfig`` 的语法进行了若干变更。完整变更列表请参阅 `Migration Guide From esp-idf-kconfig v2.x to v3.x <https://docs.espressif.com/projects/esp-idf-kconfig/en/latest/developer-guide/migration-guide.html>`_。
|
||||
|
||||
编译器选项
|
||||
----------
|
||||
|
||||
默认的编译器警告将被视为报错。配置选项 :ref:`CONFIG_COMPILER_DISABLE_DEFAULT_ERRORS` 已被更改为 N。
|
||||
|
||||
@@ -54,6 +54,20 @@ CMake 版本升级
|
||||
|
||||
此变更影响所有使用系统自带 CMake 或自定义 CMake 的 ESP-IDF 用户。
|
||||
|
||||
Unit-Test-App
|
||||
-------------
|
||||
|
||||
旧版的 unit-test-app 已经从 ESP-IDF 仓库中移出，目前已无 ESP-IDF 组件使用该组件进行测试。现在可通过 `乐鑫组件注册表 <https://components.espressif.com/components/espressif/unit-test-app>`__ 获取 unit-test-app，并且可以使用 ``idf.py create-project-from-example`` 命令创建测试应用：
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
idf.py create-project-from-example espressif/unit-test-app:unit-test-app
|
||||
|
||||
Catch
|
||||
-----
|
||||
|
||||
之前位于 tools/catch 目录下的 Catch2 单元测试库（仅头文件）已被移除。若想在项目中继续使用 Catch2，请迁移至 Catch2 3.x，该版本可从 `乐鑫组件注册表 <https://components.espressif.com/components/espressif/catch2>`__ 中获取。关于从 Catch2 2.x 迁移到 Catch2 3.x 的示例，请参见 79a2c15477dc327550ff46a64ee0f8b4679cc417 中的提交记录。
|
||||
|
||||
移除 ``idf.py size --legacy`` 选项
|
||||
-------------------------------------
|
||||
|
||||
@@ -84,4 +98,3 @@ CMake 版本升级
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user