From c5fe610ba15468e1d92d7b6d5f5962f7595e3324 Mon Sep 17 00:00:00 2001
From: Damien George
Date: Mon, 26 Feb 2018 16:41:13 +1100
Subject: esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.

This will return the RSSI of the AP that the STA is connected to.
---
 docs/library/network.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'docs')

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
-- 
cgit v1.2.3