-
Notifications
You must be signed in to change notification settings - Fork 1
/
logger.h
125 lines (107 loc) · 2.63 KB
/
logger.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/**
* @file logger.h
* @author Timarrr (tigrmango@gmail.com)
* @brief Minimal logger implementation
* @version 0.1
* @date 2023-03-31
*
* @copyright Copyright (c) 2023
* @todo Buffer overflow protection, partial messages, connection detection and
* possibly optimisation(?)
*/
#ifndef LOGGER_H
#define LOGGER_H
#include <Arduino.h>
/**
* @brief Decorator for trace() funcctions
*
*/
#define trace_decorator "[T]: "
/**
* @brief Decorator for debug() functions
*
*/
#define debug_decorator "\033[37m[D]: "
/**
* @brief Decorator for info() functions
*
*/
#define info_decorator "\033[36m[I]: "
/**
* @brief Decorator for warn() functions
*
*/
#define warn_decorator "\033[33m[W]: "
/**
* @brief Decorator for error() functions
*
*/
#define error_decorator "\033[31;1m [E]: "
#define clear_formatting "\033[0m"
/**
* @brief Namespace to avoid congestion and separate logger functions
*
*/
namespace Logger {
/**
* @brief Lowest priority output, [T] decorator
*
* @param string Message
*/
void trace(String string, bool decorator = true);
/**
* @brief Lowest priority output, [T] decorator
*
* @param string Message
*/
void trace(const __FlashStringHelper *string, bool decorator = true);
/**
* @brief Second lowest priority output, [D] decorator
*
* @param string Message
*/
void debug(String string, bool decorator = true);
/**
* @brief Second lowest priority output, [D] decorator
*
* @param string Message
*/
void debug(const __FlashStringHelper *string, bool decorator = true);
/**
* @brief Average priority output, [I] decorator
*
* @param string Message
*/
void info(String string, bool decorator = true);
/**
* @brief Average priority output, [I] decorator
*
* @param string Message
*/
void info(const __FlashStringHelper *string, bool decorator = true);
/**
* @brief Second highest priority output, [W] decorator
*
* @param string Message
*/
void warn(String string, bool decorator = true);
/**
* @brief Second highest priority output, [W] decorator
*
* @param string Message
*/
void warn(const __FlashStringHelper *string, bool decorator = true);
/**
* @brief Highest priority output, [E] decorator
*
* @param string Message
*/
void error(String string, bool decorator = true);
/**
* @brief Highest priority output, [E] decorator
*
* @param string Message
*/
void error(const __FlashStringHelper *string, bool decorator = true);
}; // namespace Logger
#endif