summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library
diff options
context:
space:
mode:
authorJos Verlinde <jos.verlinde@microsoft.com>2022-02-07 18:34:57 +0100
committerDamien George <damien@micropython.org>2022-02-09 15:06:19 +1100
commit58cd2a8b0a16ba65b7390e425d37a825141735d3 (patch)
treeba0cb4ef3c3d10b2dc3d963e6a7ae76c712f364b /docs/library
parentf99b6799167a6cce97a7a683825f6ea27a892e6e (diff)
downloadmicropython-58cd2a8b0a16ba65b7390e425d37a825141735d3.tar.gz
micropython-58cd2a8b0a16ba65b7390e425d37a825141735d3.zip
docs/library/esp.rst: Document the osdebug function.
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/esp.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/library/esp.rst b/docs/library/esp.rst
index 5fb370065f..8920c8241e 100644
--- a/docs/library/esp.rst
+++ b/docs/library/esp.rst
@@ -62,6 +62,21 @@ Functions
.. function:: flash_erase(sector_no)
+.. function:: osdebug(level)
+
+ Turn esp os debugging messages on or off.
+
+ The *level* parameter sets the threshold for the log messages for all esp components.
+ The log levels are defined as constants:
+
+ * ``LOG_NONE`` -- No log output
+ * ``LOG_ERROR`` -- Critical errors, software module can not recover on its own
+ * ``LOG_WARN`` -- Error conditions from which recovery measures have been taken
+ * ``LOG_INFO`` -- Information messages which describe normal flow of events
+ * ``LOG_DEBUG`` -- Extra information which is not necessary for normal use (values, pointers, sizes, etc)
+ * ``LOG_VERBOSE`` -- Bigger chunks of debugging information, or frequent messages
+ which can potentially flood the output
+
.. function:: set_native_code_location(start, length)
**Note**: ESP8266 only