Skip to content
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

Jump to bottom

Documenting a few Esp.cpp methods #3057

Merged
merged 3 commits into from
May 14, 2017
Merged

Documenting a few Esp.cpp methods #3057

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
773ad9f
Documenting a few Esp.cpp methods
tabarra Mar 18, 2017
e032e76
Merge branch 'master' into patch-1
tabarra May 14, 2017
e719ed1
fixed typo and int size
tabarra May 14, 2017
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
14 changes: 12 additions & 2 deletions doc/libraries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,23 @@ APIs related to deep sleep and watchdog timer are available in the `ESP` object,

`ESP.restart()` restarts the CPU.

`ESP.getResetReason()` returns String containing the last reset reason in human readable format.
`ESP.getResetReason()` returns a String containing the last reset reason in human readable format.

`ESP.getFreeHeap()` returns the free heap size.

`ESP.getChipId()` returns the ESP8266 chip ID as a 32-bit integer.

Several APIs may be used to get flash chip info:
`ESP.getCoreVersion()` returns a String containing the core version.

`ESP.getSdkVersion()` returns the SDK version as a char.

`ESP.getCpuFreqMHz()` returns the CPU frequency in MHz as an unsigned 8-bit integer.

`ESP.getSketchSize()` returns the size of the current sketch as an unsigned 32-bit integer.

`ESP.getFreeSketchSpace()` returns the free sketch space as an unsigned 8-bit intege.
Copy link
Member

Choose a reason for hiding this comment

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

Typo, "intege". Also the function returns an uint32_t, not an uint8_t.


`ESP.getSketchMD5()` returns a lowercase String containing the MD5 of the current sketch.

`ESP.getFlashChipId()` returns the flash chip ID as a 32-bit integer.

Expand Down