log_system.c File Reference

Driver file providing logging functionality over USART, to print debug messages and values to a teminal program on your PC. More...

#include <stdbool.h>
#include "usart.h"
#include "log_system.h"

Go to the source code of this file.

Functions
void	print_tag_and_log_level (const char *p_tag, enum eLogLevel level)
void	init_log_system (void)
	Initialisation routine - call this function once at startup before using other functions. More...
void	log_message (const char *p_tag, enum eLogLevel level, const char *msg)
void	log_message_with_dec_val (const char *p_tag, enum eLogLevel level, const char *msg, uint8_t val)
void	log_message_with_16bit_dec_val (const char *p_tag, enum eLogLevel level, const char *msg, uint16_t val)
void	log_message_with_bin_val (const char *p_tag, enum eLogLevel level, const char *msg, uint8_t val)
void	log_message_with_16bit_bin_val (const char *p_tag, enum eLogLevel level, const char *msg, uint16_t val)
void	log_message_with_hex_val (const char *p_tag, enum eLogLevel level, const char *msg, uint8_t val)
void	log_set_output_level (const char *p_tag, enum eLogLevel level)
void	log_global_on (void)
	Turns logging system on globally. More...
void	log_global_off (void)
	Turns logging system off globally. More...

Detailed Description

Driver file providing logging functionality over USART, to print debug messages and values to a teminal program on your PC.

Copyright

Copyright © 2022 by Jason Duffy.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

Jason Duffy

Date

1st March 2022

Definition in file log_system.c.

Function Documentation

print_tag_and_log_level()

void print_tag_and_log_level	(	const char *	p_tag,
		enum eLogLevel	level
	)

Definition at line 151 of file log_system.c.

{
  if (level == NONE)
  {
    break;
  }
  print_string("\n");
  print_string(p_tag);
 
  if (level == INFO)
  {
    print_string(", INFO: ");
  }
 
  else if (level == DEBUG)
  {
    print_string(", DEBUG: ");
  }
 
  else if (level == VERBOSE_DEBUG)
  {
    print_string(", VERBOSE_DEBUG: ");
  }
 
  else if (level == WARNING)
  {
    print_string(", WARNING: ");
  }
 
  else if (level == ERROR)
  {
    print_string(", ERROR: ");
  }
 
  // TODO: Throw exception here to be caught at compile time
  else
  {
    print_string(", INVALID_LOG_LEVEL: ");
  }
}

init_log_system()

void init_log_system

(

void

)

Initialisation routine - call this function once at startup before using other functions.

Log system will then be turned on by default - call log_global_off() if you do not wish it to be.

Definition at line 46 of file log_system.c.

{
  init_usart();
  log_global_on();
  log_message(p_system_tag, INFO, "Log system initialised");
};

log_message()

void log_message	(	const char *	p_tag,
		enum eLogLevel	level,
		const char *	msg
	)

Definition at line 54 of file log_system.c.

{
  print_tag_and_log_level(p_tag, level);
  print_string(msg);
}

log_message_with_dec_val()

void log_message_with_dec_val	(	const char *	p_tag,
		enum eLogLevel	level,
		const char *	msg,
		uint8_t	val
	)

Definition at line 61 of file log_system.c.

{
  print_tag_and_log_level(p_tag, level);
  print_string(msg);
  print_string(" ");
  print_byte(val);
}

log_message_with_16bit_dec_val()

void log_message_with_16bit_dec_val	(	const char *	p_tag,
		enum eLogLevel	level,
		const char *	msg,
		uint16_t	val
	)

Definition at line 74 of file log_system.c.

{
  print_tag_and_log_level(p_tag, level);
  print_string(msg);
  print_string(" ");
  print_word(val);
}

log_message_with_bin_val()

void log_message_with_bin_val	(	const char *	p_tag,
		enum eLogLevel	level,
		const char *	msg,
		uint8_t	val
	)

Definition at line 87 of file log_system.c.

{
  print_tag_and_log_level(p_tag, level);
  print_string(msg);
  print_string(" ");
  print_binary_byte(val);
}

log_message_with_16bit_bin_val()

void log_message_with_16bit_bin_val	(	const char *	p_tag,
		enum eLogLevel	level,
		const char *	msg,
		uint16_t	val
	)

Definition at line 99 of file log_system.c.

{
  print_tag_and_log_level(p_tag, level);
  print_string(msg);
  print_string(" ");
 
  uint8_t msb = (val >> 8);
  uint8_t lsb = val;
  print_binary_byte(msb);
  print_binary_byte(lsb);
}

log_message_with_hex_val()

void log_message_with_hex_val	(	const char *	p_tag,
		enum eLogLevel	level,
		const char *	msg,
		uint8_t	val
	)

Definition at line 115 of file log_system.c.

{
  print_tag_and_log_level(p_tag, level);
  print_string(msg);
  print_string(" ");
  print_hex_byte(val);
}

log_set_output_level()

void log_set_output_level	(	const char *	p_tag,
		enum eLogLevel	level
	)

Definition at line 127 of file log_system.c.

{
 
}

log_global_on()

void log_global_on

(

void

)

Turns logging system on globally.

Definition at line 133 of file log_system.c.

{
  log_system_enabled = true;
}

log_global_off()

void log_global_off

(

void

)

Turns logging system off globally.

Definition at line 139 of file log_system.c.

{
  log_system_enabled = false;
}