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

docs: network: esp8266: .scan() is now synchronous and returns result list.

Browse Source
This commit is contained in:
Paul Sokolovsky 2016-03-30 11:56:20 +03:00
parent d7019d0628
commit f50d9477c1
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/library/network.rst
View File

@ -291,16 +291,12 @@ For example::
value, which should be bytes object of length 6. If the function value, which should be bytes object of length 6. If the function
is called wihout parameters, returns the current address. is called wihout parameters, returns the current address.
.. method:: wlan.scan(cb) .. method:: wlan.scan()
Initiate scanning for the available wireless networks. Scan for the available wireless networks.
Scanning is only possible if the radio is in station or station+AP mode; if Scanning is only possible on STA interface. Returns list of tuples with
called while in AP only mode, an OSError exception will be raised. the information about WiFi access points:
Once the scanning is complete, the provided callback function ``cb`` will
be called once for each network found, and passed a tuple with information
about that network:
(ssid, bssid, channel, RSSI, authmode, hidden) (ssid, bssid, channel, RSSI, authmode, hidden)