debug.h File Reference

#include <stdio.h>
#include <stdint.h>
#include <Arduino.h>
#include "os_port.h"

Go to the source code of this file.

Macros
#define	OK_STRING   "OK"
#define	NO_STRING   "NO"
#define	YES_STRING   "YES"
#define	FAIL_STRING   "FAIL"
#define	ERROR_STRING   "ERROR"
#define	REDUNDANT_STRING   "REDUNDANT"
#define	MAIN_STRING   "MAIN"
#define	ON_STRING   "ON"
#define	OFF_STRING   "OFF"
#define	SUSPEND_STRING   "x"
#define	FLAG_STRING   "*"
#define	SPACE_STRING   " "
#define	TRACE_LEVEL_OFF   0
#define	TRACE_LEVEL_FATAL   1
#define	TRACE_LEVEL_ERROR   2
#define	TRACE_LEVEL_WARNING   3
#define	TRACE_LEVEL_INFO   4
#define	TRACE_LEVEL_DEBUG   5
#define	TRACE_LEVEL_VERBOSE   6
#define	TRACE_LEVEL   TRACE_LEVEL_DEBUG
#define	TRACE_PRINTF(...)   osSuspendAllTasks(), print_debug(__VA_ARGS__), osResumeAllTasks()
#define	TRACE_ARRAY(p, a, n)   osSuspendAllTasks(), print_debug_array(p, a, n), osResumeAllTasks()
#define	TRACE_MPI(p, a)   osSuspendAllTasks(), mpiDump(stdout, p, a), osResumeAllTasks()
#define	TRACE_FATAL(...)   TRACE_PRINTF(__VA_ARGS__)
#define	TRACE_FATAL_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
#define	TRACE_FATAL_MPI(p, a)   TRACE_MPI(p, a)
#define	TRACE_ERROR(...)   TRACE_PRINTF(__VA_ARGS__)
#define	TRACE_ERROR_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
#define	TRACE_ERROR_MPI(p, a)   TRACE_MPI(p, a)
#define	TRACE_WARNING(...)   TRACE_PRINTF(__VA_ARGS__)
#define	TRACE_WARNING_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
#define	TRACE_WARNING_MPI(p, a)   TRACE_MPI(p, a)
#define	TRACE_INFO(...)   TRACE_PRINTF(__VA_ARGS__)
#define	TRACE_INFO_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
#define	TRACE_INFO_NET_BUFFER(p, b, o, n)
#define	TRACE_INFO_MPI(p, a)   TRACE_MPI(p, a)
#define	TRACE_DEBUG(...)   TRACE_PRINTF(__VA_ARGS__)
#define	TRACE_DEBUG_ARRAY(p, a, n)   TRACE_ARRAY(p, a, n)
#define	TRACE_DEBUG_NET_BUFFER(p, b, o, n)
#define	TRACE_DEBUG_MPI(p, a)   TRACE_MPI(p, a)
#define	TRACE_VERBOSE(...)
#define	TRACE_VERBOSE_ARRAY(p, a, n)
#define	TRACE_VERBOSE_NET_BUFFER(p, b, o, n)
#define	TRACE_VERBOSE_MPI(p, a)
#define	printError(error, ok_str, error_str)   (error == NO_ERROR ? ok_str : error_str)
#define	TRACE_LEVEL_NO_TRACE   TRACE_LEVEL_OFF

Functions
void	print_debug (const char *fmt,...)
	Print debug from ram. More...
void	init_debug (uint32_t baudrate)
	init serial monitor More...
void	print_debug_array (const char *prepend, const void *data, size_t length)
	Display the contents of an array. More...

Macro Definition Documentation

ERROR_STRING

#define ERROR_STRING   "ERROR"

Definition at line 37 of file debug.h.

FAIL_STRING

#define FAIL_STRING   "FAIL"

Definition at line 36 of file debug.h.

FLAG_STRING

#define FLAG_STRING   "*"

Definition at line 43 of file debug.h.

MAIN_STRING

#define MAIN_STRING   "MAIN"

Definition at line 39 of file debug.h.

NO_STRING

#define NO_STRING   "NO"

Definition at line 34 of file debug.h.

OFF_STRING

#define OFF_STRING   "OFF"

Definition at line 41 of file debug.h.

OK_STRING

#define OK_STRING   "OK"

Definition at line 33 of file debug.h.

ON_STRING

#define ON_STRING   "ON"

Definition at line 40 of file debug.h.

printError

#define printError	(		error,
			ok_str,
			error_str
	)		(error == NO_ERROR ? ok_str : error_str)

Definition at line 142 of file debug.h.

REDUNDANT_STRING

#define REDUNDANT_STRING   "REDUNDANT"

Definition at line 38 of file debug.h.

SPACE_STRING

#define SPACE_STRING   " "

Definition at line 44 of file debug.h.

SUSPEND_STRING

#define SUSPEND_STRING   "x"

Definition at line 42 of file debug.h.

TRACE_ARRAY

#define TRACE_ARRAY	(		p,
			a,
			n
	)		osSuspendAllTasks(), print_debug_array(p, a, n), osResumeAllTasks()

Definition at line 68 of file debug.h.

TRACE_DEBUG

#define TRACE_DEBUG

(

...

)

TRACE_PRINTF(__VA_ARGS__)

Definition at line 119 of file debug.h.

TRACE_DEBUG_ARRAY

#define TRACE_DEBUG_ARRAY	(		p,
			a,
			n
	)		TRACE_ARRAY(p, a, n)

Definition at line 120 of file debug.h.

TRACE_DEBUG_MPI

#define TRACE_DEBUG_MPI	(		p,
			a
	)		TRACE_MPI(p, a)

Definition at line 122 of file debug.h.

TRACE_DEBUG_NET_BUFFER

#define TRACE_DEBUG_NET_BUFFER	(		p,
			b,
			o,
			n
	)

Definition at line 121 of file debug.h.

TRACE_ERROR

#define TRACE_ERROR

(

...

)

TRACE_PRINTF(__VA_ARGS__)

Definition at line 87 of file debug.h.

TRACE_ERROR_ARRAY

#define TRACE_ERROR_ARRAY	(		p,
			a,
			n
	)		TRACE_ARRAY(p, a, n)

Definition at line 88 of file debug.h.

TRACE_ERROR_MPI

#define TRACE_ERROR_MPI	(		p,
			a
	)		TRACE_MPI(p, a)

Definition at line 89 of file debug.h.

TRACE_FATAL

#define TRACE_FATAL

(

...

)

TRACE_PRINTF(__VA_ARGS__)

Definition at line 77 of file debug.h.

TRACE_FATAL_ARRAY

#define TRACE_FATAL_ARRAY	(		p,
			a,
			n
	)		TRACE_ARRAY(p, a, n)

Definition at line 78 of file debug.h.

TRACE_FATAL_MPI

#define TRACE_FATAL_MPI	(		p,
			a
	)		TRACE_MPI(p, a)

Definition at line 79 of file debug.h.

TRACE_INFO

#define TRACE_INFO

(

...

)

TRACE_PRINTF(__VA_ARGS__)

Definition at line 107 of file debug.h.

TRACE_INFO_ARRAY

#define TRACE_INFO_ARRAY	(		p,
			a,
			n
	)		TRACE_ARRAY(p, a, n)

Definition at line 108 of file debug.h.

TRACE_INFO_MPI

#define TRACE_INFO_MPI	(		p,
			a
	)		TRACE_MPI(p, a)

Definition at line 110 of file debug.h.

TRACE_INFO_NET_BUFFER

#define TRACE_INFO_NET_BUFFER	(		p,
			b,
			o,
			n
	)

Definition at line 109 of file debug.h.

TRACE_LEVEL

#define TRACE_LEVEL   TRACE_LEVEL_DEBUG

Definition at line 57 of file debug.h.

TRACE_LEVEL_DEBUG

#define TRACE_LEVEL_DEBUG   5

Definition at line 52 of file debug.h.

TRACE_LEVEL_ERROR

#define TRACE_LEVEL_ERROR   2

Definition at line 49 of file debug.h.

TRACE_LEVEL_FATAL

#define TRACE_LEVEL_FATAL   1

Definition at line 48 of file debug.h.

TRACE_LEVEL_INFO

#define TRACE_LEVEL_INFO   4

Definition at line 51 of file debug.h.

TRACE_LEVEL_NO_TRACE

#define TRACE_LEVEL_NO_TRACE   TRACE_LEVEL_OFF

Definition at line 155 of file debug.h.

TRACE_LEVEL_OFF

#define TRACE_LEVEL_OFF   0

Definition at line 47 of file debug.h.

TRACE_LEVEL_VERBOSE

#define TRACE_LEVEL_VERBOSE   6

Definition at line 53 of file debug.h.

TRACE_LEVEL_WARNING

#define TRACE_LEVEL_WARNING   3

Definition at line 50 of file debug.h.

TRACE_MPI

#define TRACE_MPI	(		p,
			a
	)		osSuspendAllTasks(), mpiDump(stdout, p, a), osResumeAllTasks()

Definition at line 72 of file debug.h.

TRACE_PRINTF

#define TRACE_PRINTF

(

...

)

osSuspendAllTasks(), print_debug(__VA_ARGS__), osResumeAllTasks()

Definition at line 64 of file debug.h.

TRACE_VERBOSE

#define TRACE_VERBOSE

(

...

)

Definition at line 136 of file debug.h.

TRACE_VERBOSE_ARRAY

#define TRACE_VERBOSE_ARRAY	(		p,
			a,
			n
	)

Definition at line 137 of file debug.h.

TRACE_VERBOSE_MPI

#define TRACE_VERBOSE_MPI	(		p,
			a
	)

Definition at line 139 of file debug.h.

TRACE_VERBOSE_NET_BUFFER

#define TRACE_VERBOSE_NET_BUFFER	(		p,
			b,
			o,
			n
	)

Definition at line 138 of file debug.h.

TRACE_WARNING

#define TRACE_WARNING

(

...

)

TRACE_PRINTF(__VA_ARGS__)

Definition at line 97 of file debug.h.

TRACE_WARNING_ARRAY

#define TRACE_WARNING_ARRAY	(		p,
			a,
			n
	)		TRACE_ARRAY(p, a, n)

Definition at line 98 of file debug.h.

TRACE_WARNING_MPI

#define TRACE_WARNING_MPI	(		p,
			a
	)		TRACE_MPI(p, a)

Definition at line 99 of file debug.h.

YES_STRING

#define YES_STRING   "YES"

Definition at line 35 of file debug.h.

Function Documentation

init_debug()

void init_debug

(

uint32_t

baudrate

)

init serial monitor

Parameters

baudrate

speed monitor

Definition at line 57 of file debug.cpp.

print_debug()

void print_debug	(	const char *	fmt,
			...
	)

Print debug from ram.

Parameters

fmt	pointer to class FlashStringHelper

Definition at line 66 of file debug.cpp.

print_debug_array()

void print_debug_array	(	const char *	prepend,
		const void *	data,
		size_t	length
	)

Display the contents of an array.

Parameters

prepend	String to prepend to the left of each line
data	Pointer to the data array
length	Number of bytes to display

Definition at line 81 of file debug.cpp.