Skip to content

Commit 439840b

Browse files
committed
Merge branch 'feat/espnow-library' of ssh://github.com/P-R-O-C-H-Y/arduino-esp32 into feat/espnow-library
2 parents ad193ae + 14f19be commit 439840b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Diff for: docs/en/api/espnow.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ About
77

88
ESP-NOW is a communication protocol designed for low-power, low-latency, and high-throughput communication between ESP32 devices without the need for an access point (AP).
99
It is ideal for scenarios where devices need to communicate directly with each other in a local network.
10-
ESP-NOW is ideal for smart lights, remote control devices, sensors and other applications.
10+
ESP-NOW can be used for smart lights, remote control devices, sensors and many other applications.
1111

1212
This library provides an easy-to-use interface for setting up ESP-NOW communication, adding and removing peers, and sending and receiving data packets.
1313

@@ -91,7 +91,7 @@ You can register a callback function to handle incoming data from new peers usin
9191
ESP-NOW Peer Class
9292
******************
9393

94-
The `ESP_NOW_Peer` class represents a peer device in the ESP-NOW network.
94+
The `ESP_NOW_Peer` class represents a peer device in the ESP-NOW network. It is an abstract class that must be inherited by a child class that properly handles the peer connections and implements the `_onReceive` and `_onSent` methods.
9595

9696
Constructor
9797
^^^^^^^^^^^
@@ -234,7 +234,7 @@ Set the local master key (LMK) for the peer.
234234
_onReceive
235235
^^^^^^^^^^
236236

237-
Callback function to handle incoming data from the peer, must be implemented by the upper class.
237+
Callback function to handle incoming data from the peer. This is a pure virtual method that must be implemented by the upper class.
238238

239239
.. code-block:: cpp
240240
@@ -247,7 +247,7 @@ Callback function to handle incoming data from the peer, must be implemented by
247247
_onSent
248248
^^^^^^^
249249

250-
Callback function to handle the completion of sending data to the peer, must be implemented by the upper class.
250+
Callback function to handle the completion of sending data to the peer. This is a pure virtual method that must be implemented by the upper class.
251251

252252
.. code-block:: cpp
253253
@@ -258,7 +258,7 @@ Callback function to handle the completion of sending data to the peer, must be
258258
Examples
259259
--------
260260

261-
Set of 2 examples of the ESP-NOW library to send and receive data between multiple ESP32 devices (1 master, multiple slaves).
261+
Set of 2 examples of the ESP-NOW library to send and receive data using broadcast messages between multiple ESP32 devices (multiple masters, multiple slaves).
262262

263263
1. ESP-NOW Broadcast Master Example:
264264

@@ -270,7 +270,7 @@ Set of 2 examples of the ESP-NOW library to send and receive data between multip
270270
.. literalinclude:: ../../../libraries/ESP_NOW/examples/ESP_NOW_Broadcast_Slave/ESP_NOW_Broadcast_Slave.ino
271271
:language: cpp
272272

273-
Example of the ESP-NOW Serial library to send and receive data between 2 ESP32 devices using the serial port:
273+
Example of the ESP-NOW Serial library to send and receive data as a stream between 2 ESP32 devices using the serial monitor:
274274

275275
.. literalinclude:: ../../../libraries/ESP_NOW/examples/ESP_NOW_Serial/ESP_NOW_Serial.ino
276276
:language: cpp

0 commit comments

Comments
 (0)