Skip to content

Commit 0096013

Browse files
noahwilliamssondanicampora
authored andcommitted
docs: Update docs for WiPy wlan.connect().
- The link establishment timeout is infinite by default - Fix typo in notes about the auth kwarg
1 parent f3308da commit 0096013

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

cc3200/mods/modwlan.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,6 @@ typedef enum{
110110
#define MODWLAN_SL_SCAN_DISABLE 0
111111
#define MODWLAN_SL_MAX_NETWORKS 20
112112

113-
#define MODWLAN_TIMEOUT_MS 5000
114113
#define MODWLAN_MAX_NETWORKS 20
115114
#define MODWLAN_SCAN_PERIOD_S 3600 // 1 hour
116115
#define MODWLAN_WAIT_FOR_SCAN_MS 1050

docs/library/network.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,15 +357,15 @@ For example::
357357
# configure as an station
358358
wlan.init(mode=WLAN.STA)
359359

360-
.. method:: wlan.connect(ssid, \*, auth=None, bssid=None, timeout=5000)
360+
.. method:: wlan.connect(ssid, \*, auth=None, bssid=None, timeout=None)
361361

362362
Connect to a wifi access point using the given SSID, and other security
363363
parameters.
364364

365365
- ``auth`` is a tuple with (sec, key). Security can be ``None``, ``WLAN.WEP``,
366366
``WLAN.WPA`` or ``WLAN.WPA2``. The key is a string with the network password.
367367
If ``sec`` is ``WLAN.WEP`` the key must be a string representing hexadecimal
368-
values (e.g. 'ABC1DE45BF'). Only needed when mode is ``WLAN.AP``
368+
values (e.g. 'ABC1DE45BF').
369369
- ``bssid`` is the MAC address of the AP to connect to. Useful when there are several
370370
APs with the same ssid.
371371
- ``timeout`` is the maximum time in milliseconds to wait for the connection to succeed.

0 commit comments

Comments
 (0)