jepler/circuitpython
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs/esp32: Document WLAN "reconnects" config option.

Browse source
This commit is contained in:
Thomas Wenrich 2021-06-13 16:23:53 +02:00 committed by Damien George
parent 060066804a
commit 364670ecf1
2 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/esp32/quickref.rst
View file

@ -102,6 +102,14 @@ Once the network is established the :mod:`socket <usocket>` module can be used
to create and use TCP/UDP sockets as usual, and the ``urequests`` module for to create and use TCP/UDP sockets as usual, and the ``urequests`` module for
convenient HTTP requests. convenient HTTP requests.
After a call to ``wlan.connect()``, the device will by default retry to connect
**forever**, even when the authentication failed or no AP is in range.
``wlan.status()`` will return ``network.STAT_CONNECTING`` in this state until a
connection succeeds or the interface gets disabled. This can be changed by
calling ``wlan.config(reconnects=n)``, where n are the number of desired reconnect
attempts (0 means it won't retry, -1 will restore the default behaviour of trying
to reconnect forever).
Delay and timing Delay and timing
---------------- ----------------

1
docs/library/network.WLAN.rst
View file

@ -129,4 +129,5 @@ Methods
authmode Authentication mode supported (enumeration, see module constants) authmode Authentication mode supported (enumeration, see module constants)
password Access password (string) password Access password (string)
dhcp_hostname The DHCP hostname to use dhcp_hostname The DHCP hostname to use
reconnects Number of reconnect attempts to make (integer, 0=none, -1=unlimited)
============= =========== ============= ===========