IoAbstraction
Classes | Enumerations | Functions | Variables
IoLogging.h File Reference

Some very basic logging utilities for any IoAbstraction user that log to a chosen serial interface. Turned on by un-commenting the define. Should NOT be used in production. More...

Go to the source code of this file.

Classes

class  MBedLogger
 
class  PrintfLogger
 

Enumerations

enum  SerLoggingLevel {
  SER_WARNING = 0x0001 , SER_ERROR = 0x0002 , SER_DEBUG = 0x0004 , SER_TCMENU_INFO = 0x0008 ,
  SER_NETWORK_INFO = 0x0010 , SER_IOA_INFO = 0x0020 , SER_USER_1 = 0x0040 , SER_USER_2 = 0x0080 ,
  SER_USER_3 = 0x0100 , SER_USER_4 = 0x0200 , SER_USER_5 = 0x0400 , SER_USER_6 = 0x0800 ,
  SER_TCMENU_DEBUG = 0x1000 , SER_NETWORK_DEBUG = 0x2000 , SER_IOA_DEBUG = 0x4000 , SER_LOG_EVERYTHING = 0xffff
}
 

Functions

unsigned long millis ()
 
const char * prettyLevel (SerLoggingLevel level)
 
bool serLevelEnabled (SerLoggingLevel level)
 
void serEnableLevel (SerLoggingLevel level, bool active)
 
void serlogHexDump (SerLoggingLevel level, const char *title, const void *data, size_t strlen)
 
void serdebugHexDump (const char *title, const void *data, size_t len)
 
void startTaskManagerLogDelegate ()
 

Variables

unsigned int enabledLevels
 
MBedLogger LoggingPort
 

Detailed Description

Some very basic logging utilities for any IoAbstraction user that log to a chosen serial interface. Turned on by un-commenting the define. Should NOT be used in production.

Some very basic logging utilities for any IoAbstraction user that log to a chosen serial interface. Turned on by un-commenting the define. Should NOT be used in production.

Enumeration Type Documentation

◆ SerLoggingLevel

This enumeration contains all the available logging levels, each logging level is a bit in the structure, and we assume there can be up to 15 levels. With 4 user levels available.

Function Documentation

◆ serLevelEnabled()

bool serLevelEnabled ( SerLoggingLevel  level)
inline

Check if a level is enabled

Parameters
levelthe level to check
Returns
true if enabled, otherwise false

◆ serEnableLevel()

void serEnableLevel ( SerLoggingLevel  level,
bool  active 
)
inline

Turn on or off logging for a particular level

Parameters
levelthe level to turn on or off
activetrue if it is to be turned on, otherwise false

Variable Documentation

◆ enabledLevels

unsigned int enabledLevels
extern

This uint16_t stores the enabled logging levels, don't use directly