From ded599f8ba5a006de7e787d7ec9f66f5b650bc8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Thu, 19 Oct 2017 10:00:41 +0200 Subject: [PATCH] Add missing admonitions (#2107) Amends #2064 --- docs/en/modules/node.md | 3 +++ docs/en/modules/tmr.md | 7 ++++++- docs/en/modules/wifi.md | 6 ++++++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/en/modules/node.md b/docs/en/modules/node.md index 4ce7fd78..2a3c24d8 100644 --- a/docs/en/modules/node.md +++ b/docs/en/modules/node.md @@ -335,6 +335,9 @@ Put NodeMCU in light sleep mode to reduce current consumption. * All active timers will be suspended and then resumed when NodeMCU wakes from sleep. * Any previously suspended timers will be resumed when NodeMCU wakes from sleep. +!!! attention + This is disabled by default. Modify `PMSLEEP_ENABLE` in `app/include/user_config.h` to enable it. + #### Syntax `node.sleep({wake_gpio[, duration, int_type, resume_cb, preserve_mode]})` diff --git a/docs/en/modules/tmr.md b/docs/en/modules/tmr.md index afc9089a..74fbb072 100644 --- a/docs/en/modules/tmr.md +++ b/docs/en/modules/tmr.md @@ -340,6 +340,9 @@ if not mytimer:stop() then print("timer not stopped, not registered?") end Suspend an armed timer. +!!! attention + This is disabled by default. Modify `ENABLE_TIMER_SUSPEND` in `app/include/user_config.h` to enable it. + * Timers can be suspended at any time after they are armed. * If a timer is rearmed with `tmr.start` or `tmr.alarm` any matching suspended timers will be discarded. @@ -371,11 +374,13 @@ tmr.suspend(mytimer) Suspend all currently armed timers. +!!! attention + This is disabled by default. Modify `ENABLE_TIMER_SUSPEND` in `app/include/user_config.h` to enable it. + !!! Warning This function suspends ALL active timers, including any active timers started by the NodeMCU subsystem or other modules. this may cause parts of your program to stop functioning properly. USE THIS FUNCTION AT YOUR OWN RISK! - #### Syntax `tmr.suspend_all()` diff --git a/docs/en/modules/wifi.md b/docs/en/modules/wifi.md index 87b38598..4a054488 100644 --- a/docs/en/modules/wifi.md +++ b/docs/en/modules/wifi.md @@ -102,6 +102,9 @@ Configures whether or not WiFi automatically goes to sleep in NULL_MODE. Enabled Wake up WiFi from suspended state or cancel pending wifi suspension. +!!! attention + This is disabled by default. Modify `PMSLEEP_ENABLE` in `app/include/user_config.h` to enable it. + !!! 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 executes asynchronously and will only execute after wifi has resumed normal operation. @@ -263,6 +266,9 @@ none ## wifi.suspend() Suspend Wifi to reduce current consumption. +!!! attention + This is disabled by default. Modify `PMSLEEP_ENABLE` in `app/include/user_config.h` to enable it. + !!! 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 executes asynchronously and will only execute after wifi has been successfully been suspended.