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 indentation

This commit is contained in:
Marcel Stör 2016-12-29 09:23:06 +01:00
parent 2b897e56c7
commit 007f870cb6
1 changed files with 51 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -582,7 +582,6 @@ wifi.sta.getap(scan_cfg, 1, listap)
Get index of current Access Point stored in AP cache.
#### Syntax
`wifi.sta.getapindex()`
@ -620,11 +619,8 @@ Get information of APs cached by ESP8266 station.
- `qty` quantity of APs returned
- `1-5` index of AP. (the index corresponds to index used by [`wifi.sta.changeap()`](#wifistachangeap) and [`wifi.sta.getapindex()`](#wifistagetapindex))
- `ssid` ssid of Access Point
- `pwd` Password for Access Point
- If no password was configured, the `pwd` field will be `nil`
- `bssid` MAC address of Access Point
- If no MAC address was configured, the `bssid` field will be `nil`
- `pwd` password for Access Point, `nil` if no password was configured
- `bssid` MAC address of Access Point, `nil` if no MAC address was configured
#### Example
```lua
@ -691,16 +687,15 @@ Gets the WiFi station configuration.
#### Returns
If `return_table` is `true`:
- `config_table`
- `ssid` ssid of Access Point.
- `pwd` password to Access Point.
- If no password was configured, the `pwd` field will be `nil`
- `bssid` MAC address of Access Point
- If no MAC address was configured, the `bssid` field will be `nil`
- `pwd` password to Access Point, `nil` if no password was configured
- `bssid` MAC address of Access Point, `nil` if no MAC address was configured
If `return_table` is `false`:
- ssid, password, bssid_set, bssid
- Note: If `bssid_set` is equal to `0` then `bssid` is irrelevant,
- ssid, password, bssid_set, bssid, if `bssid_set` is equal to `0` then `bssid` is irrelevant
#### Example
@ -739,16 +734,15 @@ Gets the default WiFi station configuration stored in flash.
#### Returns
If `return_table` is `true`:
- `config_table`
- `ssid` ssid of Access Point.
- `pwd` password to Access Point.
- If no password was configured, the `pwd` field will be `nil`
- `bssid` MAC address of Access Point
- If no MAC address was configured, the `bssid` field will be `nil`
- `pwd` password to Access Point, `nil` if no password was configured
- `bssid` MAC address of Access Point, `nil` if no MAC address was configured
If `return_table` is `false`:
- ssid, password, bssid_set, bssid
- Note: If `bssid_set` is equal to `0` then `bssid` is irrelevant,
- ssid, password, bssid_set, bssid, if `bssid_set` is equal to `0` then `bssid` is irrelevant
#### Example
@ -1125,19 +1119,18 @@ Gets the current SoftAP configuration.
#### Returns
If `return_table` is true:
- `config_table`
- `ssid` Network name
- `pwd` Password
- If no password was configured, the `pwd` field will be `nil`
- `auth` Authentication Method (`wifi.OPEN`, `wifi.WPA_PSK`, `wifi.WPA2_PSK` or `wifi.WPA_WPA2_PSK`)
- `pwd` Password, `nil` if no password was configured - `auth` Authentication Method (`wifi.OPEN`, `wifi.WPA_PSK`, `wifi.WPA2_PSK` or `wifi.WPA_WPA2_PSK`)
- `channel` Channel number
- `hidden` `false` = not hidden, `true` = hidden
- `max` Maximum number of client connections
- `beacon` Beacon interval
If `return_table` is false:
ssid, password
Note: If bssid_set is equal to 0 then bssid is irrelevant
- ssid, password, if `bssid_set` is equal to 0 then `bssid` is irrelevant
#### Example
@ -1173,19 +1166,18 @@ Gets the default SoftAP configuration stored in flash.
#### Returns
If `return_table` is true:
- `config_table`
- `ssid` Network name
- `pwd` Password
- If no password was configured, the `pwd` field will be `nil`
- `auth` Authentication Method (`wifi.OPEN`, `wifi.WPA_PSK`, `wifi.WPA2_PSK` or `wifi.WPA_WPA2_PSK`)
- `pwd` Password, `nil` if no password was configured - `auth` Authentication Method (`wifi.OPEN`, `wifi.WPA_PSK`, `wifi.WPA2_PSK` or `wifi.WPA_WPA2_PSK`)
- `channel` Channel number
- `hidden` `false` = not hidden, `true` = hidden
- `max` Maximum number of client connections
- `beacon` Beacon interval
If `return_table` is false:
ssid, password
Note: If bssid_set is equal to 0 then bssid is irrelevant
- ssid, password, if `bssid_set` is equal to 0 then `bssid` is irrelevant
#### Example