From 84c5275c37cf8c215ebb1e346b2ea096554c03af Mon Sep 17 00:00:00 2001 From: dnc40085 Date: Mon, 17 Apr 2017 04:45:32 -0700 Subject: [PATCH] Moved the documentation for wifi.nullmodesleep to the correct spot (#1913) --- docs/en/modules/wifi.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/en/modules/wifi.md b/docs/en/modules/wifi.md index 7e9d8344..8178c1d8 100644 --- a/docs/en/modules/wifi.md +++ b/docs/en/modules/wifi.md @@ -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.