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

fix i2c and wifi doc formatting

This commit is contained in:
devsaurus 2017-03-08 17:56:46 +01:00
parent 2b98037fa9
commit b3ec03e1fe
2 changed files with 68 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -213,7 +213,8 @@ Connects to the configured AP in station mode. You only ever need to call this i
Disconnects from AP in station mode. Disconnects from AP in station mode.
!!! note !!! note
Please note that disconnecting from Access Point does not reduce power consumption much. Please note that disconnecting from Access Point does not reduce power consumption much.
If power saving is your goal, please use [`wifi.stop()`](#wifisetmode). If power saving is your goal, please use [`wifi.stop()`](#wifisetmode).
@ -252,6 +253,7 @@ Registers callbacks for WiFi station status events.
the event. the event.
Event information provided for each event is as follows: Event information provided for each event is as follows:
- `start`: no additional info - `start`: no additional info
- `stop`: no additional info - `stop`: no additional info
- `connected`: information about network/AP that was connected to: - `connected`: information about network/AP that was connected to:
@ -334,6 +336,7 @@ Scan for available networks.
- `callback(ap_list)` a callback function to receive the list of APs when the scan is done. Each entry in the returned array follows the format used for [`wifi.sta.config()`](#wifistaconfig), with some additional fields. - `callback(ap_list)` a callback function to receive the list of APs when the scan is done. Each entry in the returned array follows the format used for [`wifi.sta.config()`](#wifistaconfig), with some additional fields.
The following fields are provided for each scanned AP: The following fields are provided for each scanned AP:
- `ssid`: the network SSID - `ssid`: the network SSID
- `bssid`: the BSSID of the AP - `bssid`: the BSSID of the AP
- `channel`: primary WiFi channel of the AP - `channel`: primary WiFi channel of the AP
@ -385,7 +388,6 @@ function can be used.
- `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.
@ -422,6 +424,7 @@ Registers callbacks for WiFi AP events.
the event. the event.
Event information provided for each event is as follows: Event information provided for each event is as follows:
- `start`: no additional info - `start`: no additional info
- `stop`: no additional info - `stop`: no additional info
- `sta_connected`: information about the client that connected: - `sta_connected`: information about the client that connected: