Debugging Utilities
Debugging Utilities.
Macros |
|
#define | NO_DEBUG 0 |
#define | BASIC_DEBUG 1 |
#define | FULL_DEBUG 2 |
#define | emberDebugInit (port) do {} while (false) |
This function is obsolete and no longer required to initialize the debug system.
|
Functions |
|
void | emberDebugAssert (PGM_P filename, int linenumber) |
Prints the filename and line number to the debug serial port.
|
|
void | emberDebugMemoryDump (uint8_t *start, uint8_t *end) |
Prints the contents of RAM to the debug serial port.
|
|
void | emberDebugBinaryPrintf (PGM_P formatString,...) |
Prints binary data to the debug channel.
|
|
void | emDebugSendVuartMessage (const uint8_t *buff, uint8_t len) |
An internal debug command used by the HAL to send vuart data out the the debug channel.
|
|
void | emberDebugError ( EmberStatus code) |
Prints an
EmberStatus
return code to the serial port.
|
|
bool | emberDebugReportOff (void) |
Turns off all debug output.
|
|
void | emberDebugReportRestore (bool state) |
Restores the state of the debug output.
|
|
void | emberDebugPrintf (PGM_P formatString,...) |
Prints text debug messages.
|
Detailed Description
A set of utilities for printing to the debug backchannel.
See
ember-debug.h
for source code.
Macro Definition Documentation
#define BASIC_DEBUG 1 |
#define emberDebugInit | ( |
port
|
) | do {} while (false) |
- Parameters
-
port
Ignored because the port used for debug communication is automatically determined for each platform.
#define FULL_DEBUG 2 |
#define NO_DEBUG 0 |
Function Documentation
void emberDebugAssert | ( | PGM_P |
filename,
|
int |
linenumber
|
||
) |
- Parameters
-
filename
The name of the file where the assert occurred. linenumber
The line number in the file where the assert occurred.
void emberDebugBinaryPrintf | ( | PGM_P |
formatString,
|
...
|
|||
) |
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 (PGM_P).
- xxxp - pointer to RAM, length is xxx (max 255).
- lp - pointer to RAM, length is uint8_t argument.
- xxxf - pointer to Flash (PGM_P), length is xxx (max 255).
- lf - pointer to Flash (PGM_P), length is uint8_t argument.
- b - EmberMessageBuffer.
Examples:
- Parameters
-
formatString
A string of conversion specification characters describing the arguments to be printed. ...
The arguments to be printed.
void emberDebugError | ( | EmberStatus |
code
|
) |
- Parameters
-
code
The EmberStatus code to print.
void emberDebugMemoryDump | ( | uint8_t * |
start,
|
uint8_t * |
end
|
||
) |
- Parameters
-
start
The start address of the block of RAM to dump. end
The end address of the block of RAM to dump (address of the last byte).
void emberDebugPrintf | ( | PGM_P |
formatString,
|
...
|
|||
) |
- Parameters
-
formatString
Takes the following:
%% | 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) |
bool emberDebugReportOff | ( | void |
|
) |
- Returns
- The current state (true for on, false for off).
void emberDebugReportRestore | ( | bool |
state
|
) |
- Parameters
-
state
The state returned from emberDebugReportOff() . This is done so that debug output is not blindly turned on.
void emDebugSendVuartMessage | ( | const uint8_t * |
buff,
|
uint8_t |
len
|
||
) |
- Parameters
-
buff
A pointer to the data to send len
Lenght of the data to send