ESPHome  2023.3.2
logger.cpp
Go to the documentation of this file.
1 #include "logger.h"
2 
3 #ifdef USE_ESP_IDF
4 #include <driver/uart.h>
5 #include "freertos/FreeRTOS.h"
6 #endif // USE_ESP_IDF
7 
8 #if defined(USE_ESP32_FRAMEWORK_ARDUINO) || defined(USE_ESP_IDF)
9 #include <esp_log.h>
10 #endif // USE_ESP32_FRAMEWORK_ARDUINO || USE_ESP_IDF
11 #include "esphome/core/hal.h"
12 #include "esphome/core/log.h"
13 
14 namespace esphome {
15 namespace logger {
16 
17 static const char *const TAG = "logger";
18 
19 static const char *const LOG_LEVEL_COLORS[] = {
20  "", // NONE
21  ESPHOME_LOG_BOLD(ESPHOME_LOG_COLOR_RED), // ERROR
22  ESPHOME_LOG_COLOR(ESPHOME_LOG_COLOR_YELLOW), // WARNING
23  ESPHOME_LOG_COLOR(ESPHOME_LOG_COLOR_GREEN), // INFO
24  ESPHOME_LOG_COLOR(ESPHOME_LOG_COLOR_MAGENTA), // CONFIG
25  ESPHOME_LOG_COLOR(ESPHOME_LOG_COLOR_CYAN), // DEBUG
26  ESPHOME_LOG_COLOR(ESPHOME_LOG_COLOR_GRAY), // VERBOSE
27  ESPHOME_LOG_COLOR(ESPHOME_LOG_COLOR_WHITE), // VERY_VERBOSE
28 };
29 static const char *const LOG_LEVEL_LETTERS[] = {
30  "", // NONE
31  "E", // ERROR
32  "W", // WARNING
33  "I", // INFO
34  "C", // CONFIG
35  "D", // DEBUG
36  "V", // VERBOSE
37  "VV", // VERY_VERBOSE
38 };
39 
40 void Logger::write_header_(int level, const char *tag, int line) {
41  if (level < 0)
42  level = 0;
43  if (level > 7)
44  level = 7;
45 
46  const char *color = LOG_LEVEL_COLORS[level];
47  const char *letter = LOG_LEVEL_LETTERS[level];
48  this->printf_to_buffer_("%s[%s][%s:%03u]: ", color, letter, tag, line);
49 }
50 
51 void HOT Logger::log_vprintf_(int level, const char *tag, int line, const char *format, va_list args) { // NOLINT
52  if (level > this->level_for(tag) || recursion_guard_)
53  return;
54 
55  recursion_guard_ = true;
56  this->reset_buffer_();
57  this->write_header_(level, tag, line);
58  this->vprintf_to_buffer_(format, args);
59  this->write_footer_();
60  this->log_message_(level, tag);
61  recursion_guard_ = false;
62 }
63 #ifdef USE_STORE_LOG_STR_IN_FLASH
64 void Logger::log_vprintf_(int level, const char *tag, int line, const __FlashStringHelper *format,
65  va_list args) { // NOLINT
66  if (level > this->level_for(tag) || recursion_guard_)
67  return;
68 
69  recursion_guard_ = true;
70  this->reset_buffer_();
71  // copy format string
72  auto *format_pgm_p = reinterpret_cast<const uint8_t *>(format);
73  size_t len = 0;
74  char ch = '.';
75  while (!this->is_buffer_full_() && ch != '\0') {
76  this->tx_buffer_[this->tx_buffer_at_++] = ch = (char) progmem_read_byte(format_pgm_p++);
77  }
78  // Buffer full form copying format
79  if (this->is_buffer_full_())
80  return;
81 
82  // length of format string, includes null terminator
83  uint32_t offset = this->tx_buffer_at_;
84 
85  // now apply vsnprintf
86  this->write_header_(level, tag, line);
87  this->vprintf_to_buffer_(this->tx_buffer_, args);
88  this->write_footer_();
89  this->log_message_(level, tag, offset);
90  recursion_guard_ = false;
91 }
92 #endif
93 
94 int HOT Logger::level_for(const char *tag) {
95  // Uses std::vector<> for low memory footprint, though the vector
96  // could be sorted to minimize lookup times. This feature isn't used that
97  // much anyway so it doesn't matter too much.
98  for (auto &it : this->log_levels_) {
99  if (it.tag == tag) {
100  return it.level;
101  }
102  }
103  return ESPHOME_LOG_LEVEL;
104 }
105 void HOT Logger::log_message_(int level, const char *tag, int offset) {
106  // remove trailing newline
107  if (this->tx_buffer_[this->tx_buffer_at_ - 1] == '\n') {
108  this->tx_buffer_at_--;
109  }
110  // make sure null terminator is present
111  this->set_null_terminator_();
112 
113  const char *msg = this->tx_buffer_ + offset;
114  if (this->baud_rate_ > 0) {
115 #ifdef USE_ARDUINO
116  this->hw_serial_->println(msg);
117 #endif // USE_ARDUINO
118 #ifdef USE_ESP_IDF
119  if (
120 #if defined(USE_ESP32_VARIANT_ESP32S2)
121  uart_ == UART_SELECTION_USB_CDC
122 #elif defined(USE_ESP32_VARIANT_ESP32C3)
123  uart_ == UART_SELECTION_USB_SERIAL_JTAG
124 #elif defined(USE_ESP32_VARIANT_ESP32S3)
125  uart_ == UART_SELECTION_USB_CDC || uart_ == UART_SELECTION_USB_SERIAL_JTAG
126 #else
127  /* DISABLES CODE */ (false)
128 #endif
129  ) {
130  puts(msg);
131  } else {
132  uart_write_bytes(uart_num_, msg, strlen(msg));
133  uart_write_bytes(uart_num_, "\n", 1);
134  }
135 #endif
136  }
137 
138 #ifdef USE_ESP32
139  // Suppress network-logging if memory constrained, but still log to serial
140  // ports. In some configurations (eg BLE enabled) there may be some transient
141  // memory exhaustion, and trying to log when OOM can lead to a crash. Skipping
142  // here usually allows the stack to recover instead.
143  // See issue #1234 for analysis.
144  if (xPortGetFreeHeapSize() < 2048)
145  return;
146 #endif
147 
148  this->log_callback_.call(level, tag, msg);
149 }
150 
151 Logger::Logger(uint32_t baud_rate, size_t tx_buffer_size) : baud_rate_(baud_rate), tx_buffer_size_(tx_buffer_size) {
152  // add 1 to buffer size for null terminator
153  this->tx_buffer_ = new char[this->tx_buffer_size_ + 1]; // NOLINT
154 }
155 
156 void Logger::pre_setup() {
157  if (this->baud_rate_ > 0) {
158 #ifdef USE_ARDUINO
159  switch (this->uart_) {
160  case UART_SELECTION_UART0:
161 #ifdef USE_ESP8266
162  case UART_SELECTION_UART0_SWAP:
163 #endif
164 #ifdef USE_RP2040
165  this->hw_serial_ = &Serial1;
166  Serial1.begin(this->baud_rate_);
167 #else
168  this->hw_serial_ = &Serial;
169  Serial.begin(this->baud_rate_);
170 #endif
171 #ifdef USE_ESP8266
172  if (this->uart_ == UART_SELECTION_UART0_SWAP) {
173  Serial.swap();
174  }
175  Serial.setDebugOutput(ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE);
176 #endif
177  break;
178  case UART_SELECTION_UART1:
179 #ifdef USE_RP2040
180  this->hw_serial_ = &Serial2;
181  Serial2.begin(this->baud_rate_);
182 #else
183  this->hw_serial_ = &Serial1;
184  Serial1.begin(this->baud_rate_);
185 #endif
186 #ifdef USE_ESP8266
187  Serial1.setDebugOutput(ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE);
188 #endif
189  break;
190 #if defined(USE_ESP32) && !defined(USE_ESP32_VARIANT_ESP32C3) && !defined(USE_ESP32_VARIANT_ESP32S2) && \
191  !defined(USE_ESP32_VARIANT_ESP32S3)
192  case UART_SELECTION_UART2:
193  this->hw_serial_ = &Serial2;
194  Serial2.begin(this->baud_rate_);
195  break;
196 #endif
197 #ifdef USE_RP2040
198  case UART_SELECTION_USB_CDC:
199  this->hw_serial_ = &Serial;
200  Serial.begin(this->baud_rate_);
201  break;
202 #endif
203  }
204 #endif // USE_ARDUINO
205 #ifdef USE_ESP_IDF
206  uart_num_ = UART_NUM_0;
207  switch (uart_) {
208  case UART_SELECTION_UART0:
209  uart_num_ = UART_NUM_0;
210  break;
211  case UART_SELECTION_UART1:
212  uart_num_ = UART_NUM_1;
213  break;
214 #if !defined(USE_ESP32_VARIANT_ESP32C3) && !defined(USE_ESP32_VARIANT_ESP32S2) && !defined(USE_ESP32_VARIANT_ESP32S3)
215  case UART_SELECTION_UART2:
216  uart_num_ = UART_NUM_2;
217  break;
218 #endif // !USE_ESP32_VARIANT_ESP32C3 && !USE_ESP32_VARIANT_ESP32S2 && !USE_ESP32_VARIANT_ESP32S3
219 #if defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
220  case UART_SELECTION_USB_CDC:
221  uart_num_ = -1;
222  break;
223 #endif // USE_ESP32_VARIANT_ESP32S2 || USE_ESP32_VARIANT_ESP32S3
224 #if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S3)
225  case UART_SELECTION_USB_SERIAL_JTAG:
226  uart_num_ = -1;
227  break;
228 #endif // USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32S3
229  }
230  if (uart_num_ >= 0) {
231  uart_config_t uart_config{};
232  uart_config.baud_rate = (int) baud_rate_;
233  uart_config.data_bits = UART_DATA_8_BITS;
234  uart_config.parity = UART_PARITY_DISABLE;
235  uart_config.stop_bits = UART_STOP_BITS_1;
236  uart_config.flow_ctrl = UART_HW_FLOWCTRL_DISABLE;
237  uart_param_config(uart_num_, &uart_config);
238  const int uart_buffer_size = tx_buffer_size_;
239  // Install UART driver using an event queue here
240  uart_driver_install(uart_num_, uart_buffer_size, uart_buffer_size, 10, nullptr, 0);
241  }
242 #endif // USE_ESP_IDF
243  }
244 #ifdef USE_ESP8266
245  else {
246  uart_set_debug(UART_NO);
247  }
248 #endif // USE_ESP8266
249 
250  global_logger = this;
251 #if defined(USE_ESP_IDF) || defined(USE_ESP32_FRAMEWORK_ARDUINO)
252  esp_log_set_vprintf(esp_idf_log_vprintf_);
253  if (ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE) {
254  esp_log_level_set("*", ESP_LOG_VERBOSE);
255  }
256 #endif // USE_ESP_IDF || USE_ESP32_FRAMEWORK_ARDUINO
257 
258  ESP_LOGI(TAG, "Log initialized");
259 }
260 void Logger::set_baud_rate(uint32_t baud_rate) { this->baud_rate_ = baud_rate; }
261 void Logger::set_log_level(const std::string &tag, int log_level) {
262  this->log_levels_.push_back(LogLevelOverride{tag, log_level});
263 }
264 UARTSelection Logger::get_uart() const { return this->uart_; }
265 void Logger::add_on_log_callback(std::function<void(int, const char *, const char *)> &&callback) {
266  this->log_callback_.add(std::move(callback));
267 }
268 float Logger::get_setup_priority() const { return setup_priority::BUS + 500.0f; }
269 const char *const LOG_LEVELS[] = {"NONE", "ERROR", "WARN", "INFO", "CONFIG", "DEBUG", "VERBOSE", "VERY_VERBOSE"};
270 #ifdef USE_ESP32
271 const char *const UART_SELECTIONS[] = {
272  "UART0", "UART1",
273 #if !defined(USE_ESP32_VARIANT_ESP32C3) && !defined(USE_ESP32_VARIANT_ESP32S2) && !defined(USE_ESP32_VARIANT_ESP32S3)
274  "UART2",
275 #endif // !USE_ESP32_VARIANT_ESP32C3 && !USE_ESP32_VARIANT_ESP32S2 && !USE_ESP32_VARIANT_ESP32S3
276 #if defined(USE_ESP_IDF)
277 #if defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
278  "USB_CDC",
279 #endif // USE_ESP32_VARIANT_ESP32S2 || USE_ESP32_VARIANT_ESP32S3
280 #if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S3)
281  "USB_SERIAL_JTAG",
282 #endif // USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32S3
283 #endif // USE_ESP_IDF
284 };
285 #endif // USE_ESP32
286 #ifdef USE_ESP8266
287 const char *const UART_SELECTIONS[] = {"UART0", "UART1", "UART0_SWAP"};
288 #endif
289 #ifdef USE_RP2040
290 const char *const UART_SELECTIONS[] = {"UART0", "UART1", "USB_CDC"};
291 #endif // USE_ESP8266
292 void Logger::dump_config() {
293  ESP_LOGCONFIG(TAG, "Logger:");
294  ESP_LOGCONFIG(TAG, " Level: %s", LOG_LEVELS[ESPHOME_LOG_LEVEL]);
295  ESP_LOGCONFIG(TAG, " Log Baud Rate: %u", this->baud_rate_);
296  ESP_LOGCONFIG(TAG, " Hardware UART: %s", UART_SELECTIONS[this->uart_]);
297  for (auto &it : this->log_levels_) {
298  ESP_LOGCONFIG(TAG, " Level for '%s': %s", it.tag.c_str(), LOG_LEVELS[it.level]);
299  }
300 }
301 void Logger::write_footer_() { this->write_to_buffer_(ESPHOME_LOG_RESET_COLOR, strlen(ESPHOME_LOG_RESET_COLOR)); }
302 
303 Logger *global_logger = nullptr; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
304 
305 } // namespace logger
306 } // namespace esphome
esphome::logger::Logger::set_baud_rate
void set_baud_rate(uint32_t baud_rate)
Manually set the baud rate for serial, set to 0 to disable.
Definition: logger.cpp:260
esphome::logger::Logger::add_on_log_callback
void add_on_log_callback(std::function< void(int, const char *, const char *)> &&callback)
Register a callback that will be called for every log message sent.
Definition: logger.cpp:265
esphome::logger::UARTSelection
UARTSelection
Enum for logging UART selection.
Definition: logger.h:32
esphome::logger::Logger::level_for
int level_for(const char *tag)
Definition: logger.cpp:94
esphome::logger::Logger::log_vprintf_
void log_vprintf_(int level, const char *tag, int line, const char *format, va_list args)
Definition: logger.cpp:51
esphome::logger::Logger::vprintf_to_buffer_
void vprintf_to_buffer_(const char *format, va_list args)
Definition: logger.h:116
esphome::logger::Logger::dump_config
void dump_config() override
Definition: logger.cpp:292
esphome::logger::Logger::get_setup_priority
float get_setup_priority() const override
Definition: logger.cpp:268
esphome::logger::Logger::Logger
Logger(uint32_t baud_rate, size_t tx_buffer_size)
Definition: logger.cpp:151
esphome::logger::Logger::write_header_
void write_header_(int level, const char *tag, int line)
Definition: logger.cpp:40
esphome::logger::global_logger
Logger * global_logger
Definition: logger.cpp:303
esphome::logger::Logger::uart_num_
uart_port_t uart_num_
Definition: logger.h:147
esphome::setup_priority::BUS
const float BUS
For communication buses like i2c/spi.
Definition: component.cpp:15
esphome::logger::Logger::get_uart
UARTSelection get_uart() const
Get the UART used by the logger.
Definition: logger.cpp:264
esphome::logger::Logger::set_null_terminator_
void set_null_terminator_()
Definition: logger.h:103
esphome::logger::Logger::printf_to_buffer_
void printf_to_buffer_(const char *format,...)
Definition: logger.h:131
esphome::logger::Logger::write_to_buffer_
void write_to_buffer_(char value)
Definition: logger.h:107
esphome::logger::LOG_LEVELS
const char *const LOG_LEVELS[]
Definition: logger.cpp:269
esphome::logger::Logger::uart_
UARTSelection uart_
Definition: logger.h:142
esphome::logger::Logger::pre_setup
void pre_setup()
Set up this component.
Definition: logger.cpp:156
esphome::progmem_read_byte
uint8_t progmem_read_byte(const uint8_t *addr)
Definition: core.cpp:56
esphome::len
std::string size_t len
Definition: helpers.h:286
esphome::logger::UART_SELECTIONS
const char *const UART_SELECTIONS[]
Definition: logger.cpp:271
esphome::logger::Logger::log_message_
void log_message_(int level, const char *tag, int offset=0)
Definition: logger.cpp:105
esphome
Definition: a4988.cpp:4
esphome::logger::Logger::log_levels_
std::vector< LogLevelOverride > log_levels_
Definition: logger.h:153
esphome::logger::Logger::set_log_level
void set_log_level(const std::string &tag, int log_level)
Set the log level of the specified tag.
Definition: logger.cpp:261
esphome::logger::Logger::recursion_guard_
bool recursion_guard_
Prevents recursive log calls, if true a log message is already being processed.
Definition: logger.h:156
esphome::logger::Logger::log_callback_
CallbackManager< void(int, const char *, const char *)> log_callback_
Definition: logger.h:154
esphome::esp_idf_log_vprintf_
int HOT esp_idf_log_vprintf_(const char *format, va_list args)
Definition: log.cpp:50
esphome::logger::Logger::is_buffer_full_
bool is_buffer_full_() const
Definition: logger.h:100
Generated by   doxygen 1.8.13