IIT-SAE-ECU/_log_8h_source.html

#ifndef __ECU_LOGGING_H__

#define __ECU_LOGGING_H__


#define _LogPrebuildString(x) x


#include <stdint.h>

#include <stdlib.h>


#include "LogConfig.def"


#if CONF_LOGGING_ASCII_DEBUG

#include "core_pins.h"

#include "usb_serial.h"

#endif


// IMPROVE: Add option to log to an sd card instead/as well


#if CONF_LOGGING_MAPPED_MODE > 0

typedef const uint16_t LOG_TAG;

typedef const uint32_t LOG_MSG;


#else

typedef const char *LOG_TAG;

typedef const char *LOG_MSG;


#endif


uint32_t TAG2NUM(LOG_TAG tagValue);


namespace Logging {


struct Log_t {

    void operator()(LOG_TAG TAG, LOG_MSG message);

    void d(LOG_TAG TAG, LOG_MSG message);

    void i(LOG_TAG TAG, LOG_MSG message);

    void w(LOG_TAG TAG, LOG_MSG message);

    void e(LOG_TAG TAG, LOG_MSG message);

    void f(LOG_TAG TAG, LOG_MSG message);

    void operator()(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate = false);

    void d(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate = false);

    void i(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate = false);

    void w(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate = false);

    void e(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate = false);

    void f(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate = false);

    void p(LOG_TAG name, LOG_MSG prettyName, const uint32_t number, int mediate = false);

};


void enableCanbusRelay();


void printLookup();


} // namespace Logging


extern Logging::Log_t Log;


#endif // __ECU_LOGGING_H__

TAG2NUM
uint32_t TAG2NUM(LOG_TAG tagValue)
Return the final numbervalue of a LOG_TAG.

LOG_MSG
const char * LOG_MSG
Type definition for logging messages, only used internally.
Definition Log.h:52

LOG_TAG
const char * LOG_TAG
Type definition of logging tags This typedef is necessary to allow for easier manipulation of code by...
Definition Log.h:48

Log
Logging::Log_t Log
The global logging object.

LogConfig.def
Configuration file for the Log Module.

Logging
Namespace to isolate Log_t struct.
Definition Log.h:69

Logging::enableCanbusRelay
void enableCanbusRelay()
If a set address is received through canbus, the data will be pushed to a buffer to be printed.

Logging::printLookup
void printLookup()
Print the ZLib compressed string of the current lookup table to serial.

Logging::Log_t
Base class used to log things over serial.
Definition Log.h:157

Logging::Log_t::operator()
void operator()(LOG_TAG TAG, LOG_MSG message)
Log a string usb serial.

Logging::Log_t::operator()
void operator()(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate=false)
Log a string and a variable number to usb serial.

Logging::Log_t::d
void d(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate=false)
Log a string and a variable number using a debug tag.

Logging::Log_t::d
void d(LOG_TAG TAG, LOG_MSG message)
Log a string using a debug tag.

Logging::Log_t::w
void w(LOG_TAG TAG, LOG_MSG message)
Log a string using a warning tag.

Logging::Log_t::e
void e(LOG_TAG TAG, LOG_MSG message)
Log a string using an error tag.

Logging::Log_t::i
void i(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate=false)
Log a string and a variable number using an info tag.

Logging::Log_t::f
void f(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate=false)
Log a string and a variable number using a fatal tag.

Logging::Log_t::i
void i(LOG_TAG TAG, LOG_MSG message)
Log a string using an info tag.

Logging::Log_t::e
void e(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate=false)
Log a string and a variable number using an error tag.

Logging::Log_t::w
void w(LOG_TAG TAG, LOG_MSG message, const uint32_t number, int mediate=false)
Log a string and a variable number using a warning tag.

Logging::Log_t::p
void p(LOG_TAG name, LOG_MSG prettyName, const uint32_t number, int mediate=false)
Post a monitored value.

Logging::Log_t::f
void f(LOG_TAG TAG, LOG_MSG message)
Log a string using a fatal tag.