ESPHome  2023.11.6
logger.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <cstdarg>
4 #include <vector>
5 #include "esphome/core/automation.h"
6 #include "esphome/core/component.h"
7 #include "esphome/core/defines.h"
8 #include "esphome/core/helpers.h"
9 
10 #ifdef USE_ARDUINO
11 #if defined(USE_ESP8266) || defined(USE_ESP32)
12 #include <HardwareSerial.h>
13 #endif // USE_ESP8266 || USE_ESP32
14 #ifdef USE_RP2040
15 #include <HardwareSerial.h>
16 #include <SerialUSB.h>
17 #endif // USE_RP2040
18 #endif // USE_ARDUINO
19 
20 #ifdef USE_ESP_IDF
21 #include <driver/uart.h>
22 #endif // USE_ESP_IDF
23 
24 namespace esphome {
25 
26 namespace logger {
27 
28 #if defined(USE_ESP32) || defined(USE_ESP8266) || defined(USE_RP2040) || defined(USE_LIBRETINY)
29 
33 enum UARTSelection {
34 #ifdef USE_LIBRETINY
35  UART_SELECTION_DEFAULT = 0,
36  UART_SELECTION_UART0,
37  UART_SELECTION_UART1,
38  UART_SELECTION_UART2,
39 #else
40  UART_SELECTION_UART0 = 0,
41  UART_SELECTION_UART1,
42 #if defined(USE_ESP32)
43 #if !defined(USE_ESP32_VARIANT_ESP32C3) && !defined(USE_ESP32_VARIANT_ESP32C6) && \
44  !defined(USE_ESP32_VARIANT_ESP32S2) && !defined(USE_ESP32_VARIANT_ESP32S3) && !defined(USE_ESP32_VARIANT_ESP32H2)
45  UART_SELECTION_UART2,
46 #endif // !USE_ESP32_VARIANT_ESP32C3 && !USE_ESP32_VARIANT_ESP32C6 && !USE_ESP32_VARIANT_ESP32S2 &&
47  // !USE_ESP32_VARIANT_ESP32S3 && !USE_ESP32_VARIANT_ESP32H2
48 #ifdef USE_ESP_IDF
49 #if defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
50  UART_SELECTION_USB_CDC,
51 #endif // USE_ESP32_VARIANT_ESP32S2 || USE_ESP32_VARIANT_ESP32S3
52 #if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32S3) || \
53  defined(USE_ESP32_VARIANT_ESP32H2)
54  UART_SELECTION_USB_SERIAL_JTAG,
55 #endif // USE_ESP32_VARIANT_ESP32C3 || USE_ESP32_VARIANT_ESP32C6 || USE_ESP32_VARIANT_ESP32S3 ||
56  // USE_ESP32_VARIANT_ESP32H2
57 #endif // USE_ESP_IDF
58 #endif // USE_ESP32
59 #ifdef USE_ESP8266
60  UART_SELECTION_UART0_SWAP,
61 #endif // USE_ESP8266
62 #ifdef USE_RP2040
63  UART_SELECTION_USB_CDC,
64 #endif // USE_RP2040
65 #endif // USE_LIBRETINY
66 };
67 #endif // USE_ESP32 || USE_ESP8266 || USE_RP2040 || USE_LIBRETINY
68 
69 class Logger : public Component {
70  public:
71  explicit Logger(uint32_t baud_rate, size_t tx_buffer_size);
72 
74  void set_baud_rate(uint32_t baud_rate);
75  uint32_t get_baud_rate() const { return baud_rate_; }
76 #ifdef USE_ARDUINO
77  Stream *get_hw_serial() const { return hw_serial_; }
78 #endif
79 #ifdef USE_ESP_IDF
80  uart_port_t get_uart_num() const { return uart_num_; }
81 #endif
82 #if defined(USE_ESP32) || defined(USE_ESP8266) || defined(USE_RP2040) || defined(USE_LIBRETINY)
83  void set_uart_selection(UARTSelection uart_selection) { uart_ = uart_selection; }
85  UARTSelection get_uart() const;
86 #endif
87 
89  void set_log_level(const std::string &tag, int log_level);
90 
91  // ========== INTERNAL METHODS ==========
92  // (In most use cases you won't need these)
94  void pre_setup();
95  void dump_config() override;
96 
97  int level_for(const char *tag);
98 
100  void add_on_log_callback(std::function<void(int, const char *, const char *)> &&callback);
101 
102  float get_setup_priority() const override;
103 
104  void log_vprintf_(int level, const char *tag, int line, const char *format, va_list args); // NOLINT
105 #ifdef USE_STORE_LOG_STR_IN_FLASH
106  void log_vprintf_(int level, const char *tag, int line, const __FlashStringHelper *format, va_list args); // NOLINT
107 #endif
108 
109  protected:
110 #ifdef USE_ESP_IDF
111  void init_uart_();
112 #if defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
113  void init_usb_cdc_();
114 #endif
115 #if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32S3) || \
116  defined(USE_ESP32_VARIANT_ESP32H2)
117  void init_usb_serial_jtag_();
118 #endif
119 #endif
120  void write_header_(int level, const char *tag, int line);
121  void write_footer_();
122  void log_message_(int level, const char *tag, int offset = 0);
123 
124  inline bool is_buffer_full_() const { return this->tx_buffer_at_ >= this->tx_buffer_size_; }
125  inline int buffer_remaining_capacity_() const { return this->tx_buffer_size_ - this->tx_buffer_at_; }
126  inline void reset_buffer_() { this->tx_buffer_at_ = 0; }
127  inline void set_null_terminator_() {
128  // does not increment buffer_at
129  this->tx_buffer_[this->tx_buffer_at_] = '\0';
130  }
131  inline void write_to_buffer_(char value) {
132  if (!this->is_buffer_full_())
133  this->tx_buffer_[this->tx_buffer_at_++] = value;
134  }
135  inline void write_to_buffer_(const char *value, int length) {
136  for (int i = 0; i < length && !this->is_buffer_full_(); i++) {
137  this->tx_buffer_[this->tx_buffer_at_++] = value[i];
138  }
139  }
140  inline void vprintf_to_buffer_(const char *format, va_list args) {
141  if (this->is_buffer_full_())
142  return;
143  int remaining = this->buffer_remaining_capacity_();
144  int ret = vsnprintf(this->tx_buffer_ + this->tx_buffer_at_, remaining, format, args);
145  if (ret < 0) {
146  // Encoding error, do not increment buffer_at
147  return;
148  }
149  if (ret >= remaining) {
150  // output was too long, truncated
151  ret = remaining;
152  }
153  this->tx_buffer_at_ += ret;
154  }
155  inline void printf_to_buffer_(const char *format, ...) {
156  va_list arg;
157  va_start(arg, format);
158  this->vprintf_to_buffer_(format, arg);
159  va_end(arg);
160  }
161 
162  uint32_t baud_rate_;
163  char *tx_buffer_{nullptr};
164  int tx_buffer_at_{0};
165  int tx_buffer_size_{0};
166 #if defined(USE_ESP32) || defined(USE_ESP8266) || defined(USE_RP2040)
167  UARTSelection uart_{UART_SELECTION_UART0};
168 #endif
169 #ifdef USE_LIBRETINY
170  UARTSelection uart_{UART_SELECTION_DEFAULT};
171 #endif
172 #ifdef USE_ARDUINO
173  Stream *hw_serial_{nullptr};
174 #endif
175 #ifdef USE_ESP_IDF
176  uart_port_t uart_num_;
177 #endif
178  struct LogLevelOverride {
179  std::string tag;
180  int level;
181  };
182  std::vector<LogLevelOverride> log_levels_;
183  CallbackManager<void(int, const char *, const char *)> log_callback_{};
185  bool recursion_guard_ = false;
186 };
187 
188 extern Logger *global_logger; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
189 
190 class LoggerMessageTrigger : public Trigger<int, const char *, const char *> {
191  public:
192  explicit LoggerMessageTrigger(Logger *parent, int level) {
193  this->level_ = level;
194  parent->add_on_log_callback([this](int level, const char *tag, const char *message) {
195  if (level <= this->level_) {
196  this->trigger(level, tag, message);
197  }
198  });
199  }
200 
201  protected:
202  int level_;
203 };
204 
205 } // namespace logger
206 
207 } // 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:374
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:383
esphome::logger::UARTSelection
UARTSelection
Enum for logging UART selection.
Definition: logger.h:33
esphome::logger::Logger::set_uart_selection
void set_uart_selection(UARTSelection uart_selection)
Definition: logger.h:83
esphome::logger::Logger::level_for
int level_for(const char *tag)
Definition: logger.cpp:161
esphome::logger::LoggerMessageTrigger::LoggerMessageTrigger
LoggerMessageTrigger(Logger *parent, int level)
Definition: logger.h:192
esphome::logger::Logger::log_vprintf_
void log_vprintf_(int level, const char *tag, int line, const char *format, va_list args)
Definition: logger.cpp:66
esphome::logger::Logger::buffer_remaining_capacity_
int buffer_remaining_capacity_() const
Definition: logger.h:125
esphome::logger::Logger::vprintf_to_buffer_
void vprintf_to_buffer_(const char *format, va_list args)
Definition: logger.h:140
esphome::logger::Logger::dump_config
void dump_config() override
Definition: logger.cpp:415
esphome::logger::Logger::get_setup_priority
float get_setup_priority() const override
Definition: logger.cpp:386
esphome::logger::Logger::Logger
Logger(uint32_t baud_rate, size_t tx_buffer_size)
Definition: logger.cpp:221
esphome::logger::Logger::write_header_
void write_header_(int level, const char *tag, int line)
Definition: logger.cpp:55
esphome::logger::global_logger
Logger * global_logger
Definition: logger.cpp:429
esphome::logger::Logger::write_to_buffer_
void write_to_buffer_(const char *value, int length)
Definition: logger.h:135
esphome::logger::Logger::uart_num_
uart_port_t uart_num_
Definition: logger.h:176
esphome::logger::Logger::get_uart
UARTSelection get_uart() const
Get the UART used by the logger.
Definition: logger.cpp:380
esphome::logger::Logger::set_null_terminator_
void set_null_terminator_()
Definition: logger.h:127
esphome::logger::Logger::printf_to_buffer_
void printf_to_buffer_(const char *format,...)
Definition: logger.h:155
esphome::logger::Logger::write_to_buffer_
void write_to_buffer_(char value)
Definition: logger.h:131
esphome::logger::Logger::uart_
UARTSelection uart_
Definition: logger.h:167
esphome::logger::Logger::pre_setup
void pre_setup()
Set up this component.
Definition: logger.cpp:227
esphome::logger::Logger::get_hw_serial
Stream * get_hw_serial() const
Definition: logger.h:77
esphome::logger::Logger::get_baud_rate
uint32_t get_baud_rate() const
Definition: logger.h:75
length
uint16_t length
Definition: tt21100.cpp:12
esphome::logger::Logger::log_message_
void log_message_(int level, const char *tag, int offset=0)
Definition: logger.cpp:172
esphome::logger::Logger::init_usb_serial_jtag_
void init_usb_serial_jtag_()
Definition: logger.cpp:132
esphome
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
esphome::logger::Logger::log_levels_
std::vector< LogLevelOverride > log_levels_
Definition: logger.h:182
esphome::logger::Logger::get_uart_num
uart_port_t get_uart_num() const
Definition: logger.h:80
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:375
esphome::logger::Logger::recursion_guard_
bool recursion_guard_
Prevents recursive log calls, if true a log message is already being processed.
Definition: logger.h:185
esphome::logger::Logger::log_callback_
CallbackManager< void(int, const char *, const char *)> log_callback_
Definition: logger.h:183
esphome::logger::Logger::is_buffer_full_
bool is_buffer_full_() const
Definition: logger.h:124
Generated by   doxygen 1.8.13