Commit 00960133 authored by Noah's avatar Noah Committed by danicampora
Browse files

docs: Update docs for WiPy wlan.connect().

- The link establishment timeout is infinite by default
- Fix typo in notes about the auth kwarg
parent f3308daa
...@@ -110,7 +110,6 @@ typedef enum{ ...@@ -110,7 +110,6 @@ typedef enum{
#define MODWLAN_SL_SCAN_DISABLE 0 #define MODWLAN_SL_SCAN_DISABLE 0
#define MODWLAN_SL_MAX_NETWORKS 20 #define MODWLAN_SL_MAX_NETWORKS 20
#define MODWLAN_TIMEOUT_MS 5000
#define MODWLAN_MAX_NETWORKS 20 #define MODWLAN_MAX_NETWORKS 20
#define MODWLAN_SCAN_PERIOD_S 3600 // 1 hour #define MODWLAN_SCAN_PERIOD_S 3600 // 1 hour
#define MODWLAN_WAIT_FOR_SCAN_MS 1050 #define MODWLAN_WAIT_FOR_SCAN_MS 1050
......
...@@ -357,7 +357,7 @@ For example:: ...@@ -357,7 +357,7 @@ For example::
# configure as an station # configure as an station
wlan.init(mode=WLAN.STA) 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 Connect to a wifi access point using the given SSID, and other security
parameters. parameters.
...@@ -365,7 +365,7 @@ For example:: ...@@ -365,7 +365,7 @@ For example::
- ``auth`` is a tuple with (sec, key). Security can be ``None``, ``WLAN.WEP``, - ``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. ``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 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 - ``bssid`` is the MAC address of the AP to connect to. Useful when there are several
APs with the same ssid. APs with the same ssid.
- ``timeout`` is the maximum time in milliseconds to wait for the connection to succeed. - ``timeout`` is the maximum time in milliseconds to wait for the connection to succeed.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment