Arduino DEBUGF()

Debugging

Writing embedded code with Arduino could be easier with a full setup emulator.. but you probably don't have it, don't want to spend it, cant connect it.

So you are stuck to the Serial.print() debugging method like 99% of us is using. This library makes live easier: DEBUGF() compiler #define replaces your method, supports C-style printf() function and can be code-removed in one single line-edit. On top, it comes with memory-debugging viewer: hex-code/ascii code style memory dump of the variables you trace or the data-buffer you like to check.

Serial.begin(115200);
delay(2000);
Serial.print("Starting Debug example\n");
DEBUGF("This is debug text, void-able by undefining \"#define DEBUGF_\"  to 0 - see library \n");
DEBUGF("Printf style : Printing variables with ie %%0.3f in text function: Float on 3 decimals, temperature*100 =  %0.3f\n\n",temperature*100);
DEBUGF("Displaying Data in PROG memory : const char string[%s] in memory :",textexample1);
DEBUGBUFFER_8H((uint8_t*) textexample1,32,8 );
DEBUGF("Displaying data in RAM memory : ie this char string[%s] in memory :",textexample2);
DEBUGBUFFER_8H((uint8_t*) textexample2,32,8 );
delay(2000);

Additional, you can change the serial-out method, so if you like to use another serial port, its easy to setup.

Memory dump

The DEBUGBUFFER() function dumps the memory serial, including hex-style, bin-style or Character-style. its possible to view in 8-16 or 32 bit mode.

[08060540] 54_68_69_73_20_23_31_20_[This #1 ]
[08060548] 61_20_64_65_62_75_67_66_[a debugf]
[08060550] 2d_65_78_61_6d_70_6c_65_[-example]
[08060558] 20_66_6f_72_20_61_20_63_[ for a c]

Inline removal

The function are compiler #define inline commands, and can be removed from your compiled code by changing one #define variable

Serial port

Last but not least, in case you use a different serial port that the standard USB, its possible to change the Serial out in the DEBUGF.h file. Simple and clean :)

update : added DEBUGFinit() tot initialize the Serial port in your code