From 1b4234e2d36475a27e3cc175df1b2250870cbd76 Mon Sep 17 00:00:00 2001 From: dnc40085 Date: Sat, 14 May 2016 14:04:20 -0700 Subject: [PATCH] Add details to WiFi module documentation (#1294) Update descriptions of `wifi.setmode`, `wifi.sta.config` and `wifi.ap.config` to inform user of configuration persistence. --- docs/en/modules/wifi.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/en/modules/wifi.md b/docs/en/modules/wifi.md index f7746592..049f0105 100644 --- a/docs/en/modules/wifi.md +++ b/docs/en/modules/wifi.md @@ -67,6 +67,8 @@ Configures the WiFi mode to use. NodeMCU can run in one of four WiFi modes: When using the combined Station + AP mode, the same channel will be used for both networks as the radio can only listen on a single channel. +NOTE: WiFi Mode configuration will be retained until changed even if device is turned off. + #### Syntax `wifi.setmode(mode)` @@ -228,6 +230,8 @@ wifi.sta.autoconnect(1) Sets the WiFi station configuration. +NOTE: Station configuration will be retained until changed even if device is turned off. + #### Syntax `wifi.sta.config(ssid, password[, auto[, bssid]])` @@ -737,7 +741,9 @@ number： 0~5 ## wifi.ap.config() -Sets SSID and password in AP mode. Be sure to make the password at least 8 characters long! If you don't it will default to *no* password and not set the SSID! It will still work as an access point but use a default SSID like e.g. ESP_9997C3. +Sets SSID and password in AP mode. Be sure to make the password at least 8 characters long! If you don't it will default to *no* password and not set the SSID! It will still work as an access point but use a default SSID like e.g. NODE-9997C3. + +NOTE: SoftAP Configuration will be retained until changed even if device is turned off. #### Syntax `wifi.ap.config(cfg)`