pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update application examples for esp_now.rst and esp-wifi-mesh.rst

Browse Source
This commit is contained in:
Linda
2024-07-18 17:39:31 +08:00
committed by BOT
parent 14a2be6eed
commit 2136c072b5
4 changed files with 9 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/network/esp-wifi-mesh.rst
+3 -4
View File
@@ -302,12 +302,11 @@ Therefore, application calls to Wi-Fi APIs should be placed in between calls of
Application Examples
--------------------
ESP-IDF contains these ESP-WIFI-MESH example projects:
- :example:`mesh/internal_communication` demonstrates how to use the mesh APIs to establish a mesh network, configure it, start it, handle events, and send and receive messages across the network.
:example:`The Internal Communication Example <mesh/internal_communication>` demonstrates how to set up a ESP-WIFI-MESH network and have the root node send a data packet to every node within the network.
:example:`The Manual Networking Example <mesh/manual_networking>` demonstrates how to use ESP-WIFI-MESH without the self-organizing features. This example shows how to program a node to manually scan for a list of potential parent nodes and select a parent node based on custom criteria.
- :example:`mesh/ip_internal_network` demonstrates how to use mesh to create an IP capable sub-network where all nodes publish their IP and internal mesh layer to an MQTT broker while using internal communication.
- :example:`mesh/manual_networking` demonstrates how to manually configure a mesh network using ESP-MESH, including scanning for parent candidates, selecting a suitable parent for a node, and configuring network settings.
.. ------------------------- ESP-WIFI-MESH API Reference ---------------------------
docs/en/api-reference/network/esp_now.rst
+1 -3
View File
@@ -123,9 +123,7 @@ If Power-saving is needed for ESP-NOW, call :cpp:func:`esp_wifi_connectionless_m
Application Examples
--------------------
* Example of sending and receiving ESP-NOW data between two devices: :example:`wifi/espnow`.
* For more application examples of how to use ESP-NOW, please visit `ESP-NOW <https://github.com/espressif/esp-now>`_ repository.
- :example:`wifi/espnow` demonstrates how to use the ESPNOW feature of {IDF_TARGET_NAME}'s Wi-Fi, including starting Wi-Fi, initializing ESP-NOW, registering ESP-NOW sending or receiving callback function, adding ESP-NOW peer information, and sending and receiving ESP-NOW data between two devices.
API Reference
-------------