diff options
| author | Damien George | 2018-02-26 16:41:13 +1100 |
|---|---|---|
| committer | Damien George | 2018-02-26 16:41:13 +1100 |
| commit | c5fe610ba15468e1d92d7b6d5f5962f7595e3324 (patch) | |
| tree | 8010ef07bae1dbadf0671a4f75bcf2c1d25a43fb /docs | |
| parent | 01dcd5bb71ceba99cf33f82491fbb88ac4f58ec5 (diff) | |
esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.
This will return the RSSI of the AP that the STA is connected to.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/network.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst index a1190a574..a113209e0 100644 --- a/docs/library/network.rst +++ b/docs/library/network.rst @@ -383,10 +383,11 @@ parameter should be `id`. * 0 -- visible * 1 -- hidden - .. method:: wlan.status() + .. method:: wlan.status([param]) Return the current status of the wireless connection. + When called with no argument the return value describes the network link status. The possible statuses are defined as constants: * ``STAT_IDLE`` -- no connection and no activity, @@ -396,6 +397,9 @@ parameter should be `id`. * ``STAT_CONNECT_FAIL`` -- failed due to other problems, * ``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'``. + .. method:: wlan.isconnected() In case of STA mode, returns ``True`` if connected to a WiFi access |