diff options
author | iabdalkader <i.abdalkader@gmail.com> | 2022-06-04 12:32:08 +0200 |
---|---|---|
committer | Damien George <damien@micropython.org> | 2022-06-17 21:43:44 +1000 |
commit | 6e868d47dc5dd7a90444f1173118b7d57e1e4df7 (patch) | |
tree | bd0feca01865b310085373c5caa094907dc13879 /docs/esp8266 | |
parent | 82b8a2d193657f67cf7a301acc5804b946d662ad (diff) | |
download | micropython-6e868d47dc5dd7a90444f1173118b7d57e1e4df7.tar.gz micropython-6e868d47dc5dd7a90444f1173118b7d57e1e4df7.zip |
docs: Update to use new WLAN argument names for ssid/security/key.
Addresses issue #8083.
Diffstat (limited to 'docs/esp8266')
-rw-r--r-- | docs/esp8266/quickref.rst | 6 | ||||
-rw-r--r-- | docs/esp8266/tutorial/network_basics.rst | 4 |
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/esp8266/quickref.rst b/docs/esp8266/quickref.rst index 4e00a92260..ed21997370 100644 --- a/docs/esp8266/quickref.rst +++ b/docs/esp8266/quickref.rst @@ -57,13 +57,13 @@ The :mod:`network` module:: wlan.active(True) # activate the interface wlan.scan() # scan for access points wlan.isconnected() # check if the station is connected to an AP - wlan.connect('essid', 'password') # connect to an AP + wlan.connect('ssid', 'key') # connect to an AP wlan.config('mac') # get the interface's MAC address wlan.ifconfig() # get the interface's IP/netmask/gw/DNS addresses ap = network.WLAN(network.AP_IF) # create access-point interface ap.active(True) # activate the interface - ap.config(essid='ESP-AP') # set the ESSID of the access point + ap.config(ssid='ESP-AP') # set the SSID of the access point A useful function for connecting to your local WiFi network is:: @@ -73,7 +73,7 @@ A useful function for connecting to your local WiFi network is:: wlan.active(True) if not wlan.isconnected(): print('connecting to network...') - wlan.connect('essid', 'password') + wlan.connect('ssid', 'key') while not wlan.isconnected(): pass print('network config:', wlan.ifconfig()) diff --git a/docs/esp8266/tutorial/network_basics.rst b/docs/esp8266/tutorial/network_basics.rst index 95d8cba4f9..dc3cd3dd5e 100644 --- a/docs/esp8266/tutorial/network_basics.rst +++ b/docs/esp8266/tutorial/network_basics.rst @@ -37,7 +37,7 @@ First activate the station interface:: Then connect to your WiFi network:: - >>> sta_if.connect('<your ESSID>', '<your password>') + >>> sta_if.connect('<your SSID>', '<your key>') To check if the connection is established use:: @@ -61,7 +61,7 @@ connect to your WiFi network:: if not sta_if.isconnected(): print('connecting to network...') sta_if.active(True) - sta_if.connect('<essid>', '<password>') + sta_if.connect('<ssid>', '<key>') while not sta_if.isconnected(): pass print('network config:', sta_if.ifconfig()) |