ESPHome 2026.1.0-dev
Loading...
Searching...
No Matches
log.h
Go to the documentation of this file.
1#pragma once
2
3#include "log_const_en.h"
4
5#include <cassert>
6#include <cstdarg>
7// for PRIu32 and friends
8#include <cinttypes>
9#include <string>
10
11#ifdef USE_STORE_LOG_STR_IN_FLASH
12#include "WString.h"
13#include "esphome/core/defines.h" // for USE_ARDUINO_VERSION_CODE
14#endif
15
16// Include ESP-IDF/Arduino based logging methods here so they don't undefine ours later
17#if defined(USE_ESP32)
18#include <esp_err.h>
19#include <esp_log.h>
20#endif
21#ifdef USE_LIBRETINY
22#include <lt_logger.h>
23#endif
24
25namespace esphome {
26
27#define ESPHOME_LOG_LEVEL_NONE 0
28#define ESPHOME_LOG_LEVEL_ERROR 1
29#define ESPHOME_LOG_LEVEL_WARN 2
30#define ESPHOME_LOG_LEVEL_INFO 3
31#define ESPHOME_LOG_LEVEL_CONFIG 4
32#define ESPHOME_LOG_LEVEL_DEBUG 5
33#define ESPHOME_LOG_LEVEL_VERBOSE 6
34#define ESPHOME_LOG_LEVEL_VERY_VERBOSE 7
35
36#ifndef ESPHOME_LOG_LEVEL
37#define ESPHOME_LOG_LEVEL ESPHOME_LOG_LEVEL_NONE
38#endif
39
40#define ESPHOME_LOG_COLOR_BLACK "30"
41#define ESPHOME_LOG_COLOR_RED "31" // ERROR
42#define ESPHOME_LOG_COLOR_GREEN "32" // INFO
43#define ESPHOME_LOG_COLOR_YELLOW "33" // WARNING
44#define ESPHOME_LOG_COLOR_BLUE "34"
45#define ESPHOME_LOG_COLOR_MAGENTA "35" // CONFIG
46#define ESPHOME_LOG_COLOR_CYAN "36" // DEBUG
47#define ESPHOME_LOG_COLOR_GRAY "37" // VERBOSE
48#define ESPHOME_LOG_COLOR_WHITE "38"
49#define ESPHOME_LOG_SECRET_BEGIN "\033[5m"
50#define ESPHOME_LOG_SECRET_END "\033[6m"
51#define LOG_SECRET(x) ESPHOME_LOG_SECRET_BEGIN x ESPHOME_LOG_SECRET_END
52
53#define ESPHOME_LOG_COLOR(COLOR) "\033[0;" COLOR "m"
54#define ESPHOME_LOG_BOLD(COLOR) "\033[1;" COLOR "m"
55#define ESPHOME_LOG_RESET_COLOR "\033[0m"
56
57void esp_log_printf_(int level, const char *tag, int line, const char *format, ...) // NOLINT
58 __attribute__((format(printf, 4, 5)));
59#ifdef USE_STORE_LOG_STR_IN_FLASH
60void esp_log_printf_(int level, const char *tag, int line, const __FlashStringHelper *format, ...);
61#endif
62void esp_log_vprintf_(int level, const char *tag, int line, const char *format, va_list args); // NOLINT
63#ifdef USE_STORE_LOG_STR_IN_FLASH
64void esp_log_vprintf_(int level, const char *tag, int line, const __FlashStringHelper *format, va_list args);
65#endif
66#if defined(USE_ESP32)
67int esp_idf_log_vprintf_(const char *format, va_list args); // NOLINT
68#endif
69
70#ifdef USE_STORE_LOG_STR_IN_FLASH
71#define ESPHOME_LOG_FORMAT(format) F(format)
72#else
73#define ESPHOME_LOG_FORMAT(format) format
74#endif
75
76#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERY_VERBOSE
77#define esph_log_vv(tag, format, ...) \
78 ::esphome::esp_log_printf_(ESPHOME_LOG_LEVEL_VERY_VERBOSE, tag, __LINE__, ESPHOME_LOG_FORMAT(format), ##__VA_ARGS__)
79
80#define ESPHOME_LOG_HAS_VERY_VERBOSE
81#else
82#define esph_log_vv(tag, format, ...)
83#endif
84
85#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
86#define esph_log_v(tag, format, ...) \
87 ::esphome::esp_log_printf_(ESPHOME_LOG_LEVEL_VERBOSE, tag, __LINE__, ESPHOME_LOG_FORMAT(format), ##__VA_ARGS__)
88
89#define ESPHOME_LOG_HAS_VERBOSE
90#else
91#define esph_log_v(tag, format, ...)
92#endif
93
94#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_DEBUG
95#define esph_log_d(tag, format, ...) \
96 ::esphome::esp_log_printf_(ESPHOME_LOG_LEVEL_DEBUG, tag, __LINE__, ESPHOME_LOG_FORMAT(format), ##__VA_ARGS__)
97#define esph_log_config(tag, format, ...) \
98 ::esphome::esp_log_printf_(ESPHOME_LOG_LEVEL_CONFIG, tag, __LINE__, ESPHOME_LOG_FORMAT(format), ##__VA_ARGS__)
99
100#define ESPHOME_LOG_HAS_DEBUG
101#define ESPHOME_LOG_HAS_CONFIG
102#else
103#define esph_log_d(tag, format, ...)
104#define esph_log_config(tag, format, ...)
105#endif
106
107#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_INFO
108#define esph_log_i(tag, format, ...) \
109 ::esphome::esp_log_printf_(ESPHOME_LOG_LEVEL_INFO, tag, __LINE__, ESPHOME_LOG_FORMAT(format), ##__VA_ARGS__)
110
111#define ESPHOME_LOG_HAS_INFO
112#else
113#define esph_log_i(tag, format, ...)
114#endif
115
116#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_WARN
117#define esph_log_w(tag, format, ...) \
118 ::esphome::esp_log_printf_(ESPHOME_LOG_LEVEL_WARN, tag, __LINE__, ESPHOME_LOG_FORMAT(format), ##__VA_ARGS__)
119
120#define ESPHOME_LOG_HAS_WARN
121#else
122#define esph_log_w(tag, format, ...)
123#endif
124
125#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_ERROR
126#define esph_log_e(tag, format, ...) \
127 ::esphome::esp_log_printf_(ESPHOME_LOG_LEVEL_ERROR, tag, __LINE__, ESPHOME_LOG_FORMAT(format), ##__VA_ARGS__)
128
129#define ESPHOME_LOG_HAS_ERROR
130#else
131#define esph_log_e(tag, format, ...)
132#endif
133
134#ifdef ESP_LOGE
135#undef ESP_LOGE
136#endif
137#ifdef ESP_LOGW
138#undef ESP_LOGW
139#endif
140#ifdef ESP_LOGI
141#undef ESP_LOGI
142#endif
143#ifdef ESP_LOGD
144#undef ESP_LOGD
145#endif
146#ifdef ESP_LOGV
147#undef ESP_LOGV
148#endif
149
150#define ESP_LOGE(tag, ...) esph_log_e(tag, __VA_ARGS__)
151#define ESP_LOGW(tag, ...) esph_log_w(tag, __VA_ARGS__)
152#define ESP_LOGI(tag, ...) esph_log_i(tag, __VA_ARGS__)
153#define ESP_LOGD(tag, ...) esph_log_d(tag, __VA_ARGS__)
154#define ESP_LOGCONFIG(tag, ...) esph_log_config(tag, __VA_ARGS__)
155#define ESP_LOGV(tag, ...) esph_log_v(tag, __VA_ARGS__)
156#define ESP_LOGVV(tag, ...) esph_log_vv(tag, __VA_ARGS__)
157
158#define BYTE_TO_BINARY_PATTERN "%c%c%c%c%c%c%c%c"
159#define BYTE_TO_BINARY(byte) \
160 ((byte) &0x80 ? '1' : '0'), ((byte) &0x40 ? '1' : '0'), ((byte) &0x20 ? '1' : '0'), ((byte) &0x10 ? '1' : '0'), \
161 ((byte) &0x08 ? '1' : '0'), ((byte) &0x04 ? '1' : '0'), ((byte) &0x02 ? '1' : '0'), ((byte) &0x01 ? '1' : '0')
162#define YESNO(b) ((b) ? "YES" : "NO")
163#define ONOFF(b) ((b) ? "ON" : "OFF")
164#define TRUEFALSE(b) ((b) ? "TRUE" : "FALSE")
165// for use with optional values
166#define ONOFFMAYBE(b) (((b).has_value()) ? ONOFF((b).value()) : "UNKNOWN")
167
168// Helper class that identifies strings that may be stored in flash storage (similar to Arduino's __FlashStringHelper)
169struct LogString;
170
171#ifdef USE_STORE_LOG_STR_IN_FLASH
172
173#include <pgmspace.h>
174
175#if USE_ARDUINO_VERSION_CODE >= VERSION_CODE(2, 5, 0)
176#define LOG_STR_ARG(s) ((PGM_P) (s))
177#else
178// Pre-Arduino 2.5, we can't pass a PSTR() to printf(). Emulate support by copying the message to a
179// local buffer first. String length is limited to 63 characters.
180// https://github.com/esp8266/Arduino/commit/6280e98b0360f85fdac2b8f10707fffb4f6e6e31
181#define LOG_STR_ARG(s) \
182 ({ \
183 char __buf[64]; \
184 __buf[63] = '\0'; \
185 strncpy_P(__buf, (PGM_P) (s), 63); \
186 __buf; \
187 })
188#endif
189
190#define LOG_STR(s) (reinterpret_cast<const LogString *>(PSTR(s)))
191#define LOG_STR_LITERAL(s) LOG_STR_ARG(LOG_STR(s))
192
193#else // !USE_STORE_LOG_STR_IN_FLASH
194
195#define LOG_STR(s) (reinterpret_cast<const LogString *>(s))
196#define LOG_STR_ARG(s) (reinterpret_cast<const char *>(s))
197#define LOG_STR_LITERAL(s) (s)
198
199#endif
200
201} // namespace esphome
__attribute__
struct @65::@66 __attribute__
log_const_en.h
esphome
Providing packet encoding functions for exchanging data with a remote host.
Definition a01nyub.cpp:7
esphome::esp_idf_log_vprintf_
int HOT esp_idf_log_vprintf_(const char *format, va_list args)
Definition log.cpp:50
esphome::esp_log_printf_
void HOT esp_log_printf_(int level, const char *tag, int line, const char *format,...)
Definition log.cpp:11
esphome::esp_log_vprintf_
void HOT esp_log_vprintf_(int level, const char *tag, int line, const char *format, va_list args)
Definition log.cpp:26
Generated by doxygen 1.12.0