From d054c1c0c87d444c2e34e0e49f5e357e401ee209 Mon Sep 17 00:00:00 2001 From: Martin Hjelmare Date: Sat, 6 Aug 2016 14:39:12 +0200 Subject: [PATCH] Update doxygen docs with new smartSleep behavior (#545) * Update doxygen docs with new smartSleep behavior * Update docs to new behavior. * Add info on how to set wait time in smartSleep. * Fix incorrect docs regarding return value of smartSleep. * Update docs for return value of all sleep methods * Clarify the return value of the sleep methods, suggested by @mfalkvidd. --- core/MySensorsCore.h | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/core/MySensorsCore.h b/core/MySensorsCore.h index 5d52a8b..e306477 100644 --- a/core/MySensorsCore.h +++ b/core/MySensorsCore.h @@ -234,7 +234,8 @@ bool wait(unsigned long ms, uint8_t cmd, uint8_t msgtype); */ int8_t sleep(unsigned long ms); /** -* Same as sleep(), send heartbeat upon wakeup and process incoming messages +* Same as sleep(), send heartbeat and process incoming messages before going to sleep. +* Specify the time to wait for incoming messages by defining MY_SMART_SLEEP_WAIT_DURATION to a time (ms). * @param ms Number of milliseconds to sleep. * @return -1 if timer woke it up, -2 if not possible (e.g. ongoing FW update) */ @@ -247,15 +248,16 @@ int8_t smartSleep(unsigned long ms); * @param interrupt Interrupt that should trigger the wakeup * @param mode RISING, FALLING, CHANGE * @param ms Number of milliseconds to sleep or 0 to sleep forever - * @return Interrupt number wake up was triggered by pin change, -1 if timer woke it up, -2 if not possible (e.g. ongoing FW update) + * @return Interrupt number if wake up was triggered by pin change, -1 if wake up was triggered by timer, -2 if sleep was not possible (e.g. ongoing FW update) */ int8_t sleep(uint8_t interrupt, uint8_t mode, unsigned long ms=0); /** -* Same as sleep(), send heartbeat upon wakeup and process incoming messages +* Same as sleep(), send heartbeat and process incoming messages before going to sleep. +* Specify the time to wait for incoming messages by defining MY_SMART_SLEEP_WAIT_DURATION to a time (ms). * @param interrupt Interrupt that should trigger the wakeup * @param mode RISING, FALLING, CHANGE -* @param ms Number of milliseconds to sleep. -* @return -1 if timer woke it up, -2 if not possible (e.g. ongoing FW update) +* @param ms Number of milliseconds to sleep or 0 to sleep forever +* @return Interrupt number if wake up was triggered by pin change, -1 if wake up was triggered by timer, -2 if sleep was not possible (e.g. ongoing FW update) */ int8_t smartSleep(uint8_t interrupt, uint8_t mode, unsigned long ms=0); @@ -268,17 +270,18 @@ int8_t smartSleep(uint8_t interrupt, uint8_t mode, unsigned long ms=0); * @param interrupt2 Second interrupt that should trigger the wakeup * @param mode2 Mode for second interrupt (RISING, FALLING, CHANGE) * @param ms Number of milliseconds to sleep or 0 to sleep forever - * @return Interrupt number wake up was triggered by pin change, -1 if timer woke it up, -2 if not possible (e.g. ongoing FW update) + * @return Interrupt number if wake up was triggered by pin change, -1 if wake up was triggered by timer, -2 if sleep was not possible (e.g. ongoing FW update) */ int8_t sleep(uint8_t interrupt1, uint8_t mode1, uint8_t interrupt2, uint8_t mode2, unsigned long ms=0); /** -* Same as sleep(), send heartbeat upon wakeup and process incoming messages +* Same as sleep(), send heartbeat and process incoming messages before going to sleep. +* Specify the time to wait for incoming messages by defining MY_SMART_SLEEP_WAIT_DURATION to a time (ms). * @param interrupt1 First interrupt that should trigger the wakeup * @param mode1 Mode for first interrupt (RISING, FALLING, CHANGE) * @param interrupt2 Second interrupt that should trigger the wakeup * @param mode2 Mode for second interrupt (RISING, FALLING, CHANGE) * @param ms Number of milliseconds to sleep or 0 to sleep forever -* @return Interrupt number wake up was triggered by pin change, -1 if timer woke it up, -2 if not possible (e.g. ongoing FW update) +* @return Interrupt number if wake up was triggered by pin change, -1 if wake up was triggered by timer, -2 if sleep was not possible (e.g. ongoing FW update) */ int8_t smartSleep(uint8_t interrupt1, uint8_t mode1, uint8_t interrupt2, uint8_t mode2, unsigned long ms=0);