MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.
This commit is contained in:
dnc40085 2016-05-14 14:04:20 -07:00 committed by Marcel Stör
parent e5cd17f08b
commit 1b4234e2d3
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/modules/wifi.md
View File

@ -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)
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
## 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)`