From 702ca8c07c270bf610f896807c402a93cb5efacc Mon Sep 17 00:00:00 2001 From: Jos Verlinde Date: Wed, 20 Aug 2025 22:00:11 +0200 Subject: [PATCH] docs/espnow: Document ESPNow.__init__ parameters. Signed-off-by: Jos Verlinde --- docs/library/espnow.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/library/espnow.rst b/docs/library/espnow.rst index 84e9e9465de96..3b3095a130811 100644 --- a/docs/library/espnow.rst +++ b/docs/library/espnow.rst @@ -96,11 +96,17 @@ class ESPNow Constructor ----------- -.. class:: ESPNow() +.. class:: ESPNow(buffer_size: int = 526, phy_rate: int = 0) Returns the singleton ESPNow object. As this is a singleton, all calls to `espnow.ESPNow()` return a reference to the same object. + .. data:: Arguments: + + - *buffer_size* (int) – The size of the internal ring buffer. Default: 526 bytes. + + - *phy_rate* (int) – The ESP-NOW physical layer rate (see wifi_phy_rate_t). Default: 0 (1 Mbps). + .. note:: Some methods are available only on the ESP32 due to code size restrictions on the ESP8266 and differences in the Espressif API.