diff options
| author | Damien George <damien.p.george@gmail.com> | 2017-10-05 15:27:50 +1100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2017-10-09 23:11:25 +1100 |
| commit | add933feaf188073de99cf54e4d251c48034472c (patch) | |
| tree | 714ca25b46e7d8017e64c07ec0af637362084547 | |
| parent | 6db132e1302dcca4671e0d67b872ca226c54682f (diff) | |
docs/library/network: Clarify usage of "bssid" arg in connect() method.
| -rw-r--r-- | docs/library/network.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst index def6bee74..258b2a20c 100644 --- a/docs/library/network.rst +++ b/docs/library/network.rst @@ -72,8 +72,7 @@ parameter should be `id`. connection parameters. For various medium types, there are different sets of predefined/recommended parameters, among them: - * WiFi: *bssid* keyword to connect by BSSID (MAC address) instead - of access point name + * WiFi: *bssid* keyword to connect to a specific BSSID (MAC address) .. method:: disconnect() @@ -333,9 +332,12 @@ parameter should be `id`. argument is passed. Otherwise, query current state if no argument is 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. + 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() |