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

Fix list formatting

This commit is contained in:
Marcel Stör 2016-12-23 12:59:46 +01:00
parent c5c0143b2f
commit 680d349039
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -279,21 +279,21 @@ Sets the WiFi station configuration.
#### Parameters #### Parameters
- `station_config` table containing configuration data for station - `station_config` table containing configuration data for station
- `ssid` string which is less than 32 bytes. - `ssid` string which is less than 32 bytes.
- `pwd` string which is 8-64 or 0 bytes. Empty string indicates an open WiFi access point. - `pwd` string which is 8-64 or 0 bytes. Empty string indicates an open WiFi access point.
- `auto` defaults to true - `auto` defaults to true
- `true` to enable auto connect and connect to access point, hence with `auto=true` there's no need to call [`wifi.sta.connect()`](#wifistaconnect) - `true` to enable auto connect and connect to access point, hence with `auto=true` there's no need to call [`wifi.sta.connect()`](#wifistaconnect)
- `false` to disable auto connect and remain disconnected from access point - `false` to disable auto connect and remain disconnected from access point
- `bssid` string that contains the MAC address of the access point (optional) - `bssid` string that contains the MAC address of the access point (optional)
- You can set BSSID if you have multiple access points with the same SSID. - You can set BSSID if you have multiple access points with the same SSID.
- Note: if you set BSSID for a specific SSID and would like to configure station to connect to the same SSID only without the BSSID requirement, you MUST first configure to station to a different SSID first, then connect to the desired SSID - If you set BSSID for a specific SSID and would like to configure station to connect to the same SSID only without the BSSID requirement, you MUST first configure to station to a different SSID first, then connect to the desired SSID
- The following formats are valid: - The following formats are valid:
- "DE:C1:A5:51:F1:ED" - "DE:C1:A5:51:F1:ED"
- "AC-1D-1C-B1-0B-22" - "AC-1D-1C-B1-0B-22"
- "DE AD BE EF 7A C0" - "DE AD BE EF 7A C0"
- `save` Save station configuration to flash. - `save` Save station configuration to flash.
- `true` configuration **will** be retained through power cycle. - `true` configuration **will** be retained through power cycle.
- `false` configuration **will not** be retained through power cycle. (Default) - `false` configuration **will not** be retained through power cycle. (Default)
#### Returns #### Returns
- `true` Success - `true` Success
@ -999,16 +999,16 @@ Sets SSID and password in AP mode. Be sure to make the password at least 8 chara
#### Parameters #### Parameters
- `cfg` table to hold configuration - `cfg` table to hold configuration
- `ssid` SSID chars 1-32 - `ssid` SSID chars 1-32
- `pwd` password chars 8-64 - `pwd` password chars 8-64
- `auth` authentication method, one of `wifi.OPEN` (default), `wifi.WPA_PSK`, `wifi.WPA2_PSK`, `wifi.WPA_WPA2_PSK` - `auth` authentication method, one of `wifi.OPEN` (default), `wifi.WPA_PSK`, `wifi.WPA2_PSK`, `wifi.WPA_WPA2_PSK`
- `channel` channel number 1-14 default = 6 - `channel` channel number 1-14 default = 6
- `hidden` false = not hidden, true = hidden, default = false - `hidden` false = not hidden, true = hidden, default = false
- `max` maximum number of connections 1-4 default=4 - `max` maximum number of connections 1-4 default=4
- `beacon` beacon interval time in range 100-60000, default = 100 - `beacon` beacon interval time in range 100-60000, default = 100
- `save` save configuration to flash. - `save` save configuration to flash.
- `true` configuration **will** be retained through power cycle. (Default) - `true` configuration **will** be retained through power cycle. (Default)
- `false` configuration **will not** be retained through power cycle. - `false` configuration **will not** be retained through power cycle.
#### Returns #### Returns