How to easily turn on/off all debug message on Arduino IDE


Arduino IDE is a convenient tool to write your code and upload to microcontrollers. However, it doesn’t come with debugger function, which means the only way to debug our program is through using debug message through standard output, in this case, Serial Monitor.

Debug message is handy and it helps to print out the information the registers holds at a specific time, but once you have done debugging and your program is ready to go, we often have to delete/comment out those debug message code manually, in a big project, this could be problematic as there are just too manny of them.

Today, I am going to show you an easy method to turn on / off debug message with only a few lines of code.


The method here is to use a macro function

Take a look of the following C code,

//#define __DEBUG__

#ifdef __DEBUG__
#define DEBUG(...) printf(__VA_ARGS__)
#define DEBUG(...)

Since all Ameba microcontroller supports printf(), we can re-define printf() to a preprocessor function, in this case, I name it DEBUG(). Whenever you want to print out the debug message, instead of Serial.print() or printf(), you should try using DEBUG() instead, it works just like the previous two, but can be easily enabled or disabled by uncomment //#define __DEBUG__ or just leave the comment syntax there.

Let’s look at an example

Example code 1

This is a simple code that only print out “Debug msg 1” and “Debug msg 2” alternatively with a 1 second delay in between.

Note that the first line of the code is uncommented, and we are seeing the debug messages actually got printed out using the DEBUG() function.

Example code 2

Note that this is the same code except I keep the first line commented out, and as a result, no debug messages got print out at all.

It works! :sunglasses:


All you need to do is to copy the few lines of code from above into the top of your arduino sketch and you may name your custom debug function anything you like and it will work like a charm.

Turn on / off is just to keep / remove the // at the first line, very convenient.

Hope you like this content, stay healthy and happy coding~ :sunglasses: