jblogger.h

Go to the documentation of this file.

 
#ifndef JBLOGGER_H
#define JBLOGGER_H
 
#define ENABLE_STD_STRING           
 
#include <Arduino.h>
#include <stdarg.h>
#ifdef ENABLE_STD_STRING
#include <string>
#endif
 
#ifdef __AVR__
#include <avr/pgmspace.h>
#endif
 
#define JBLOGGER_VERSION "1.0.5"    
#define MAX_MESSAGE_LENGTH 128      
 
enum LogLevel {
    LOG_LEVEL_NONE = 0,             
    LOG_LEVEL_ERROR,                
    LOG_LEVEL_WARNING,              
    LOG_LEVEL_INFO,                 
    LOG_LEVEL_DEBUG,                
    LOG_LEVEL_TRACE                 
};
 
class JBLogger {
public:
    JBLogger(const char *moduleName, LogLevel level = LogLevel::LOG_LEVEL_WARNING,
             Stream &stream = Serial, bool showLogLevel = true,
             bool showModuleName = true, bool showTimestamp = true);
 
    void log(LogLevel logLevel, bool writePrefix, bool writeLinefeed, const char *message, ...);
 
#ifdef ENABLE_STD_STRING
    void log(LogLevel logLevel, bool writePrefix, bool writeLinefeed, std::string& message, ...);
#endif
#ifdef ARDUINO
    void log(LogLevel logLevel, bool writePrefix, bool writeLinefeed, String& message, ...);
 
    void log(LogLevel logLevel, bool writePrefix, bool writeLinefeed, const __FlashStringHelper* message, ...);
#endif
 
    template<class T, typename... Args>
    void error(T message, Args... args) {
        log(LogLevel::LOG_LEVEL_ERROR, false, true, message, args...);
    }
 
    template<class T, typename... Args>
    void warning(T message, Args... args) {
        log(LogLevel::LOG_LEVEL_WARNING, false, true, message, args...);
    }
 
    template<class T, typename... Args>
    void info(T message, Args... args) {
        log(LogLevel::LOG_LEVEL_INFO, false, true, message, args...);
    }
 
    template<class T, typename... Args>
    void debug(T message, Args... args) {
        log(LogLevel::LOG_LEVEL_DEBUG, false, true, message, args...);
    }
 
    template<class T, typename... Args>
    void trace(T message, Args... args) {
        log(LogLevel::LOG_LEVEL_TRACE, false, true, message, args...);
    }
 
    void traceDump(const void* buffer, uint32_t size);
 
    void traceHexDump(const void* buffer, uint32_t size);
 
    void traceAsciiDump(const void* buffer, uint32_t size);
 
    void traceBinaryDump(const void* buffer, uint32_t size);
 
    void setOutput(Stream &stream);
 
    Stream& getOutput();
 
    void setLogLevel(LogLevel level);
 
    LogLevel getLogLevel();
 
    void setShowLogLevel(bool value);
 
    bool getShowLogLevel() const;
 
    void setShowModuleName(bool value);
 
    bool getShowModuleName() const;
 
    void setShowTimestamp(bool value);
 
    bool getShowTimestamp() const;
 
private:
    LogLevel _logLevel;                         
    Stream &_output;                            
    const char *_moduleName;                    
    bool _showLogLevel = true;                  
    bool _showModuleName = true;                
    bool _showTimestamp = true;                 
 
    void _printPrefix(LogLevel logLevel) const;
};
 
#endif // JBLOGGER_H