Skip to content

Commit add933f

Browse files
committed
docs/library/network: Clarify usage of "bssid" arg in connect() method.
1 parent 6db132e commit add933f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/library/network.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ parameter should be `id`.
7272
connection parameters. For various medium types, there are different
7373
sets of predefined/recommended parameters, among them:
7474

75-
* WiFi: *bssid* keyword to connect by BSSID (MAC address) instead
76-
of access point name
75+
* WiFi: *bssid* keyword to connect to a specific BSSID (MAC address)
7776

7877
.. method:: disconnect()
7978

@@ -333,9 +332,12 @@ parameter should be `id`.
333332
argument is passed. Otherwise, query current state if no argument is
334333
provided. Most other methods require active interface.
335334

336-
.. method:: wlan.connect(ssid, password)
335+
.. method:: wlan.connect(ssid=None, password=None, \*, bssid=None)
337336

338337
Connect to the specified wireless network, using the specified password.
338+
If *bssid* is given then the connection will be restricted to the
339+
access-point with that MAC address (the *ssid* must also be specified
340+
in this case).
339341

340342
.. method:: wlan.disconnect()
341343

0 commit comments

Comments
 (0)