djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/network: Clarify usage of "bssid" arg in connect() method.

This commit is contained in:
Damien George 2017-10-05 15:27:50 +11:00
parent 6db132e130
commit add933feaf
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/library/network.rst
View File

@ -72,8 +72,7 @@ parameter should be `id`.
connection parameters. For various medium types, there are different connection parameters. For various medium types, there are different
sets of predefined/recommended parameters, among them: sets of predefined/recommended parameters, among them:
* WiFi: *bssid* keyword to connect by BSSID (MAC address) instead * WiFi: *bssid* keyword to connect to a specific BSSID (MAC address)
of access point name
.. method:: disconnect() .. method:: disconnect()
@ -333,9 +332,12 @@ parameter should be `id`.
argument is passed. Otherwise, query current state if no argument is argument is passed. Otherwise, query current state if no argument is
provided. Most other methods require active interface. provided. Most other methods require active interface.
.. method:: wlan.connect(ssid, password) .. method:: wlan.connect(ssid=None, password=None, \*, bssid=None)
Connect to the specified wireless network, using the specified password. Connect to the specified wireless network, using the specified password.
If *bssid* is given then the connection will be restricted to the
access-point with that MAC address (the *ssid* must also be specified
in this case).
.. method:: wlan.disconnect() .. method:: wlan.disconnect()