Logging API

simple helper macros for user access to logging output via the rf24Logging object. More...

Classes
class	RF24Logging
	This is the end-user's access point into the world of logging messages. More...

Macros
#define	RF24Log_error(vendorId, message, ...)   (rf24Logging.log(RF24LogLevel::ERROR, vendorId, message, ##__VA_ARGS__))
	ouput an ERROR message More...
#define	RF24Log_warn(vendorId, message, ...)   (rf24Logging.log(RF24LogLevel::WARN, vendorId, message, ##__VA_ARGS__))
	output a message to WARN the reader More...
#define	RF24Log_info(vendorId, message, ...)   (rf24Logging.log(RF24LogLevel::INFO, vendorId, message, ##__VA_ARGS__))
	output an INFO message More...
#define	RF24Log_debug(vendorId, message, ...)   (rf24Logging.log(RF24LogLevel::DEBUG, vendorId, message, ##__VA_ARGS__))
	output a message to help developers DEBUG their source code More...
#define	RF24Log_log(logLevel, vendorId, message, ...)   (rf24Logging.log(logLevel, vendorId, message, ##__VA_ARGS__))
	output a log message of any level More...

Variables
RF24Logging	rf24Logging
	the singleton used for all your program's logging purposes. More...

Detailed Description

simple helper macros for user access to logging output via the rf24Logging object.

Macro Definition Documentation

RF24Log_debug

#define RF24Log_debug	(		vendorId,
			message,
			...
	)		(rf24Logging.log(RF24LogLevel::DEBUG, vendorId, message, ##__VA_ARGS__))

output a message to help developers DEBUG their source code

Parameters

vendorId	A scoping identity of the message's origin
message	The message format string. Review the supported format spcifiers.
...	the sequence of variables used to replace the format specifiers in the same order for which they appear in the message

Examples

DualStream.ino, and gettingStarted.ino.

Definition at line 77 of file RF24Logging.h.

RF24Log_error

#define RF24Log_error	(		vendorId,
			message,
			...
	)		(rf24Logging.log(RF24LogLevel::ERROR, vendorId, message, ##__VA_ARGS__))

ouput an ERROR message

Parameters

vendorId	A scoping identity of the message's origin
message	The message format string. Review the supported format spcifiers.
...	the sequence of variables used to replace the format specifiers in the same order for which they appear in the message

Examples

gettingStarted.ino.

Definition at line 50 of file RF24Logging.h.

RF24Log_info

#define RF24Log_info	(		vendorId,
			message,
			...
	)		(rf24Logging.log(RF24LogLevel::INFO, vendorId, message, ##__VA_ARGS__))

output an INFO message

Parameters

vendorId	A scoping identity of the message's origin
message	The message format string. Review the supported format spcifiers.
...	the sequence of variables used to replace the format specifiers in the same order for which they appear in the message

Examples

AllLogLevels.ino, DualStream.ino, and gettingStarted.ino.

Definition at line 68 of file RF24Logging.h.

RF24Log_log

#define RF24Log_log	(		logLevel,
			vendorId,
			message,
			...
	)		(rf24Logging.log(logLevel, vendorId, message, ##__VA_ARGS__))

output a log message of any level

See also

RF24Logging::log()

Parameters

logLevel	the level of the logging message
vendorId	A scoping identity of the message's origin
message	The message format string. Review the supported format spcifiers.
...	the sequence of variables used to replace the format specifiers in the same order for which they appear in the message

Examples

AllLogLevels.ino, DualStream.ino, and gettingStarted.ino.

Definition at line 88 of file RF24Logging.h.

RF24Log_warn

#define RF24Log_warn	(		vendorId,
			message,
			...
	)		(rf24Logging.log(RF24LogLevel::WARN, vendorId, message, ##__VA_ARGS__))

output a message to WARN the reader

Parameters

vendorId	A scoping identity of the message's origin
message	The message format string. Review the supported format spcifiers.
...	the sequence of variables used to replace the format specifiers in the same order for which they appear in the message

Examples

gettingStarted.ino.

Definition at line 59 of file RF24Logging.h.

Variable Documentation

rf24Logging

RF24Logging rf24Logging

extern

the singleton used for all your program's logging purposes.

the singleton used for all your program's logging purposes.

Definition at line 61 of file RF24Logging.cpp.