summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/network.rst
diff options
context:
space:
mode:
authorRadomir Dopieralski <openstack@sheep.art.pl>2015-06-13 20:06:11 +0200
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2015-06-13 23:03:06 +0300
commit05c6fbcae6188d0526a7148e6b8477d17ff72e25 (patch)
treefcd43ff06941cebaa2509e3a1b1bc0031e7b2e8b /docs/library/network.rst
parentdd0e24f4b077378635fd71267936fa39a2228cb5 (diff)
downloadmicropython-05c6fbcae6188d0526a7148e6b8477d17ff72e25.tar.gz
micropython-05c6fbcae6188d0526a7148e6b8477d17ff72e25.zip
esp8266: Fix the documentation for esp.connect() and esp.disconnect()
Since the commit that moved those two functions failed to update the documentation, this is a fix for that.
Diffstat (limited to 'docs/library/network.rst')
-rw-r--r--docs/library/network.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst
index b5a674acf2..157fdad032 100644
--- a/docs/library/network.rst
+++ b/docs/library/network.rst
@@ -178,6 +178,39 @@ For example::
Dump the WIZnet5x00 registers. Useful for debugging.
+.. only:: port_esp8266
+
+ class WLAN
+ ==========
+
+ .. _network.WLAN:
+
+ This class provides a driver for WiFi network processor in the ESP8266. Example usage::
+
+ import network
+ # setup as a station
+ nic = network.WLAN()
+ nic.connect('your-ssid', 'your-password')
+ # now use socket as usual
+
+ Constructors
+ ------------
+ .. class:: WLAN()
+
+ Create a WLAN driver object.
+
+ Methods
+ -------
+
+ .. method:: wlan.connect(ssid, password)
+
+ Connect to the specified wireless network, using the specified password.
+
+ .. method:: wlan.disconnect()
+
+ Disconnect from the currently connected wireless network.
+
+
.. only:: port_wipy
class WLAN