Skip to content

Update wifi suspend documentation #1910

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

Merged
merged 2 commits into from
Apr 16, 2017
Merged

Update wifi suspend documentation #1910

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40800d2
Added message about potential for wifi crashes and more
dnc40085 Apr 15, 2017
38a136d
Fix admonition formatting
marcelstoer Apr 16, 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
13 changes: 12 additions & 1 deletion docs/en/modules/wifi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
| :----- | :-------------------- | :---------- | :------ |
| 2015-05-12 | [Zeroday](https://github.com/funshine) | [dnc40085](https://github.com/dnc40085) | [wifi.c](../../../app/modules/wifi.c)|

!!! important
The WiFi subsystem is maintained by background tasks that must run periodically. Any function or task that takes longer than 15ms (milliseconds) may cause the WiFi subsystem to crash. To avoid these potential crashes, it is advised that the WiFi subsystem be suspended with [wifi.suspend()](#wifisuspend) prior to the execution of any tasks or functions that exceed this 15ms guideline.


The NodeMCU WiFi control is spread across several tables:

- `wifi` for overall WiFi configuration
Expand Down Expand Up @@ -78,6 +82,10 @@ The current physical mode as one of `wifi.PHYMODE_B`, `wifi.PHYMODE_G` or `wifi.

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.

#### Syntax
`wifi.resume([resume_cb])`

Expand Down Expand Up @@ -257,7 +265,10 @@ none

Suspend Wifi to reduce current consumption.

This function is also useful for preventing WiFi stack related crashes when executing functions or tasks that take longer than ~500ms
!!! 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.


#### Syntax
`wifi.suspend({duration[, suspend_cb, resume_cb, preserve_mode]})`
Expand Down