Commit 7c61249a authored by Bill Owens's avatar Bill Owens Committed by Paul Sokolovsky
Browse files

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

parent 686516f9
......@@ -10,14 +10,6 @@ The ``esp`` module contains specific functions related to the ESP8266 module.
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()
Return the current status of the wireless connection.
......
......@@ -210,6 +210,31 @@ For example::
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
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment