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

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

@ -92,13 +92,13 @@ NOTE: WiFi Mode configuration will be retained until changed even if device is t
#### Parameters #### Parameters
- `mode` value should be one of - `mode` value should be one of
- `wifi.STATION` for when the device is connected to a WiFi router. This is often done to give the device access to the Internet. - `wifi.STATION` for when the device is connected to a WiFi router. This is often done to give the device access to the Internet.
- `wifi.SOFTAP` for when the device is acting *only* as an access point. This will allow you to see the device in the list of WiFi networks (unless you hide the SSID, of course). In this mode your computer can connect to the device, creating a local area network. Unless you change the value, the NodeMCU device will be given a local IP address of 192.168.4.1 and assign your computer the next available IP address, such as 192.168.4.2. - `wifi.SOFTAP` for when the device is acting *only* as an access point. This will allow you to see the device in the list of WiFi networks (unless you hide the SSID, of course). In this mode your computer can connect to the device, creating a local area network. Unless you change the value, the NodeMCU device will be given a local IP address of 192.168.4.1 and assign your computer the next available IP address, such as 192.168.4.2.
- `wifi.STATIONAP` is the combination of `wifi.STATION` and `wifi.SOFTAP`. It allows you to create a local WiFi connection *and* connect to another WiFi router. - `wifi.STATIONAP` is the combination of `wifi.STATION` and `wifi.SOFTAP`. It allows you to create a local WiFi connection *and* connect to another WiFi router.
- `wifi.NULLMODE` changing WiFi mode to NULL_MODE will put wifi into a low power state similar to MODEM_SLEEP, provided `wifi.nullmodesleep(false)` has not been called. - `wifi.NULLMODE` changing WiFi mode to NULL_MODE will put wifi into a low power state similar to MODEM_SLEEP, provided `wifi.nullmodesleep(false)` has not been called.
- `save` choose whether or not to save wifi mode to flash - `save` choose whether or not to save wifi mode to flash
- `true` WiFi mode configuration **will** be retained through power cycle. (Default) - `true` WiFi mode configuration **will** be retained through power cycle. (Default)
- `false` WiFi mode configuration **will not** be retained through power cycle. - `false` WiFi mode configuration **will not** be retained through power cycle.
#### Returns #### Returns
current mode after setup current mode after setup
@ -166,8 +166,8 @@ Configures whether or not WiFi automatically goes to sleep in NULL_MODE. Enabled
#### Returns #### Returns
- `sleep_enabled` Current/New NULL_MODE sleep setting - `sleep_enabled` Current/New NULL_MODE sleep setting
- If `wifi.nullmodesleep()` is called with no arguments, current setting is returned. - If `wifi.nullmodesleep()` is called with no arguments, current setting is returned.
- If `wifi.nullmodesleep()` is called with `enable` argument, confirmation of new setting is returned. - If `wifi.nullmodesleep()` is called with `enable` argument, confirmation of new setting is returned.
## wifi.startsmart() ## wifi.startsmart()
@ -582,7 +582,6 @@ wifi.sta.getap(scan_cfg, 1, listap)
Get index of current Access Point stored in AP cache. Get index of current Access Point stored in AP cache.
#### Syntax #### Syntax
`wifi.sta.getapindex()` `wifi.sta.getapindex()`
@ -617,14 +616,11 @@ Get information of APs cached by ESP8266 station.
#### Returns #### Returns
- `ap_info` - `ap_info`
- `qty` quantity of APs returned - `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)) - `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 - `ssid` ssid of Access Point
- `pwd` Password for Access Point - `pwd` password for Access Point, `nil` if no password was configured
- If no password was configured, the `pwd` field will be `nil` - `bssid` MAC address of Access Point, `nil` if no MAC address was configured
- `bssid` MAC address of Access Point
- If no MAC address was configured, the `bssid` field will be `nil`
#### Example #### Example
```lua ```lua
@ -686,21 +682,20 @@ Gets the WiFi station configuration.
#### Parameters #### Parameters
- `return_table` - `return_table`
- `true` returns data in a table - `true` returns data in a table
- `false` returns data in the old format (default) - `false` returns data in the old format (default)
#### Returns #### Returns
If `return_table` is `true`: If `return_table` is `true`:
- `config_table` - `config_table`
- `ssid` ssid of Access Point. - `ssid` ssid of Access Point.
- `pwd` password to Access Point. - `pwd` password to Access Point, `nil` if no password was configured
- If no password was configured, the `pwd` field will be `nil` - `bssid` MAC address of Access Point, `nil` if no MAC address was configured
- `bssid` MAC address of Access Point
- If no MAC address was configured, the `bssid` field will be `nil`
If `return_table` is `false`: 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 #### Example
@ -734,21 +729,20 @@ Gets the default WiFi station configuration stored in flash.
#### Parameters #### Parameters
- `return_table` - `return_table`
- `true` returns data in a table - `true` returns data in a table
- `false` returns data in the old format (default) - `false` returns data in the old format (default)
#### Returns #### Returns
If `return_table` is `true`: If `return_table` is `true`:
- `config_table` - `config_table`
- `ssid` ssid of Access Point. - `ssid` ssid of Access Point.
- `pwd` password to Access Point. - `pwd` password to Access Point, `nil` if no password was configured
- If no password was configured, the `pwd` field will be `nil` - `bssid` MAC address of Access Point, `nil` if no MAC address was configured
- `bssid` MAC address of Access Point
- If no MAC address was configured, the `bssid` field will be `nil`
If `return_table` is `false`: 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 #### Example
@ -1120,24 +1114,23 @@ Gets the current SoftAP configuration.
#### Parameters #### Parameters
- `return_table` - `return_table`
- `true` returns data in a table - `true` returns data in a table
- `false` returns data in the old format (default) - `false` returns data in the old format (default)
#### Returns #### Returns
If `return_table` is true: If `return_table` is true:
- `config_table` - `config_table`
- `ssid` Network name - `ssid` Network name
- `pwd` Password - `pwd` Password, `nil` if no password was configured - `auth` Authentication Method (`wifi.OPEN`, `wifi.WPA_PSK`, `wifi.WPA2_PSK` or `wifi.WPA_WPA2_PSK`)
- If no password was configured, the `pwd` field will be `nil` - `channel` Channel number
- `auth` Authentication Method (`wifi.OPEN`, `wifi.WPA_PSK`, `wifi.WPA2_PSK` or `wifi.WPA_WPA2_PSK`) - `hidden` `false` = not hidden, `true` = hidden
- `channel` Channel number - `max` Maximum number of client connections
- `hidden` `false` = not hidden, `true` = hidden - `beacon` Beacon interval
- `max` Maximum number of client connections
- `beacon` Beacon interval
If `return_table` is false: 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 #### Example
@ -1168,24 +1161,23 @@ Gets the default SoftAP configuration stored in flash.
#### Parameters #### Parameters
- `return_table` - `return_table`
- `true` returns data in a table - `true` returns data in a table
- `false` returns data in the old format (default) - `false` returns data in the old format (default)
#### Returns #### Returns
If `return_table` is true: If `return_table` is true:
- `config_table` - `config_table`
- `ssid` Network name - `ssid` Network name
- `pwd` Password - `pwd` Password, `nil` if no password was configured - `auth` Authentication Method (`wifi.OPEN`, `wifi.WPA_PSK`, `wifi.WPA2_PSK` or `wifi.WPA_WPA2_PSK`)
- If no password was configured, the `pwd` field will be `nil` - `channel` Channel number
- `auth` Authentication Method (`wifi.OPEN`, `wifi.WPA_PSK`, `wifi.WPA2_PSK` or `wifi.WPA_WPA2_PSK`) - `hidden` `false` = not hidden, `true` = hidden
- `channel` Channel number - `max` Maximum number of client connections
- `hidden` `false` = not hidden, `true` = hidden - `beacon` Beacon interval
- `max` Maximum number of client connections
- `beacon` Beacon interval
If `return_table` is false: 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 #### Example