Debugging Utilities#
EmberZNet debugging utilities.
See ember-debug.h for source code.
Functions#
Print the filename and line number to the debug serial port.
Print the contents of RAM to the debug serial port.
Print binary data to the debug channel.
Send VUART data out the debug channel.
Print an EmberStatus return code to the serial port.
Turn off all debug output.
Restore the state of the debug output.
Prints text debug messages.
Macros#
This function is obsolete and no longer required to initialize the debug system.
Function Documentation#
emberDebugAssert#
void emberDebugAssert (const char *filename, int linenumber)
Print the filename and line number to the debug serial port.
| N/A | filename | The name of the file where the assert occurred. |
| N/A | linenumber | The line number in the file where the assert occurred. |
54 of file stack/include/ember-debug.hemberDebugMemoryDump#
void emberDebugMemoryDump (uint8_t *start, uint8_t *end)
Print the contents of RAM to the debug serial port.
| N/A | start | The start address of the block of RAM to dump. |
| N/A | end | The end address of the block of RAM to dump (address of the last byte). |
63 of file stack/include/ember-debug.hemberDebugBinaryPrintf#
void emberDebugBinaryPrintf (const char *formatString,...)
Print binary data to the debug channel.
| N/A | formatString | A string of conversion specification characters describing the arguments to be printed. |
| N/A | The arguments to be printed. |
This function does not use the normal printf format conventions. To print text debug messages, use emberDebugPrintf(). The format string must contain only these conversion specification characters:
B - uint8_t value.
W - uint16_t value, printed least significant byte first.
D - uint32_t value, printed least significant byte first.
F - pointer to null terminated string in Flash (const char *).
xxxp - pointer to RAM, length is xxx (max 255).
lp - pointer to RAM, length is uint8_t argument.
xxxf - pointer to Flash (const char *), length is xxx (max 255).
lf - pointer to Flash (const char *), length is uint8_t argument.
b - EmberMessageBuffer.
Examples:
emberDebugBinaryPrintf("BWD", status, panId, channelMask);
emberDebugBinaryPrintf("F8p", "string example", eui64);
emberDebugBinaryPrintf("lp64fb", length, bytes, dataTable, buffer);
91 of file stack/include/ember-debug.hemDebugSendVuartMessage#
void emDebugSendVuartMessage (uint8_t *buff, uint8_t len)
Send VUART data out the debug channel.
| N/A | buff | A pointer to the data to send. |
| N/A | len | The length of the data to send. |
99 of file stack/include/ember-debug.hemberDebugError#
void emberDebugError (EmberStatus code)
Print an EmberStatus return code to the serial port.
| N/A | code | The EmberStatus code to print. |
106 of file stack/include/ember-debug.hemberDebugReportOff#
bool emberDebugReportOff (void)
Turn off all debug output.
| N/A |
Returns
The current state (true for on, false for off).
112 of file stack/include/ember-debug.hemberDebugReportRestore#
void emberDebugReportRestore (bool state)
Restore the state of the debug output.
| N/A | state | The state returned from emberDebugReportOff(). This is done so that debug output is not blindly turned on. |
119 of file stack/include/ember-debug.hemberDebugPrintf#
void emberDebugPrintf (const char *formatString,...)
Prints text debug messages.
| N/A | formatString | Takes the following: |
| N/A |
%% | Percent sign |
|---|---|
%c | Single-byte char |
%s | RAM string |
%p | Flash string (does not follow the printf standard) |
%u | Two-byte unsigned decimal |
%d | Two-byte signed decimal |
%x, %%2x, %%4x | 1-, 2-, 4-byte hex value (always 0 padded; does not follow the printf standard) |
138 of file stack/include/ember-debug.hMacro Definition Documentation#
emberDebugInit#
#define emberDebugInitValue:
(port)
This function is obsolete and no longer required to initialize the debug system.
42 of file stack/include/ember-debug.hDEBUG_ROUTINES_PRESENT#
#define DEBUG_ROUTINES_PRESENT
46 of file stack/include/ember-debug.h