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

Show file tree
Hide file tree
Changes from 3 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
19 changes: 15 additions & 4 deletions cores/esp8266/Esp.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,22 @@ void EspClass::wdtFeed(void)

extern "C" void esp_yield();

void EspClass::deepSleep(uint64_t time_us, WakeMode mode)
bool EspClass::deepSleep(uint64_t time_us, WakeMode mode)
{
system_deep_sleep_set_option(static_cast<int>(mode));
system_deep_sleep(time_us);
esp_yield();
if (time_us > deepSleepMax())
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 not be more useful (and help fix peoples code which is broken already) if, instead of possibly printing an error and return false; , you just printed a warning and adjusted the time down to deepSleepMax()?

Existing code will not expect to ever get a return value and potentially go off into lala-land, since this was a void.

"Be conservative in what you do, be liberal in what you accept from others."

Copy link
Author

Choose a reason for hiding this comment

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

@earlephilhower Point taken. I'll make some changes to the code.

{
#ifdef DEBUG_SERIAL
DEBUG_SERIAL.println("Error: max sleeptime exceeded");
#endif
return 0; // error: max sleeptime exceeded
Copy link
Collaborator

Choose a reason for hiding this comment

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

return type is bool, but returned value is int => return false here

Copy link
Author

Choose a reason for hiding this comment

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

You're right.
Strange though that this is not detected by git code check.

}
else
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please remove else and braces.

{
system_deep_sleep_set_option(static_cast<int>(mode));
system_deep_sleep(time_us);
esp_yield();
return 1; // never gets called
}
}

//this calculation was taken verbatim from the SDK api reference for SDK 2.1.0.
Expand Down
2 changes: 1 addition & 1 deletion cores/esp8266/Esp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ class EspClass {
void wdtDisable();
void wdtFeed();

void deepSleep(uint64_t time_us, RFMode mode = RF_DEFAULT);
bool deepSleep(uint64_t time_us, RFMode mode = RF_DEFAULT);
uint64_t deepSleepMax();

bool rtcUserMemoryRead(uint32_t offset, uint32_t *data, size_t size);
Expand Down