Skip to content

Return error in class deepSleep() when max sleeptime is exceeded #4936

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

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open

Return error in class deepSleep() when max sleeptime is exceeded #4936

Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
37b8fa1
Check max sleeptime in class deepSleep()
Marc-Vreeburg Jul 18, 2018
c67c733
Update Esp.h
Marc-Vreeburg Jul 18, 2018
ed9967d
Merge branch 'master' into patch-1
devyte Jul 19, 2018
270da15
Merge branch 'master' into patch-1
Marc-Vreeburg Jul 20, 2018
0d0dd7b
Update Esp.cpp
Marc-Vreeburg Jul 20, 2018
a86f817
Update Esp.cpp
Marc-Vreeburg Jul 20, 2018
89854fc
Update Esp.cpp
Marc-Vreeburg Jul 20, 2018
fda08a6
Update Esp.cpp
Marc-Vreeburg Jul 20, 2018
d58f66a
Merge branch 'master' into patch-1
devyte Jul 20, 2018
609869f
Merge branch 'master' into patch-1
devyte Jul 23, 2018
8e270ac
Merge branch 'master' into patch-1
earlephilhower Jul 25, 2018
0c3b3e6
Update Esp.cpp
Marc-Vreeburg Jul 26, 2018
d0c16b5
Update Esp.h
Marc-Vreeburg Jul 26, 2018
b5b218a
Update Esp.cpp
Marc-Vreeburg Jul 26, 2018
5e5f13e
Merge branch 'master' into patch-1
earlephilhower Jul 26, 2018
033d5ef
Update Esp.cpp
Marc-Vreeburg Jul 26, 2018
ac538c2
Update Esp.cpp
Marc-Vreeburg Jul 26, 2018
fada2f6
Update Esp.cpp
Marc-Vreeburg Aug 3, 2018
cebeafc
Merge branch 'master' into patch-1
Marc-Vreeburg Aug 3, 2018
39a2121
Update Esp.h
Marc-Vreeburg Aug 3, 2018
24bb46d
Update Esp.cpp
Marc-Vreeburg Aug 4, 2018
26021c1
Update Esp.h
Marc-Vreeburg Aug 4, 2018
a8359f5
Merge branch 'master' into patch-1
Marc-Vreeburg Aug 4, 2018
364f341
Update Esp.cpp
Marc-Vreeburg Aug 4, 2018
eab0b4d
Update Esp.cpp
Marc-Vreeburg Aug 4, 2018
dfdb0dc
Merge branch 'master' into patch-1
d-a-v May 24, 2019
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
27 changes: 25 additions & 2 deletions cores/esp8266/Esp.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,13 @@ extern "C" void esp_yield();

void EspClass::deepSleep(uint64_t time_us, WakeMode mode)
{
if (time_us > deepSleepMax()) // we need to prevent the esp8266 from not waking up from deepsleep
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hate to dogpile here, but if you do find out that deepSleepMax() doesn't really work and need to derate by 5% or whatever, please use that # to compare and not deepSleepMax() in this if condition. Otherwise someone will pass in, say, deepSleepMax() - 1 which won't work but which won't be caught by this check.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it also be wise to increasingly loop the whole function until users's time_us is reached ?

{
time_us = deepSleepMax();
#ifdef DEBUG_SERIAL
DEBUG_SERIAL.println("Warning: max sleeptime (possibly) exceeded; risking esp8266 never waking from deepsleep; sleeptime has been adjusted to safest max possible sleeptime!");
#endif
}
system_deep_sleep_set_option(static_cast<int>(mode));
system_deep_sleep(time_us);
esp_yield();
Expand All @@ -127,9 +134,25 @@ void EspClass::deepSleepInstant(uint64_t time_us, WakeMode mode)
//Note: system_rtc_clock_cali_proc() returns a uint32_t, even though system_deep_sleep() takes a uint64_t.
uint64_t EspClass::deepSleepMax()
{
//This calculation was taken verbatim from the SDK api reference for SDK 2.1.0.
//Note: system_rtc_clock_cali_proc() returns a uint32_t, even though system_deep_sleep() takes a uint64_t.
//cali*(2^31-1)/(2^12)
return (uint64_t)system_rtc_clock_cali_proc()*(0x80000000-1)/(0x1000);

//return (uint64_t)system_rtc_clock_cali_proc()*(0x80000000-1)/(0x1000);
//
//At this moment using time_us >= (uint64_t)system_rtc_clock_cali_proc()*(0x80000000-1)/(0x1000) can result in the esp8266
//never waking up from deepsleep.
//This issue seems to be a problem in the Espressif api and has been mentioned at git espressif/ESP8266_NONOS_SDK under #157.
//
//A safe calculation of max deepsleep has been derived:
//(time_in_us / cali) << 12 < 2^31 - 1 (api reference)
//time_in_us < (cali << (31-12))
//time_in_us < (cali<<19)
//time_in_s * 1000000 < cali * 524288
//time_in_s < cali * 0.524288
//assured by time_in_s < cali/2
//Theoretical max sleeptime is around 3.5 to 4 hours. Safe max sleeptime shortens theoretical max sleeptime by approximately
//10 minutes.
return ((uint64_t)system_rtc_clock_cali_proc()/2*(0xF4240ULL)-1);
}

/*
Expand Down