QUERY · ISSUE

Documentation WLAN.connect()

openby karfasopened 2021-05-03updated 2025-11-06

docs

In https://docs.micropython.org/en/latest/wipy/tutorial/wlan.html, the connect() method reads
wlan.connect(net.ssid, auth=(net.sec, 'mywifikey'), timeout=5000)

In contrary, https://docs.micropython.org/en/latest/library/network.WLAN.html?highlight=wlan#network.WLAN.connect describes the connect() call as
WLAN.connect(ssid=None, password=None, *, bssid=None)

Which one is the correct/current one (and for which port ?) ?
This is quite confusing for new users, I think.

CANDIDATE · PULL REQUEST

Fix the documentation for esp.connect() and esp.disconnect()

closedby deshipuopened 2015-06-13updated 2015-06-13

Since the commit that moved those two functions failed to update
the documentation, this is a fix for that.

Assessment

S Sonnet · medium

Both touch WLAN.connect() documentation, but they address different problems. PR #1323 fixes ESP8266-specific docs by relocating connect()/disconnect() from the esp module to network.WLAN after a code migration — it's a documentation sync for a moved function. Issue #7207 is about a method signature discrepancy between the WiPy tutorial (which uses port-specific parameters: auth=(sec, key), timeout=) and the generic library reference (ssid=, password=, bssid=). The PR does not address the WiPy-specific auth parameter format or the inconsistency between tutorial and reference docs that the issue raises.

Suggested action

No action needed on issue #7207 from this PR. The issue about WiPy tutorial vs generic API signature mismatch remains open. A maintainer should clarify whether the auth=(sec, key) form is WiPy-only and update the WiPy tutorial to note the port-specific signature, or update the library reference to document port variations.

Documentation WLAN.connect()

Fix the documentation for esp.connect() and esp.disconnect()

Keyboard