diff options
| author | Radomir Dopieralski | 2015-06-13 20:06:11 +0200 |
|---|---|---|
| committer | Paul Sokolovsky | 2015-06-13 23:03:06 +0300 |
| commit | 05c6fbcae6188d0526a7148e6b8477d17ff72e25 (patch) | |
| tree | fcd43ff06941cebaa2509e3a1b1bc0031e7b2e8b /docs | |
| parent | dd0e24f4b077378635fd71267936fa39a2228cb5 (diff) | |
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')
| -rw-r--r-- | docs/library/esp.rst | 8 | ||||
| -rw-r--r-- | docs/library/index.rst | 1 | ||||
| -rw-r--r-- | docs/library/network.rst | 33 |
3 files changed, 34 insertions, 8 deletions
diff --git a/docs/library/esp.rst b/docs/library/esp.rst index 8dd39f536..2c4846d86 100644 --- a/docs/library/esp.rst +++ b/docs/library/esp.rst @@ -10,14 +10,6 @@ The ``esp`` module contains specific functions related to the ESP8266 module. Functions --------- -.. function:: connect(ssid, password) - - Connect to the specified wireless network, using the specified password. - -.. function:: disconnect() - - Disconnect from the currently connected wireless network. - .. function:: scan(cb) Initiate scanning for the available wireless networks. diff --git a/docs/library/index.rst b/docs/library/index.rst index f00bd1c20..9c01d333e 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -121,3 +121,4 @@ it will fallback to loading the built-in ``ujson`` module. pyb.rst esp.rst + network.rst diff --git a/docs/library/network.rst b/docs/library/network.rst index b5a674acf..157fdad03 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 |