mirrors/micropython
1
0
Fork 0
mirror of https://github.com/licsber/micropython.git synced 2024-09-20 09:00:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

esp8266: Updated documentation for scan() and moved to network

Browse Source
This commit is contained in:
Bill Owens 2015-06-16 12:28:05 -07:00 committed by Paul Sokolovsky
parent 686516f90a
commit 7c61249ae6
2 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/library/esp.rst
View File

@ -10,14 +10,6 @@ The ``esp`` module contains specific functions related to the ESP8266 module.
Functions Functions
--------- ---------
.. function:: scan(cb)
Initiate scanning for the available wireless networks.
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.
.. function:: status() .. function:: status()
Return the current status of the wireless connection. Return the current status of the wireless connection.

25
docs/library/network.rst
View File

@ -210,6 +210,31 @@ For example::
Disconnect from the currently connected wireless network. Disconnect from the currently connected wireless network.
.. method:: wlan.scan(cb)
Initiate scanning for the available wireless networks.
Scanning is only possible if the radio is in station or station+AP mode; if
called while in AP only mode, an OSError exception will be raised.
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)
There are five values for authmode:
* 0 -- open
* 1 -- WEP
* 2 -- WPA-PSK
* 3 -- WPA2-PSK
* 4 -- WPA/WPA2-PSK
and two for hidden:
* 0 -- visible
* 1 -- hidden
.. only:: port_wipy .. only:: port_wipy