← index #5245Issue #7207
Related · high · value 2.988
QUERY · ISSUE

docs: Explain port-specific differences in network / WLAN / ssl

openby jimmoopened 2019-10-21updated 2019-10-22
docs

Inspired by https://forum.micropython.org/viewtopic.php?f=18&t=7119

At a minimum, just add the auth mode constants to network.rst. (And highlight if only some are supported by a subset of ports).

It's worth doing a bit of a pass through for related improvements. There are a few examples like that where it can be difficult to figure out how to use a feature. Most features should be supported on all ports, so hopefully this is fairly straightforward.

Related with ssl, one question that pops up a lot is how to use cert validation, where the docs says "Depending on the underlying module implementation in a particular MicroPython port, some or all keyword arguments above may be not supported." So in a similar vein, would be good to address this too in the same way.

CANDIDATE · 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.

Keyboard

j / / n
next pair
k / / p
previous pair
1 / / h
show query pane
2 / / l
show candidate pane
c
copy suggested comment
r
toggle reasoning
g i
go to index
?
show this help
esc
close overlays

press ? or esc to close

copied