Changes between Initial Version and Version 1 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/Debug/DEBUG_SHOWDATA

Timestamp:

09/26/18 07:31:51 (6 years ago)

Author:

Don Wilson

Comment:

--

Docs/Prog/Manual/ApplicationLibraries/lib825ev/Debug/DEBUG_SHOWDATA

@@ +1 @@
+= DEBUG_SHOWDATA =
+Display binary data in readable (ASCII and hexadecimal) on the serial or telnet console
+
+{{{
+DEBUG_SHOWDATA(const char *msg, const uint8* data, int len)
+}}}
+
+== Parameters == 
+
+ * msg - message to display
+ * data - binary data pointer to display
+ * len - number of bytes of binary data to display
+
+== Return Value ==
+
+ * void - no return value
+
+== Remarks ==
+
+Provides debug output message to show binary data. Output code will only be compiled into debug build. Release builds will not compile in this in so there is no overhead for release build.
+
+== Examples ==
+
+{{{
+uint8 req[] = { 0x02, 'W', 0x03 };
+DEBUG_SHOWDATA("Request", req, sizeof(req));
+
+// Output will look like: Request [{02}W{03}]
+// Non readable characters are shown as hexadecimal within braces such as {02}
+
+}}}
+
+