summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-03-25 16:30:06 +0200
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-03-25 16:30:06 +0200
commit4b5606bc09bb831091df3c8536833e4cd8751c3f (patch)
treed70cd93c2577856024978aa7a4ace3f405b443a5
parentee6fcc6f919d5bbe9000484bf9a2af79309ea3be (diff)
downloadmicropython-4b5606bc09bb831091df3c8536833e4cd8751c3f.tar.gz
micropython-4b5606bc09bb831091df3c8536833e4cd8751c3f.zip
docs/network: esp8266: Update docs on WLAN constructor.
-rw-r--r--docs/library/network.rst15
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst
index 6b72ad2c6f..efca166fb7 100644
--- a/docs/library/network.rst
+++ b/docs/library/network.rst
@@ -235,16 +235,21 @@ For example::
This class provides a driver for WiFi network processor in the ESP8266. Example usage::
import network
- # setup as a station
- nic = network.WLAN()
+ # enable station interface and connect to WiFi access point
+ nic = network.WLAN(network.STA_IF)
+ nic.active(True)
nic.connect('your-ssid', 'your-password')
- # now use socket as usual
+ # now use sockets as usual
Constructors
------------
- .. class:: WLAN()
+ .. class:: WLAN(interface_id)
- Create a WLAN driver object.
+ Create a WLAN network interface object. Supported interfaces are
+ ``network.STA_IF`` (station aka client, connects to upstream WiFi access
+ points) and ``network.AP_IF`` (access point, allows other WiFi clients to
+ connect). Availability of the methods below depends on interface type.
+ For example, only STA interface may ``connect()`` to an access point.
Methods
-------