Skip to content

Commit

Permalink
docs: update for esp32c6
Browse files Browse the repository at this point in the history
  • Loading branch information
Espressif-liuuuu authored and xuxiao111 committed May 31, 2023
1 parent 843107e commit ae425ec
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions docs/en/api-guides/coexist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/en/api-guides/wifi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1450,7 +1450,7 @@ Currently, the ESP-IDF supports the following protocol modes:
LR Compatibility
*************************

Since LR is Espressif-unique Wi-Fi mode, only ESP32 series chips devices (except esp32c2) can transmit and receive the LR data. In other words, the ESP32 series chips devices (except esp32c2) should NOT transmit the data in LR data rate if the connected device does not support LR. The application can achieve this by configuring suitable Wi-Fi mode. If the negotiated mode supports LR, the ESP32 series chips devices (except esp32c2) may transmit data in LR rate. Otherwise, ESP32 series chips devices (except esp32c2) will transmit all data in traditional Wi-Fi data rate.
Since LR is Espressif-unique Wi-Fi mode, only ESP32 chip series devices (except ESP32-C2) can transmit and receive the LR data. In other words, the ESP32 chip series devices (except ESP32-C2) should NOT transmit the data in LR data rate if the connected device does not support LR. The application can achieve this by configuring a suitable Wi-Fi mode. If the negotiated mode supports LR, the ESP32 chip series devices (except ESP32-C2) may transmit data in LR rate. Otherwise, ESP32 chip series devices (except ESP32-C2) will transmit all data in the traditional Wi-Fi data rate.

The following table depicts the Wi-Fi mode negotiation:

Expand Down Expand Up @@ -1504,7 +1504,7 @@ Currently, the ESP-IDF supports the following protocol modes:

- For LR-enabled AP of {IDF_TARGET_NAME}, it is incompatible with traditional 802.11 mode, because the beacon is sent in LR mode.
- For LR-enabled station of {IDF_TARGET_NAME} whose mode is NOT LR-only mode, it is compatible with traditional 802.11 mode.
- If both station and AP are ESP32 series chips devices (except esp32c2) and both of them have enabled LR mode, the negotiated mode supports LR.
- If both station and AP are ESP32 series chips devices (except ESP32-C2) and both of them have enabled LR mode, the negotiated mode supports LR.

If the negotiated Wi-Fi mode supports both traditional 802.11 mode and LR mode, it is the Wi-Fi driver's responsibility to automatically select the best data rate in different Wi-Fi modes and the application can ignore it.

Expand Down Expand Up @@ -1710,7 +1710,7 @@ Refer ESP-IDF example :idf_file:`examples/wifi/roaming/README.md` to set up and
- {IDF_TARGET_NAME} as FTM Initiator in station mode.
- {IDF_TARGET_NAME} as FTM Responder in AP mode.

Distance measurement using RTT is not accurate, and factors such as RF interference, multi-path travel, antenna orientation, and lack of calibration increase these inaccuracies. For better results, it is suggested to perform FTM between two ESP32 series chips devices (except esp32c2) as station and AP.
Distance measurement using RTT is not accurate, and factors such as RF interference, multi-path travel, antenna orientation, and lack of calibration increase these inaccuracies. For better results, it is suggested to perform FTM between two ESP32 chip series devices (except ESP32-C2) as station and AP.

Refer to ESP-IDF example :idf_file:`examples/wifi/ftm/README.md` for steps on how to set up and perform FTM.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/api-reference/network/esp_now.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Config ESP-NOW Rate

.. only:: esp32c6

Call :cpp:func:`esp_now_set_peer_rate_config()` to config ESPNOW rate of each peer. Make sure that the peer is added before config rate. This API should be called after :cpp:func:`esp_wifi_start()` and :cpp:func:`esp_now_add_peer()`.
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::

Expand Down
6 changes: 3 additions & 3 deletions docs/zh_CN/api-guides/coexist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 共存支持功能

Expand Down Expand Up @@ -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 状态下的长。为了确保蓝牙的性能,蓝牙的时间片也会做相应的调整。
Expand Down
6 changes: 3 additions & 3 deletions docs/zh_CN/api-guides/wifi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1450,7 +1450,7 @@ Wi-Fi 协议模式
LR 兼容性
*************************

由于 LR 是乐鑫的独有 Wi-Fi 模式,只有 ESP32 芯片系列设备(除了esp32c2)才能传输和接收 LR 数据。也就是说,如果连接的设备不支持 LR, ESP32 芯片系列设备(除了esp32c2)则不会以 LR 数据速率传输数据。可通过配置适当的 Wi-Fi 模式使您的应用程序实现这一功能。如果协商的模式支持 LR, ESP32 芯片系列设备(除了esp32c2)可能会以 LR 速率传输数据,否则, ESP32 芯片系列设备(除了esp32c2)将以传统 Wi-Fi 数据速率传输所有数据。
由于 LR 是乐鑫的独有 Wi-Fi 模式,只有 ESP32 芯片系列设备(除了ESP32-C2)才能传输和接收 LR 数据。也就是说,如果连接的设备不支持 LR, ESP32 芯片系列设备(除了ESP32-C2)则不会以 LR 数据速率传输数据。可通过配置适当的 Wi-Fi 模式使您的应用程序实现这一功能。如果协商的模式支持 LR, ESP32 芯片系列设备(除了ESP32-C2)可能会以 LR 速率传输数据,否则, ESP32 芯片系列设备(除了ESP32-C2)将以传统 Wi-Fi 数据速率传输所有数据。

下表是 Wi-Fi 模式协商:

Expand Down Expand Up @@ -1504,7 +1504,7 @@ Wi-Fi 协议模式

- 对于已使能 LR 的 {IDF_TARGET_NAME} AP,由于以 LR 模式发送 beacon,因此与传统的 802.11 模式不兼容。
- 对于已使能 LR 且并非仅 LR 模式的 {IDF_TARGET_NAME} station,与传统 802.11 模式兼容。
- 如果 station 和 AP 都是 ESP32 芯片系列设备(除了esp32c2),并且两者都使能 LR 模式,则协商的模式支持 LR。
- 如果 station 和 AP 都是 ESP32 芯片系列设备(除了ESP32-C2),并且两者都使能 LR 模式,则协商的模式支持 LR。

如果协商的 Wi-Fi 模式同时支持传统的 802.11 模式和 LR 模式,则 Wi-Fi 驱动程序会在不同的 Wi-Fi 模式下自动选择最佳数据速率,应用程序无需任何操作。

Expand Down Expand Up @@ -1710,7 +1710,7 @@ WPA2-Enterprise 是企业无线网络的安全认证机制。在连接到接入
- {IDF_TARGET_NAME} 在 station 模式下为 FTM 发起方。
- {IDF_TARGET_NAME} 在 AP 模式下为 FTM 响应方。

使用 RTT 的距离测量并不准确,RF 干扰、多径传播、天线方向和缺乏校准等因素会增加这些不准确度。为了获得更好的结果,建议在两个 ESP32 芯片系列设备(除了esp32c2)之间执行 FTM,这两个设备可分别设置为 station 和 AP 模式。
使用 RTT 的距离测量并不准确,RF 干扰、多径传播、天线方向和缺乏校准等因素会增加这些不准确度。为了获得更好的结果,建议在两个 ESP32 芯片系列设备(除了ESP32-C2)之间执行 FTM,这两个设备可分别设置为 station 和 AP 模式。

请参考 IDF 示例 :idf_file:`examples/wifi/ftm/README.md` 了解设置和执行 FTM 的详细步骤。

Expand Down

0 comments on commit ae425ec

Please sign in to comment.