diff options
| author | Alessandro Gatti <a.gatti@frob.it> | 2025-02-10 17:20:29 +0100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2025-02-11 16:23:35 +1100 |
| commit | 3b6252466139d5dfc7458eeea5d759b6c9850146 (patch) | |
| tree | ab11dcb76e71ec93ac53c9c9da2288325f1d1694 | |
| parent | 0a55f1f40c8a0a69f34f550d45138d9ba7a1d467 (diff) | |
docs/library/espnow: Clarify usage of the "rate" configuration key.
This commit adds a clarification for the ESPNow module's documentation
regarding its "config" method.
The original documentation for that method could be interpreted as having
all its configuration keys being able to be queried, but the "rate"
configuration key is actually write-only due to ESP-IDF's lack of a way to
retrieve that bit of information from the radio's configuration. The
documentation changes highlight the fact that said configuration key is
actually write-only.
Signed-off-by: Alessandro Gatti <a.gatti@frob.it>
| -rw-r--r-- | docs/library/espnow.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/library/espnow.rst b/docs/library/espnow.rst index 379e60486..84e9e9465 100644 --- a/docs/library/espnow.rst +++ b/docs/library/espnow.rst @@ -164,11 +164,13 @@ Configuration wait forever. The timeout can also be provided as arg to `recv()`/`irecv()`/`recvinto()`. - *rate*: (ESP32 only, IDF>=4.3.0 only) Set the transmission speed for + *rate*: (ESP32 only) Set the transmission speed for ESPNow packets. Must be set to a number from the allowed numeric values in `enum wifi_phy_rate_t - <https://docs.espressif.com/projects/esp-idf/en/v4.4.1/esp32/ - api-reference/network/esp_wifi.html#_CPPv415wifi_phy_rate_t>`_. + <https://docs.espressif.com/projects/esp-idf/en/v5.2.3/esp32/ + api-reference/network/esp_wifi.html#_CPPv415wifi_phy_rate_t>`_. This + parameter is actually *write-only* due to ESP-IDF not providing any + means for querying the radio interface's rate parameter. .. data:: Returns: |