From 773ad9fd70d0b8e02fa16071c2010acaf4694d6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9?= Date: Sat, 18 Mar 2017 00:40:28 -0300 Subject: [PATCH 1/2] Documenting a few Esp.cpp methods Adding: getCoreVersion, getSdkVersion, getCpuFreqMHz, getSketchSize, getFreeSketchSpace and getSketchMD5. --- doc/libraries.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/libraries.md b/doc/libraries.md index c22a3d8cec..c6bebbc949 100644 --- a/doc/libraries.md +++ b/doc/libraries.md @@ -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. + +`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. From e719ed1c52ff879f797a3f2ddc31877cf680eeb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9?= Date: Sun, 14 May 2017 02:33:22 -0300 Subject: [PATCH 2/2] fixed typo and int size --- doc/libraries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/libraries.md b/doc/libraries.md index 472d33144e..0aa2532492 100644 --- a/doc/libraries.md +++ b/doc/libraries.md @@ -107,7 +107,7 @@ APIs related to deep sleep and watchdog timer are available in the `ESP` object, `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. +`ESP.getFreeSketchSpace()` returns the free sketch space as an unsigned 32-bit integer. `ESP.getSketchMD5()` returns a lowercase String containing the MD5 of the current sketch.