Merge branch 'docs/update_esp32c6_wifi_api_guides' into 'master'

docs: update esp32c6 api guides about wifi part See merge request espressif/esp-idf!23865
espressif · May 31, 2023 · a275a1c · a275a1c
2 parents aed0e36 + ae425ec
commit a275a1c
Show file tree

Hide file tree

Showing 8 changed files with 465 additions and 72 deletions.
diff --git a/docs/conf_common.py b/docs/conf_common.py
@@ -238,7 +238,7 @@
 project_slug = 'esp-idf'
 versions_url = 'https://dl.espressif.com/dl/esp-idf/idf_versions.js'
 
-idf_targets = ['esp32', 'esp32s2', 'esp32s3', 'esp32c3', 'esp32c2']
+idf_targets = ['esp32', 'esp32s2', 'esp32s3', 'esp32c3', 'esp32c2', 'esp32c6']
 languages = ['en', 'zh_CN']
 
 google_analytics_id = os.environ.get('CI_GOOGLE_ANALYTICS_ID', None)

diff --git a/docs/docs_not_updated/esp32c6.txt b/docs/docs_not_updated/esp32c6.txt
@@ -1,14 +1,5 @@
-api-guides/coexist
-api-guides/wifi
-api-guides/esp-wifi-mesh
-api-guides/wifi-security
 api-guides/openthread
 api-reference/network
 api-reference/network/esp_openthread
-api-reference/network/esp_dpp
-api-reference/network/esp_now
-api-reference/network/esp-wifi-mesh
-api-reference/network/esp_smartconfig
-api-reference/network/esp_wifi
 api-reference/network/index
 api-reference/protocols/esp_spi_slave_protocol
diff --git a/docs/en/api-guides/coexist.rst b/docs/en/api-guides/coexist.rst
@@ -10,7 +10,7 @@ Overview
 
 Supported Coexistence Scenario for {IDF_TARGET_NAME}
 ---------------------------------------------------------------------
-.. only:: esp32c3 or esp32s3 or esp32
+.. only:: esp32c3 or esp32s3 or esp32 or esp32c6
 
   .. table:: Supported Features of Wi-Fi and BLE Coexistence
 
@@ -122,15 +122,15 @@ Coexistence Period and Time Slice
   Wi-Fi, BT, and BLE have their fixed time slice to use the RF. A coexistence period is divided into 3 time slices in the order of Wi-Fi, BT, and BLE. In the Wi-Fi slice, Wi-Fi's request to the coexistence arbitration module will have higher priority. Similarly, BT/BLE can enjoy higher priority at their own time slices. The duration of the coexistence period and the proportion of each time slice are divided into four categories according to the Wi-Fi status:
 
 
-.. only:: esp32c3 or esp32s3
+.. only:: esp32c3 or esp32s3 or esp32c6
 
   Wi-Fi and BLE have their fixed time slice to use the RF. In the Wi-Fi time slice, Wi-Fi will send a higher priority request to the coexistence arbitration module. Similarly, BLE can enjoy higher priority at their own time slice. The duration of the coexistence period and the proportion of each time slice are divided into four categories according to the Wi-Fi status:
 
 
 .. list::
 
   :esp32: 1) IDLE status: the coexistence of BT and BLE is controlled by Bluetooth module.
-  :esp32c3 or esp32s3: 1) IDLE status: RF module is controlled by Bluetooth module.
+  :esp32c3 or esp32s3 or esp32c6: 1) IDLE status: RF module is controlled by Bluetooth module.
   #) CONNECTED status: the coexistence period starts at the Target Beacon Transmission Time (TBTT) and is more than 100 ms.
   #) SCAN status: Wi-Fi slice and coexistence period are longer than in the CONNECTED status. To ensure Bluetooth performance, the Bluetooth time slice will also be adjusted accordingly.
   #) CONNECTING status: Wi-Fi slice is longer than in the CONNECTED status. To ensure Bluetooth performance, the Bluetooth time slice will also be adjusted accordingly.

diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst
diff --git a/docs/en/api-reference/network/esp_now.rst b/docs/en/api-reference/network/esp_now.rst
@@ -70,7 +70,7 @@ Call :cpp:func:`esp_now_add_peer()` to add the device to the paired device list
 
     The maximum number of paired devices is 20, and the paired encryption devices are no more than 4, the default is 2. If you want to change the number of paired encryption devices, set :ref:`CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM` in the Wi-Fi component configuration menu.
 
-.. only:: esp32 or esp32s2 or esp32s3 or esp32c3
+.. only:: esp32 or esp32s2 or esp32s3 or esp32c3 or esp32c6
 
     The maximum number of paired devices is 20, and the paired encryption devices are no more than 17, the default is 7. If you want to change the number of paired encryption devices, set :ref:`CONFIG_ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM` in the Wi-Fi component configuration menu.
 
@@ -92,7 +92,17 @@ Instead, post the necessary data to a queue and handle it from a lower priority
 Config ESP-NOW Rate
 -------------------
 
-Call :cpp:func:`esp_wifi_config_espnow_rate()` to config ESPNOW rate of specified interface. Make sure that the interface is enabled before config rate. This API should be called after :cpp:func:`esp_wifi_start()`.
+.. only:: esp32 or esp32s2 or esp32s3 or esp32c2 or esp32c3
+
+    Call :cpp:func:`esp_wifi_config_espnow_rate()` to config ESPNOW rate of specified interface. Make sure that the interface is enabled before config rate. This API should be called after :cpp:func:`esp_wifi_start()`.
+
+.. only:: esp32c6
+
+    Call :cpp:func:`esp_now_set_peer_rate_config()` to configure ESP-NOW rate of each peer. Make sure that the peer is added before configuring the rate. This API should be called after :cpp:func:`esp_wifi_start()` and :cpp:func:`esp_now_add_peer()`.
+
+    .. note::
+
+        :cpp:func:`esp_wifi_config_espnow_rate()` is deprecated, please use cpp::func:`esp_now_set_peer_rate_config()` instead.
 
 Config ESP-NOW Power-saving Parameter
 --------------------------------------------

diff --git a/docs/zh_CN/api-guides/coexist.rst b/docs/zh_CN/api-guides/coexist.rst
@@ -10,7 +10,7 @@ RF 共存
 
 {IDF_TARGET_NAME} 支持的共存场景
 ------------------------------------
-.. only:: esp32c3 or esp32s3 or esp32
+.. only:: esp32c3 or esp32s3 or esp32 or esp32c6
 
   .. table:: 表 1  Wi-Fi 和 BLE 共存支持功能
 
@@ -122,15 +122,15 @@ RF 共存
   Wi-Fi、BT、BLE 三者对于 RF 的使用，主要是按照时间片来划分的。在一个共存周期内，按照 Wi-Fi、BT、BLE 的顺序划分时间片。在 Wi-Fi 的时间片内，Wi-Fi 会向共存仲裁模块发出较高优先级的请求，同理，BT/BLE 在自己的时间片内会具有较高优先级。共存周期大小和各个时间片占比根据 Wi-Fi 的状态分成四类：
 
 
-.. only:: esp32c3 or esp32s3
+.. only:: esp32c3 or esp32s3 or esp32c6
 
   Wi-Fi、BLE 二者对于 RF 的使用，主要是按照时间片来划分的。在 Wi-Fi 的时间片内，Wi-Fi 会向共存仲裁模块发出较高优先级的请求，在 Bluetooth 的时间片内，BLE 会具有较高优先级。共存周期大小和各个时间片占比根据 Wi-Fi 的状态分成四类：
 
 
 .. list::
 
   :esp32: 1) IDLE 状态：BT 和 BLE 共存由 Bluetooth 模块控制。
-  :esp32c3 or esp32s3: 1) IDLE 状态：RF 模块由 Bluetooth 模块控制。
+  :esp32c3 or esp32s3 or esp32c6: 1) IDLE 状态：RF 模块由 Bluetooth 模块控制。
   #) CONNECTED 状态：共存周期以目标信标传输时间 (Target Beacon Transmission Time, TBTT) 点为起始点，周期大于 100 ms。
   #) SCAN 状态：Wi-Fi 时间片以及共存周期都比在 CONNECTED 状态下的长。为了确保蓝牙的性能，蓝牙的时间片也会做相应的调整。
   #) CONNECTING 状态：Wi-Fi 时间片比在 CONNECTED 状态下的长。为了确保蓝牙的性能，蓝牙的时间片也会做相应的调整。