Commit 1b4234e2 authored by dnc40085's avatar dnc40085 Committed by Marcel Stör
Browse files

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.
parent e5cd17f0
...@@ -67,6 +67,8 @@ Configures the WiFi mode to use. NodeMCU can run in one of four WiFi modes: ...@@ -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. 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 #### Syntax
`wifi.setmode(mode)` `wifi.setmode(mode)`
...@@ -228,6 +230,8 @@ wifi.sta.autoconnect(1) ...@@ -228,6 +230,8 @@ wifi.sta.autoconnect(1)
Sets the WiFi station configuration. Sets the WiFi station configuration.
NOTE: Station configuration will be retained until changed even if device is turned off.
#### Syntax #### Syntax
`wifi.sta.config(ssid, password[, auto[, bssid]])` `wifi.sta.config(ssid, password[, auto[, bssid]])`
...@@ -737,7 +741,9 @@ number: 0~5 ...@@ -737,7 +741,9 @@ number: 0~5
## wifi.ap.config() ## 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 #### Syntax
`wifi.ap.config(cfg)` `wifi.ap.config(cfg)`
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment