Skip to content

Commit 9fd270f

Browse files
tabarraigrr
authored andcommitted
Documenting a few Esp.cpp methods (#3057)
Adding: getCoreVersion, getSdkVersion, getCpuFreqMHz, getSketchSize, getFreeSketchSpace and getSketchMD5.
1 parent 0b47911 commit 9fd270f

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

doc/libraries.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,23 @@ APIs related to deep sleep and watchdog timer are available in the `ESP` object,
9393

9494
`ESP.restart()` restarts the CPU.
9595

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

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

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

102-
Several APIs may be used to get flash chip info:
102+
`ESP.getCoreVersion()` returns a String containing the core version.
103+
104+
`ESP.getSdkVersion()` returns the SDK version as a char.
105+
106+
`ESP.getCpuFreqMHz()` returns the CPU frequency in MHz as an unsigned 8-bit integer.
107+
108+
`ESP.getSketchSize()` returns the size of the current sketch as an unsigned 32-bit integer.
109+
110+
`ESP.getFreeSketchSpace()` returns the free sketch space as an unsigned 32-bit integer.
111+
112+
`ESP.getSketchMD5()` returns a lowercase String containing the MD5 of the current sketch.
103113

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

0 commit comments

Comments
 (0)