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

Fix admonition formatting error in wifi module docs added with #1910 (#1912) 

* Fix admonition formatting error in wifi module docs added with #1910

Modified documentation for:
  wifi.suspend()
  wifi.resume()

* More wifi documentation changes
This commit is contained in:
dnc40085 2017-04-16 23:27:12 -07:00 committed by Marcel Stör
parent 2f8b35365a
commit 971627f3d3
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -80,11 +80,10 @@ The current physical mode as one of `wifi.PHYMODE_B`, `wifi.PHYMODE_G` or `wifi.
## wifi.resume() ## wifi.resume()
Wake up WiFi from suspended state or cancel pending wifi suspension Wake up WiFi from suspended state or cancel pending wifi suspension.
!!! note !!! note
Wifi resume occurs asynchronously, this means that the resume request will only be processed when control of the processor is passed back to the SDK (after MyResumeFunction() has completed) Wifi resume occurs asynchronously, this means that the resume request will only be processed when control of the processor is passed back to the SDK (after MyResumeFunction() has completed). The resume callback also executes asynchronously and will only execute after wifi has resumed normal operation.
The resume callback also occurs asynchronously and will only execute after wifi has resumed normal operation.
#### Syntax #### Syntax
`wifi.resume([resume_cb])` `wifi.resume([resume_cb])`
@ -262,12 +261,10 @@ none
[`wifi.startsmart()`](#wifistartsmart) [`wifi.startsmart()`](#wifistartsmart)
## wifi.suspend() ## wifi.suspend()
Suspend Wifi to reduce current consumption. Suspend Wifi to reduce current consumption.
!!! note !!! note
Wifi suspension occurs asynchronously, this means that the suspend request will only be processed when control of the processor is passed back to the SDK (after MySuspendFunction() has completed) Wifi suspension occurs asynchronously, this means that the suspend request will only be processed when control of the processor is passed back to the SDK (after MySuspendFunction() has completed). The suspend callback also executes asynchronously and will only execute after wifi has been successfully been suspended.
The suspend callback also occurs asynchronously and will only execute after wifi has been successfully been suspended.
#### Syntax #### Syntax