diff options
| author | Noah <noah@hack.se> | 2015-11-05 03:33:48 +0100 |
|---|---|---|
| committer | danicampora <daniel@wipy.io> | 2015-11-18 19:47:40 +0100 |
| commit | 00960133c2b1732daf28423481b4ffc8a14f207a (patch) | |
| tree | ca3d8b8bbdb6950afcaeecec667efafa5eaf3397 /docs | |
| parent | f3308daa6fb74bc42f764b505d738a82bca8b508 (diff) | |
docs: Update docs for WiPy wlan.connect().
- The link establishment timeout is infinite by default
- Fix typo in notes about the auth kwarg
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/network.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst index d4725055a..f60de7da6 100644 --- a/docs/library/network.rst +++ b/docs/library/network.rst @@ -357,7 +357,7 @@ For example:: # configure as an station wlan.init(mode=WLAN.STA) - .. method:: wlan.connect(ssid, \*, auth=None, bssid=None, timeout=5000) + .. method:: wlan.connect(ssid, \*, auth=None, bssid=None, timeout=None) Connect to a wifi access point using the given SSID, and other security parameters. @@ -365,7 +365,7 @@ For example:: - ``auth`` is a tuple with (sec, key). Security can be ``None``, ``WLAN.WEP``, ``WLAN.WPA`` or ``WLAN.WPA2``. The key is a string with the network password. If ``sec`` is ``WLAN.WEP`` the key must be a string representing hexadecimal - values (e.g. 'ABC1DE45BF'). Only needed when mode is ``WLAN.AP`` + values (e.g. 'ABC1DE45BF'). - ``bssid`` is the MAC address of the AP to connect to. Useful when there are several APs with the same ssid. - ``timeout`` is the maximum time in milliseconds to wait for the connection to succeed. |