@@ -98,10 +98,20 @@ parameter should be `id`.
9898 duration and other parameters. Where possible, parameter names
9999 should match those in connect().
100100
101- .. method :: status()
101+ .. method :: status([param] )
102102
103- Return detailed status of the interface, values are dependent
104- on the network medium/technology.
103+ Query dynamic status information of the interface. When called with no
104+ argument the return value describes the network link status. Otherwise
105+ *param * should be a string naming the particular status parameter to
106+ retrieve.
107+
108+ The return types and values are dependent on the network
109+ medium/technology. Some of the parameters that may be supported are:
110+
111+ * WiFi STA: use ``'rssi' `` to retrieve the RSSI of the AP signal
112+ * WiFi AP: use ``'stations' `` to retrieve a list of all the STAs
113+ connected to the AP. The list contains tuples of the form
114+ (MAC, RSSI).
105115
106116 .. method :: ifconfig([(ip, subnet, gateway, dns)])
107117
@@ -118,7 +128,7 @@ parameter should be `id`.
118128 Get or set general network interface parameters. These methods allow to work
119129 with additional parameters beyond standard IP configuration (as dealt with by
120130 `ifconfig() `). These include network-specific and hardware-specific
121- parameters and status values . For setting parameters, the keyword argument
131+ parameters. For setting parameters, the keyword argument
122132 syntax should be used, and multiple parameters can be set at once. For
123133 querying, a parameter name should be quoted as a string, and only one
124134 parameter can be queried at a time::
@@ -128,8 +138,6 @@ parameter should be `id`.
128138 # Query params one by one
129139 print(ap.config('essid'))
130140 print(ap.config('channel'))
131- # Extended status information also available this way
132- print(sta.config('rssi'))
133141
134142.. only :: port_pyboard
135143
0 commit comments