blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-10 01:29:21 -04:00
Code Issues Projects Releases Wiki Activity

Merge branch 'doc/update_espnow_doc' into 'master'

Browse Source 
docs(wifi/espnow): update the documentation for EPS-NOW ERSU and phy rate

Closes IDFGH-11035, DOC-3366, WIFI-6682, and DOC-8550

See merge request espressif/esp-idf!31285
This commit is contained in:
Jiang Jiang Jian 2024-10-24 15:17:00 +08:00
commit dcc31f89f7
7 changed files with 601 additions and 454 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
components/esp_wifi/include/esp_mesh.h
View File

@ -637,7 +637,8 @@ esp_err_t esp_mesh_stop(void);
* @param[in] to the address of the final destination of the packet
* - If the packet is to the root, set this parameter to NULL.
* - If the packet is to an external IP network, set this parameter to the IPv4:PORT combination.
* This packet will be delivered to the root firstly, then the root will forward this packet to the final IP server address.
* This packet will be delivered to the root firstly, then users need to call esp_mesh_recv_toDS() on the root node to forward this
* packet to the final IP server address.
* @param[in] data pointer to a sending mesh packet
* - Field size should not exceed MESH_MPS. Note that the size of one mesh packet should not exceed MESH_MTU.
* - Field proto should be set to data protocol in use (default is MESH_PROTO_BIN for binary).

3
components/esp_wifi/include/esp_now.h
View File

@ -99,7 +99,8 @@ typedef struct esp_now_recv_info {
typedef struct esp_now_rate_config {
wifi_phy_mode_t phymode; /**< ESPNOW phymode of specified interface */
wifi_phy_rate_t rate; /**< ESPNOW rate of specified interface */
bool ersu; /**< ESPNOW using ersu send frame*/
bool ersu; /**< ESPNOW using ERSU to send frame, ERSU is a transmission mode related to 802.11 ax.
ERSU is always used in long distance transmission, and its frame has lower rate compared with SU mode */
bool dcm; /**< ESPNOW using dcm rate to send frame */
} esp_now_rate_config_t;

1007
components/esp_wifi/include/esp_wifi_types_generic.h
View File

File diff suppressed because it is too large Load Diff

2
components/esp_wifi/lib

@ -1 +1 @@
Subproject commit 42ac37a6531cf91d94b57f65e5738d912d504680
Subproject commit e9aa24f016bcab62a9454f8d69db85f949eacc57

2
docs/doxygen/Doxyfile
View File

@ -212,10 +212,12 @@ INPUT = \
$(PROJECT_PATH)/components/esp_wifi/include/esp_mesh.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_now.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_smartconfig.h \
$(PROJECT_PATH)/components/esp_wifi/include/local/esp_wifi_types_native.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_ap_get_sta_list.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_crypto_types.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_default.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_netif.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_types_generic.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_types.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi.h \
$(PROJECT_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_mbo.h \

1
docs/en/api-reference/network/esp_wifi.rst
View File

@ -28,6 +28,7 @@ API Reference
.. include-build-file:: inc/esp_wifi.inc
.. include-build-file:: inc/esp_wifi_types.inc
.. include-build-file:: inc/esp_wifi_types_generic.inc
.. include-build-file:: inc/esp_eap_client.inc
.. include-build-file:: inc/esp_wps.inc
.. include-build-file:: inc/esp_rrm.inc

1
docs/zh_CN/api-reference/network/esp_wifi.rst
View File

@ -28,6 +28,7 @@ API 参考
.. include-build-file:: inc/esp_wifi.inc
.. include-build-file:: inc/esp_wifi_types.inc
.. include-build-file:: inc/esp_wifi_types_generic.inc
.. include-build-file:: inc/esp_eap_client.inc
.. include-build-file:: inc/esp_wps.inc
.. include-build-file:: inc/esp_rrm.inc