Moved the documentation for wifi.nullmodesleep to the correct spot (#1913)

This commit is contained in:
dnc40085 2017-04-17 04:45:32 -07:00 committed by Marcel Stör
parent 971627f3d3
commit 84c5275c37
1 changed files with 20 additions and 20 deletions

View File

@ -78,6 +78,26 @@ The current physical mode as one of `wifi.PHYMODE_B`, `wifi.PHYMODE_G` or `wifi.
#### See also
[`wifi.setphymode()`](#wifisetphymode)
## wifi.nullmodesleep()
Configures whether or not WiFi automatically goes to sleep in NULL_MODE. Enabled by default.
!!! note
This function **does not** store it's setting in flash, if auto sleep in NULL_MODE is not desired, `wifi.nullmodesleep(false)` must be called after power-up, restart, or wake from deep sleep.
#### Syntax
`wifi.nullmodesleep([enable])`
#### Parameters
- `enable`
- `true` Enable WiFi auto sleep in NULL_MODE. (Default setting)
- `false` Disable WiFi auto sleep in NULL_MODE.
#### Returns
- `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 `enable` argument, confirmation of new setting is returned.
## wifi.resume()
Wake up WiFi from suspended state or cancel pending wifi suspension.
@ -188,26 +208,6 @@ physical mode after setup
#### See also
[`wifi.getphymode()`](#wifigetphymode)
## wifi.nullmodesleep()
Configures whether or not WiFi automatically goes to sleep in NULL_MODE. Enabled by default.
!!! note
This function **does not** store it's setting in flash, if auto sleep in NULL_MODE is not desired, `wifi.nullmodesleep(false)` must be called after power-up, restart, or wake from deep sleep.
#### Syntax
`wifi.nullmodesleep([enable])`
#### Parameters
- `enable`
- `true` Enable WiFi auto sleep in NULL_MODE. (Default setting)
- `false` Disable WiFi auto sleep in NULL_MODE.
#### Returns
- `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 `enable` argument, confirmation of new setting is returned.
## wifi.startsmart()
Starts to auto configuration, if success set up SSID and password automatically.