Debug.h

Go to the documentation of this file.

#pragma once
 
#include <Arduino.h>


// #define NO_OUTPUT // Uncomment to disable all output
#ifndef NO_OUTPUT
#define DEBUG_OUTPUT          // Comment out to disable debug output
#define INFO_OUTPUT           // Comment out to disable info output
#define ERROR_OUTPUT          // Comment out to disable error output
#define WARNING_OUTPUT        // Comment out to disable warning output
#define CRITICAL_ERROR_OUTPUT // Comment out to disable critical error output
#define DEV_ERROR_OUTPUT
#define INSTRUCTION_OUTPUT    // Comment out to disable instruction output
#define CHIP_OUTPUT           // Comment out to disable chip output
#define MEASUREMENT_OUTPUT    // Comment out to disable measurement output
#endif

#ifdef DEBUG_SHOW_LOCATION
    #define MACRO_LOCATION ("\n" + String(__FILE__) + ":" + String(__LINE__))
#else
    #define MACRO_LOCATION ""
#endif

#ifdef DEBUG_OUTPUT
#define DEBUG_PRINT(x) Serial.print((String) "DEBUG: " + x + MACRO_LOCATION)
#else
#define DEBUG_PRINT(x)
#endif
 
 

#ifdef DEBUG_OUTPUT
#define DEBUG_PRINTLN(x) Serial.println((String) "DEBUG: " + x + MACRO_LOCATION)
#else
#define DEBUG_PRINTLN(x)
#endif

#ifdef MEASUREMENT_OUTPUT
#define MEASUREMENT_PRINT(x) Serial.print((String) "MEASUREMENT: " + x + MACRO_LOCATION)
#else
#define MEASUREMENT_PRINT(x)
#endif
 
 

#ifdef MEASUREMENT_OUTPUT
#define MEASUREMENT_PRINTLN(x) Serial.println((String) "MEASUREMENT: " + x + MACRO_LOCATION)
#else
#define MEASUREMENT_PRINTLN(x)
#endif

#ifdef INSTRUCTION_OUTPUT
#define INSTRUCTION_PRINT(x) Serial.print((String) "INSTRUCTION: " + x + MACRO_LOCATION)
#else
#define INSTRUCTION_PRINT(x)
#endif

#ifdef INSTRUCTION_OUTPUT
#define INSTRUCTION_PRINTLN(x) Serial.println((String) "INSTRUCTION: " + x + MACRO_LOCATION)
#else
#define INSTRUCTION_PRINTLN(x)
#endif

#ifdef INFO_OUTPUT
#define INFO_PRINT(x) Serial.print((String) "INFO: " + x +  MACRO_LOCATION)
#else
#define INFO_PRINT(x)
#endif

#ifdef INFO_OUTPUT
#define INFO_PRINTLN(x) Serial.println((String) "INFO: " + x +  MACRO_LOCATION)
#else
#define INFO_PRINTLN(x)
#endif

#ifdef ERROR_OUTPUT
#define ERROR_PRINT(x) Serial.print((String) "ERROR: " + x +  MACRO_LOCATION)
#else
#define ERROR_PRINT(x)
#endif

#ifdef ERROR_OUTPUT
#define ERROR_PRINTLN(x) Serial.println((String) "ERROR: " + x +  MACRO_LOCATION)
#else
#define ERROR_PRINTLN(x)
#endif

#ifdef WARNING_OUTPUT
#define WARNING_PRINT(x) Serial.print((String) "WARNING: " + x +  MACRO_LOCATION)
#else
#define WARNING_PRINT(x)
#endif

#ifdef WARNING_OUTPUT
#define WARNING_PRINTLN(x) Serial.println((String) "WARNING: " + x +  MACRO_LOCATION)
#else
#define WARNING_PRINTLN(x)
#endif

#ifdef DEV_ERROR_OUTPUT
#define DEV_ERROR_PRINT(x) Serial.print((String) "DEV_ERROR: " + x +  MACRO_LOCATION)
#else
#define DEV_ERROR_PRINT(x)
#endif

#ifdef DEV_ERROR_OUTPUT
#define DEV_ERROR_PRINTLN(x) Serial.println((String) "DEV_ERROR: " + x +  MACRO_LOCATION)
#else
#define DEV_ERROR_PRINTLN(x)
#endif

#ifdef CHIP_OUTPUT
#define CHIP_PRINT(x) Serial.print((String) "CHIP: " + x +  MACRO_LOCATION)
#else
#define CHIP_PRINT(x)
#endif

#ifdef CHIP_OUTPUT
#define CHIP_PRINTLN(x) Serial.println((String) "CHIP: " + x +  MACRO_LOCATION)
#else
#define CHIP_PRINTLN(x)
#endif

#ifdef CRITICAL_ERROR_OUTPUT
#define CRITICAL_ERROR_PRINT(x)                                            \
    Serial.print((String) "CRITICAL ERROR: " + x +  MACRO_LOCATION); \
    while (true)
#else
#define CRITICAL_ERROR_PRINT(x)
#endif

#ifdef CRITICAL_ERROR_OUTPUT
#define CRITICAL_ERROR_PRINTLN(x)                                            \
    Serial.println((String) "CRITICAL ERROR: " + x +  MACRO_LOCATION); \
    while (true)
#else
#define CRITICAL_ERROR_PRINTLN(x)
#endif

#define NULL_PTR_CHECK(ptr)                                      \
    if (ptr == nullptr) {                                     \
        CRITICAL_ERROR_PRINTLN("Null pointer exception: " + #ptr); \
    }