From 58f18216ed27860239ad4f923a68d98564b18c1a Mon Sep 17 00:00:00 2001 From: Linda Date: Wed, 31 Jul 2024 16:49:22 +0800 Subject: [PATCH] docs: add application examples for phy.rst --- docs/en/api-guides/phy.rst | 9 +++++++++ docs/zh_CN/api-guides/phy.rst | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/en/api-guides/phy.rst b/docs/en/api-guides/phy.rst index e0a17c1fa2..d5b4dfb214 100644 --- a/docs/en/api-guides/phy.rst +++ b/docs/en/api-guides/phy.rst @@ -102,3 +102,12 @@ Recommended Scenarios for Using Multiple Antennas 1. Applications can either select specified antennas or implement their own antenna selection algorithms based on collected information, such as selecting antenna modes according to application-specific criteria. Refer to the IDF example :idf_file:`examples/phy/antenna/README.md` for designing antenna selection algorithms. 2. Configure antenna modes for both receiving and sending data as ``ESP_PHY_ANT_MODE_ANT0`` or ``ESP_PHY_ANT_MODE_ANT1``. + +Application Examples +-------------------- + +.. only:: esp32c3 or esp32s3 + + - :example:`phy/cert_test` demonstrates how to use the Certification Test APIs on {IDF_TARGET_NAME}, including project configuration as well as executing RF, Wi-Fi, and Bluetooth certification tests. + +- :example:`phy/antenna` demonstrates how to use multi-antenna software switching for {IDF_TARGET_NAME}. diff --git a/docs/zh_CN/api-guides/phy.rst b/docs/zh_CN/api-guides/phy.rst index e1a77005f2..1ff5a01b7a 100644 --- a/docs/zh_CN/api-guides/phy.rst +++ b/docs/zh_CN/api-guides/phy.rst @@ -102,3 +102,12 @@ PHY 1.应用程序可以始终选择指定的天线，也可以执行自身天线选择算法，如根据应用程序收集的信息来选择天线模式等。请参考 IDF 示例 :idf_file:`examples/phy/antenna/README.md` 来设计天线选择算法。 2.接收/发送数据的天线模式均配置为 ``ESP_PHY_ANT_MODE_ANT0`` 或 ``ESP_PHY_ANT_MODE_ANT1``。 + +应用示例 +-------------------- + +.. only:: esp32c3 or esp32s3 + + - :example:`phy/cert_test` 演示了如何在 {IDF_TARGET_NAME} 上使用认证测试 API，包括项目配置以及进行 RF、Wi-Fi 和 Bluetooth 认证测试。 + +- :example:`phy/antenna` 演示了如何在 {IDF_TARGET_NAME} 上进行多天线软件切换。