Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Apr 17, 2017
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e559160
Fix admonition formatting error in wifi module docs added with #1910
dnc40085 Apr 16, 2017
c4f6d33
More wifi documentation changes
dnc40085 Apr 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions docs/en/modules/wifi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,10 @@ The current physical mode as one of `wifi.PHYMODE_B`, `wifi.PHYMODE_G` or `wifi.

## 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
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 occurs asynchronously and will only execute after wifi has resumed normal operation.
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.

#### Syntax
`wifi.resume([resume_cb])`
Expand Down Expand Up @@ -262,12 +261,10 @@ none
[`wifi.startsmart()`](#wifistartsmart)

## wifi.suspend()

Suspend Wifi to reduce current consumption.

!!! 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)
The suspend callback also occurs asynchronously and will only execute after wifi has been successfully been suspended.
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.


#### Syntax
Expand Down