djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/network: Enhance AbstractNIC.status to take an argument.

Browse Source 
The argument is optional and if given should be a string naming the
status variable to query.
This commit is contained in:
Damien George 2017-10-06 10:57:51 +11:00
parent 8d956c26d1
commit 31550a52e4
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/library/network.rst
View File

@ -98,10 +98,20 @@ parameter should be `id`.
duration and other parameters. Where possible, parameter names duration and other parameters. Where possible, parameter names
should match those in connect(). should match those in connect().
.. method:: status() .. method:: status([param])
Return detailed status of the interface, values are dependent Query dynamic status information of the interface. When called with no
on the network medium/technology. argument the return value describes the network link status. Otherwise
*param* should be a string naming the particular status parameter to
retrieve.
The return types and values are dependent on the network
medium/technology. Some of the parameters that may be supported are:
* WiFi STA: use ``'rssi'`` to retrieve the RSSI of the AP signal
* WiFi AP: use ``'stations'`` to retrieve a list of all the STAs
connected to the AP. The list contains tuples of the form
(MAC, RSSI).
.. method:: ifconfig([(ip, subnet, gateway, dns)]) .. method:: ifconfig([(ip, subnet, gateway, dns)])
@ -118,7 +128,7 @@ parameter should be `id`.
Get or set general network interface parameters. These methods allow to work Get or set general network interface parameters. These methods allow to work
with additional parameters beyond standard IP configuration (as dealt with by with additional parameters beyond standard IP configuration (as dealt with by
`ifconfig()`). These include network-specific and hardware-specific `ifconfig()`). These include network-specific and hardware-specific
parameters and status values. For setting parameters, the keyword argument parameters. For setting parameters, the keyword argument
syntax should be used, and multiple parameters can be set at once. For syntax should be used, and multiple parameters can be set at once. For
querying, a parameter name should be quoted as a string, and only one querying, a parameter name should be quoted as a string, and only one
parameter can be queried at a time:: parameter can be queried at a time::
@ -128,8 +138,6 @@ parameter should be `id`.
# Query params one by one # Query params one by one
print(ap.config('essid')) print(ap.config('essid'))
print(ap.config('channel')) print(ap.config('channel'))
# Extended status information also available this way
print(sta.config('rssi'))
.. only:: port_pyboard .. only:: port_pyboard