summaryrefslogtreecommitdiff
path: root/ports/esp8266/help.c
diff options
context:
space:
mode:
authoriabdalkader <i.abdalkader@gmail.com>2022-06-04 12:29:56 +0200
committerDamien George <damien@micropython.org>2022-06-17 21:43:44 +1000
commit82b8a2d193657f67cf7a301acc5804b946d662ad (patch)
tree23ffd43ab3c9d0fd74a10fd3c65e53d9cf5c2255 /ports/esp8266/help.c
parenta7c7febe0ba939e1f3b06920d590d317c9100ae9 (diff)
esp8266/modnetwork: Rename WLAN keyword args to ssid/security/key.
The WLAN.config() method now supports "ssid", "security" and "key" as aliases to the existing "essid", "authmode" and "password", which are now deprecated. The help text and setup helper are also updated. Addresses issue #8083.
Diffstat (limited to 'ports/esp8266/help.c')
-rw-r--r--ports/esp8266/help.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/ports/esp8266/help.c b/ports/esp8266/help.c
index 4dd586c1a..a755a10a7 100644
--- a/ports/esp8266/help.c
+++ b/ports/esp8266/help.c
@@ -37,11 +37,11 @@ const char esp_help_text[] =
"import network\n"
"sta_if = network.WLAN(network.STA_IF); sta_if.active(True)\n"
"sta_if.scan() # Scan for available access points\n"
- "sta_if.connect(\"<AP_name>\", \"<password>\") # Connect to an AP\n"
+ "sta_if.connect(\"<AP_name>\", \"<key>\") # Connect to an AP\n"
"sta_if.isconnected() # Check for successful connection\n"
"# Change name/password of ESP8266's AP:\n"
"ap_if = network.WLAN(network.AP_IF)\n"
- "ap_if.config(essid=\"<AP_NAME>\", authmode=network.AUTH_WPA_WPA2_PSK, password=\"<password>\")\n"
+ "ap_if.config(ssid=\"<AP_NAME>\", security=network.AUTH_WPA_WPA2_PSK, key=\"<key>\")\n"
"\n"
"Control commands:\n"
" CTRL-A -- on a blank line, enter raw REPL mode\n"