mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
update wifi api docs
This commit is contained in:
zhangyanjiao
Jack
parent
59af19b502
commit
e3b8f59867
@ -182,7 +182,7 @@ esp_err_t esp_now_unregister_send_cb(void);
|
||||
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
||||
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
||||
* - ESP_ERR_ESPNOW_INTERNAL : internal error
|
||||
* - ESP_ERR_ESPNOW_NO_MEM : out of memory
|
||||
* - ESP_ERR_ESPNOW_NO_MEM : out of memory, when this happens, you can delay a while before sending the next data
|
||||
* - ESP_ERR_ESPNOW_NOT_FOUND : peer is not found
|
||||
* - ESP_ERR_ESPNOW_IF : current WiFi interface doesn't match that of peer
|
||||
*/
|
||||
|
||||
@ -496,7 +496,7 @@ esp_err_t esp_wifi_get_ps(wifi_ps_type_t *type);
|
||||
* @brief Set protocol type of specified interface
|
||||
* The default protocol is (WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N)
|
||||
*
|
||||
* @attention Currently we only support 802.11b or 802.11bg or 802.11bgn mode
|
||||
* @attention Support 802.11b or 802.11bg or 802.11bgn or LR mode
|
||||
*
|
||||
* @param ifx interfaces
|
||||
* @param protocol_bitmap WiFi protocol bitmap
|
||||
|
||||
@ -5,6 +5,7 @@ Wi-Fi Driver
|
||||
|
||||
{IDF_TARGET_NAME} Wi-Fi Feature List
|
||||
------------------------------------
|
||||
- Support 4 virtual WiFi interfaces, which are 4 STA, AP, Sniffer and reserved.
|
||||
- Support station-only mode, AP-only mode, station/AP-coexistence mode
|
||||
- Support IEEE 802.11b, IEEE 802.11g, IEEE 802.11n, and APIs to configure the protocol mode
|
||||
- Support WPA/WPA2/WPA3/WPA2-Enterprise and WPS
|
||||
@ -1130,12 +1131,16 @@ Currently, the ESP-IDF supports the following protocol modes:
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B) to set the station/AP to 802.11b-only mode.
|
||||
* - 802.11bg
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G) to set the station/AP to 802.11bg mode.
|
||||
* - 802.11g
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G) and esp_wifi_config_11b_rate(ifx, true) to set the station/AP to 802.11g mode.
|
||||
* - 802.11bgn
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B| WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N) to set the station/ AP to BGN mode.
|
||||
* - 802.11gn
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N) and esp_wifi_config_11b_rate(ifx, true) to set the station/AP to 802.11gn mode.
|
||||
* - 802.11 BGNLR
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B| WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N|WIFI_PROTOCOL_LR) to set the station/AP to BGN and the Espressif-specific mode.
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B| WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N|WIFI_PROTOCOL_LR) to set the station/AP to BGN and the LR mode.
|
||||
* - 802.11 LR
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_LR) to set the station/AP only to the Espressif-specific mode.
|
||||
- Call esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_LR) to set the station/AP only to the LR mode.
|
||||
|
||||
**This mode is an Espressif-patented mode which can achieve a one-kilometer line of sight range. Please make sure both the station and the AP are connected to an ESP device.**
|
||||
|
||||
@ -1198,7 +1203,7 @@ The reception sensitivity gain of LR is about 4 dB larger than that of the tradi
|
||||
LR Throughput
|
||||
*************************
|
||||
|
||||
The LR rate has very limited throughput, because the raw PHY data rates are 1/2 Mbits and 1/4 Mbits.
|
||||
The LR rate has very limited throughput, because the raw PHY data rate LR is 1/2 Mbps and 1/4 Mbps.
|
||||
|
||||
When to Use LR
|
||||
*************************
|
||||
@ -1581,8 +1586,9 @@ Preconditions of Using :cpp:func:`esp_wifi_80211_tx`
|
||||
Data Rate
|
||||
+++++++++++++++++++++++++++++++++++++++++++++++
|
||||
|
||||
- If there is no Wi-Fi connection, the data rate is 1 Mbps.
|
||||
- If there is Wi-Fi connection and the packet is from station to AP or from AP to station, the data rate is the same as the Wi-Fi connection. Otherwise the data rate is 1 Mbps.
|
||||
- The default data rate is 1 Mbps.
|
||||
- Can set any rate through :cpp:func:`esp_wifi_config_80211_tx_rate` API.
|
||||
- Can set any bandwidth through :cpp:func:`esp_wifi_set_bandwidth` API.
|
||||
|
||||
Side-Effects to Avoid in Different Scenarios
|
||||
+++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
|
||||
@ -64,8 +64,14 @@ When ``esp_now_deinit()`` is called, all of the information of paired devices wi
|
||||
Add Paired Device
|
||||
-----------------
|
||||
|
||||
Call ``esp_now_add_peer()`` to add the device to the paired device list before you send data to this device. The maximum number of paired devices is twenty. If security is enabled, the LMK must be set. You can send ESP-NOW data via both the Station and the SoftAP interface.
|
||||
Make sure that the interface is enabled before sending ESP-NOW data. A device with a broadcast MAC address must be added before sending broadcast data. The range of the channel of paired devices is from 0 to 14. If the channel is set to 0, data will be sent on the current channel. Otherwise, the channel must be set as the channel that the local device is on.
|
||||
Call ``esp_now_add_peer()`` to add the device to the paired device list before you send data to this device. If security is enabled, the LMK must be set. You can send ESP-NOW data via both the Station and the SoftAP interface. Make sure that the interface is enabled before sending ESP-NOW data.
|
||||
.. only:: esp32c2
|
||||
The maximum number of paired devices is 20, and the paired encryption devices are no more than 4, the default is 2.
|
||||
.. only:: esp32c3
|
||||
The maximum number of paired devices is 20, and the paired encryption devices are no more than 10, the default is 6.
|
||||
.. only:: esp32 or esp32s2 esp32s3
|
||||
The maximum number of paired devices is 20, and the paired encryption devices are no more than 16, the default is 6.
|
||||
A device with a broadcast MAC address must be added before sending broadcast data. The range of the channel of paired devices is from 0 to 14. If the channel is set to 0, data will be sent on the current channel. Otherwise, the channel must be set as the channel that the local device is on.
|
||||
|
||||
Send ESP-NOW Data
|
||||
-----------------
|
||||
|
||||
@ -5,6 +5,7 @@
|
||||
|
||||
{IDF_TARGET_NAME} Wi-Fi 功能列表
|
||||
------------------------------------
|
||||
- 支持 4 个虚拟接口，即STA、AP、Sniffer 和 reserved。
|
||||
- 支持仅 station 模式、仅 AP 模式、station/AP 共存模式
|
||||
- 支持使用 IEEE 802.11b、IEEE 802.11g、IEEE 802.11n 和 API 配置协议模式
|
||||
- 支持 WPA/WPA2/WPA3/WPA2-企业版和 WPS
|
||||
@ -1130,20 +1131,24 @@ Wi-Fi 协议模式
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B)，将 station/AP 设置为仅 802.11b 模式。
|
||||
* - 802.11bg
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G)，将 station/AP 设置为 802.11bg 模式。
|
||||
* - 802.11g
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G) 和 esp_wifi_config_11b_rate(ifx, true)，将 station/AP 设置为 802.11g 模式。
|
||||
* - 802.11bgn
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N)，将 station/AP 设置为 802.11bgn 模式。
|
||||
* - 802.11gn
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N) 和 esp_wifi_config_11b_rate(ifx, true)，将 station/AP 设置为 802.11gn 模式。
|
||||
* - 802.11 BGNLR
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N|WIFI_PROTOCOL_LR)，将 station/AP 设置为 802.11bgn 和乐鑫专属模式。
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N|WIFI_PROTOCOL_LR)，将 station/AP 设置为 802.11bgn 和 LR 模式。
|
||||
* - 802.11 LR
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_LR)，将 station/AP 设置为仅乐鑫专属模式。
|
||||
- 调用函数 esp_wifi_set_protocol(ifx, WIFI_PROTOCOL_LR)，将 station/AP 设置为 LR 模式。
|
||||
|
||||
**此模式是乐鑫的专利模式，可以达到 1 公里视线范围。请确保 station 和 AP 同时连接至 ESP 设备。**
|
||||
|
||||
|
||||
远程 (LR)
|
||||
长距离 (LR)
|
||||
+++++++++++++++++++++++++
|
||||
|
||||
远程 (LR) 模式是乐鑫的一项专利 Wi-Fi 模式，可达到 1 公里视线范围。与传统 802.11b 模式相比，接收灵敏度更高，抗干扰能力更强，传输距离更长。
|
||||
长距离 (LR) 模式是乐鑫的一项专利 Wi-Fi 模式，可达到 1 公里视线范围。与传统 802.11b 模式相比，接收灵敏度更高，抗干扰能力更强，传输距离更长。
|
||||
|
||||
LR 兼容性
|
||||
*************************
|
||||
@ -1198,7 +1203,7 @@ LR 的接收灵敏度比传统的 802.11b 模式高 4 dB，理论上，传输距
|
||||
LR 吞吐量
|
||||
*************************
|
||||
|
||||
因为原始 PHY 数据传输速率为 1/2 Mbit 和 1/4 Mbit，LR 的吞吐量有限。
|
||||
因为原始 PHY 数据传输速率为 1/2 Mbps 和 1/4 Mbps，LR 的吞吐量有限。
|
||||
|
||||
何时使用 LR
|
||||
*************************
|
||||
@ -1581,8 +1586,9 @@ Wi-Fi 80211 数据包发送
|
||||
传输速率
|
||||
+++++++++++++++++++++++++++++
|
||||
|
||||
- 如果没有 Wi-Fi 连接，传输速率为 1 Mbps。
|
||||
- 如果有 Wi-Fi 连接，且数据包是从 station 到 AP 或从 AP 到 station，则传输速率与 Wi-Fi 连接相同。否则，传输速率为 1 Mbps。
|
||||
- 默认传输速率为 1 Mbps。
|
||||
- 可以通过函数 :cpp:func:`esp_wifi_config_80211_tx_rate` 设置任意速率。
|
||||
- 可以通过函数 :cpp:func:`esp_wifi_set_bandwidth` 设置任意带宽。
|
||||
|
||||
在不同情况下需要避免的副作用
|
||||
+++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
|
||||
@ -64,8 +64,14 @@ ESP-NOW 采用 CCMP 方法保护供应商特定动作帧的安全，具体可参
|
||||
添加配对设备
|
||||
-----------------
|
||||
|
||||
在将数据发送到其他设备之前，请先调用 ``esp_now_add_peer()`` 将其添加到配对设备列表中。配对设备的最大数量是 20。如果启用了加密，则必须设置 LMK。ESP-NOW 数据可以从 Station 或 Softap 接口发送。
|
||||
确保在发送 ESP-NOW 数据之前已启用该接口。在发送广播数据之前必须添加具有广播 MAC 地址的设备。配对设备的信道范围是从 0 ～14。如果信道设置为 0，数据将在当前信道上发送。否则，必须使用本地设备所在的通道。
|
||||
在将数据发送到其他设备之前，请先调用 ``esp_now_add_peer()`` 将其添加到配对设备列表中。如果启用了加密，则必须设置 LMK。ESP-NOW 数据可以从 Station 或 Softap 接口发送。确保在发送 ESP-NOW 数据之前已启用该接口。
|
||||
.. only:: esp32c2
|
||||
配对设备的最大数量是 20，其中加密设备的数量不超过 4，默认值是 2。
|
||||
.. only:: esp32c3
|
||||
配对设备的最大数量是 20，其中加密设备的数量不超过 10，默认值是 6。
|
||||
.. only:: esp32 or esp32s2 or esp32s3
|
||||
配对设备的最大数量是 20，其中加密设备的数量不超过 16，默认值是 6。
|
||||
在发送广播数据之前必须添加具有广播 MAC 地址的设备。配对设备的信道范围是从 0 ～14。如果信道设置为 0，数据将在当前信道上发送。否则，必须使用本地设备所在的通道。
|
||||
|
||||
发送 ESP-NOW 数据
|
||||
-----------------
|
||||
|
||||
Loading…
Reference in New Issue
Block a user