summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlessandro Gatti <a.gatti@frob.it>2025-02-15 00:58:01 +0100
committerDamien George <damien@micropython.org>2025-03-05 16:15:31 +1100
commit4d034f817c861b90cbe7ab0cb59d85036031750f (patch)
treef8c8162a91376b12a66cb44245ca56de3f18c339 /docs
parent6fba1e406bde7ddf00f7cf52bd8c44764c8a1a97 (diff)
esp8266/network_wlan: Allow enumerating connected stations in AP mode.
This commit introduces the ability to obtain a list of stations connected to the device when in soft-AP mode. A new parameter ("stations") to pass to WLAN.status is supported, returning a tuple of (bssid, ipv4) entries, one per connected station. An empty tuple is returned if no stations are connected, and an exception is raised if an error occurred whilst building the python objects to return to the interpreter. Documentation is also updated to cover the new parameter. This fixes #5395. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>
Diffstat (limited to 'docs')
-rw-r--r--docs/library/network.WLAN.rst13
1 files changed, 12 insertions, 1 deletions
diff --git a/docs/library/network.WLAN.rst b/docs/library/network.WLAN.rst
index 09fefc592..ee0ef490f 100644
--- a/docs/library/network.WLAN.rst
+++ b/docs/library/network.WLAN.rst
@@ -85,7 +85,18 @@ Methods
* ``STAT_GOT_IP`` -- connection successful.
When called with one argument *param* should be a string naming the status
- parameter to retrieve. Supported parameters in WiFI STA mode are: ``'rssi'``.
+ parameter to retrieve, and different parameters are supported depending on the
+ mode the WiFi is in.
+
+ In STA mode, passing ``'rssi'`` returns a signal strength indicator value, whose
+ format varies depending on the port (this is available on all ports that support
+ WiFi network interfaces, except for CC3200).
+
+ In AP mode, passing ``'stations'`` returns a list of connected WiFi stations
+ (this is available on all ports that support WiFi network interfaces, except for
+ CC3200). The format of the station information entries varies across ports,
+ providing either the raw BSSID of the connected station, the IP address of the
+ connected station, or both.
.. method:: WLAN.isconnected()