ESPHome 2025.5.0
Loading...
Searching...
No Matches
logger_esp32.cpp
Go to the documentation of this file.
1#ifdef USE_ESP32
2#include "logger.h"
3
4#if defined(USE_ESP32_FRAMEWORK_ARDUINO) || defined(USE_ESP_IDF)
5#include <esp_log.h>
6#endif // USE_ESP32_FRAMEWORK_ARDUINO || USE_ESP_IDF
7
8#ifdef USE_ESP_IDF
9#include <driver/uart.h>
10
11#ifdef USE_LOGGER_USB_SERIAL_JTAG
12#include <driver/usb_serial_jtag.h>
13#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 0)
14#include <esp_vfs_dev.h>
15#include <esp_vfs_usb_serial_jtag.h>
16#else
17#include <driver/usb_serial_jtag_vfs.h>
18#endif
19#endif
20
21#include "freertos/FreeRTOS.h"
22#include "esp_idf_version.h"
23
24#include <cstdint>
25#include <cstdio>
26#include <fcntl.h>
27
28#endif // USE_ESP_IDF
29
30#include "esphome/core/log.h"
31
32namespace esphome {
33namespace logger {
34
35static const char *const TAG = "logger";
36
37#ifdef USE_ESP_IDF
38
39#ifdef USE_LOGGER_USB_SERIAL_JTAG
40static void init_usb_serial_jtag_() {
41 setvbuf(stdin, NULL, _IONBF, 0); // Disable buffering on stdin
42
43#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 0)
44 // Minicom, screen, idf_monitor send CR when ENTER key is pressed
45 esp_vfs_dev_usb_serial_jtag_set_rx_line_endings(ESP_LINE_ENDINGS_CR);
46 // Move the caret to the beginning of the next line on '\n'
47 esp_vfs_dev_usb_serial_jtag_set_tx_line_endings(ESP_LINE_ENDINGS_CRLF);
48#else
49 // Minicom, screen, idf_monitor send CR when ENTER key is pressed
50 usb_serial_jtag_vfs_set_rx_line_endings(ESP_LINE_ENDINGS_CR);
51 // Move the caret to the beginning of the next line on '\n'
52 usb_serial_jtag_vfs_set_tx_line_endings(ESP_LINE_ENDINGS_CRLF);
53#endif
54
55 // Enable non-blocking mode on stdin and stdout
56 fcntl(fileno(stdout), F_SETFL, 0);
57 fcntl(fileno(stdin), F_SETFL, 0);
58
59 usb_serial_jtag_driver_config_t usb_serial_jtag_config{};
60 usb_serial_jtag_config.rx_buffer_size = 512;
61 usb_serial_jtag_config.tx_buffer_size = 512;
62
63 esp_err_t ret = ESP_OK;
64 // Install USB-SERIAL-JTAG driver for interrupt-driven reads and writes
65 ret = usb_serial_jtag_driver_install(&usb_serial_jtag_config);
66 if (ret != ESP_OK) {
67 return;
68 }
69
70 // Tell vfs to use usb-serial-jtag driver
71#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 0)
72 esp_vfs_usb_serial_jtag_use_driver();
73#else
74 usb_serial_jtag_vfs_use_driver();
75#endif
76}
77#endif
78
79void init_uart(uart_port_t uart_num, uint32_t baud_rate, int tx_buffer_size) {
80 uart_config_t uart_config{};
81 uart_config.baud_rate = (int) baud_rate;
82 uart_config.data_bits = UART_DATA_8_BITS;
83 uart_config.parity = UART_PARITY_DISABLE;
84 uart_config.stop_bits = UART_STOP_BITS_1;
85 uart_config.flow_ctrl = UART_HW_FLOWCTRL_DISABLE;
86#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
87 uart_config.source_clk = UART_SCLK_DEFAULT;
88#endif
89 uart_param_config(uart_num, &uart_config);
90 const int uart_buffer_size = tx_buffer_size;
91 // Install UART driver using an event queue here
92 uart_driver_install(uart_num, uart_buffer_size, uart_buffer_size, 10, nullptr, 0);
93}
94
95#endif // USE_ESP_IDF
96
97void Logger::pre_setup() {
98 if (this->baud_rate_ > 0) {
99#ifdef USE_ARDUINO
100 switch (this->uart_) {
101 case UART_SELECTION_UART0:
102#if ARDUINO_USB_CDC_ON_BOOT
103 this->hw_serial_ = &Serial0;
104 Serial0.begin(this->baud_rate_);
105#else
106 this->hw_serial_ = &Serial;
107 Serial.begin(this->baud_rate_);
108#endif
109 break;
110 case UART_SELECTION_UART1:
111 this->hw_serial_ = &Serial1;
112 Serial1.begin(this->baud_rate_);
113 break;
114#ifdef USE_ESP32_VARIANT_ESP32
115 case UART_SELECTION_UART2:
116 this->hw_serial_ = &Serial2;
117 Serial2.begin(this->baud_rate_);
118 break;
119#endif
120
121#ifdef USE_LOGGER_USB_CDC
122 case UART_SELECTION_USB_CDC:
123 this->hw_serial_ = &Serial;
124#if ARDUINO_USB_CDC_ON_BOOT
125 Serial.setTxTimeoutMs(0); // workaround for 2.0.9 crash when there's no data connection
126#endif
127 Serial.begin(this->baud_rate_);
128 break;
129#endif
130 }
131#endif // USE_ARDUINO
132
133#ifdef USE_ESP_IDF
134 this->uart_num_ = UART_NUM_0;
135 switch (this->uart_) {
136 case UART_SELECTION_UART0:
137 this->uart_num_ = UART_NUM_0;
138 init_uart(this->uart_num_, baud_rate_, tx_buffer_size_);
139 break;
140 case UART_SELECTION_UART1:
141 this->uart_num_ = UART_NUM_1;
142 init_uart(this->uart_num_, baud_rate_, tx_buffer_size_);
143 break;
144#ifdef USE_ESP32_VARIANT_ESP32
145 case UART_SELECTION_UART2:
146 this->uart_num_ = UART_NUM_2;
147 init_uart(this->uart_num_, baud_rate_, tx_buffer_size_);
148 break;
149#endif
150#ifdef USE_LOGGER_USB_CDC
151 case UART_SELECTION_USB_CDC:
152 break;
153#endif
154#ifdef USE_LOGGER_USB_SERIAL_JTAG
155 case UART_SELECTION_USB_SERIAL_JTAG:
156 init_usb_serial_jtag_();
157 break;
158#endif
159 }
160#endif // USE_ESP_IDF
161 }
162
163 global_logger = this;
164#if defined(USE_ESP_IDF) || defined(USE_ESP32_FRAMEWORK_ARDUINO)
165 esp_log_set_vprintf(esp_idf_log_vprintf_);
166 if (ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE) {
167 esp_log_level_set("*", ESP_LOG_VERBOSE);
168 }
169#endif // USE_ESP_IDF || USE_ESP32_FRAMEWORK_ARDUINO
170
171 ESP_LOGI(TAG, "Log initialized");
172}
173
174#ifdef USE_ESP_IDF
175void HOT Logger::write_msg_(const char *msg) {
176 if (
177#if defined(USE_ESP32_VARIANT_ESP32S2)
178 this->uart_ == UART_SELECTION_USB_CDC
179#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32H2)
180 this->uart_ == UART_SELECTION_USB_SERIAL_JTAG
181#elif defined(USE_ESP32_VARIANT_ESP32S3)
182 this->uart_ == UART_SELECTION_USB_CDC || this->uart_ == UART_SELECTION_USB_SERIAL_JTAG
183#else
184 /* DISABLES CODE */ (false) // NOLINT
185#endif
186 ) {
187 puts(msg);
188 } else {
189 uart_write_bytes(this->uart_num_, msg, strlen(msg));
190 uart_write_bytes(this->uart_num_, "\n", 1);
191 }
192}
193#else
194void HOT Logger::write_msg_(const char *msg) { this->hw_serial_->println(msg); }
195#endif
196
197const char *const UART_SELECTIONS[] = {
198 "UART0", "UART1",
199#ifdef USE_ESP32_VARIANT_ESP32
200 "UART2",
201#endif
202#ifdef USE_LOGGER_USB_CDC
203 "USB_CDC",
204#endif
205#ifdef USE_LOGGER_USB_SERIAL_JTAG
206 "USB_SERIAL_JTAG",
207#endif
208};
209
210const char *Logger::get_uart_selection_() { return UART_SELECTIONS[this->uart_]; }
211
212} // namespace logger
213} // namespace esphome
214#endif
esphome::logger::Logger::uart_
UARTSelection uart_
Definition logger.h:231
esphome::logger::Logger::get_uart_selection_
const char * get_uart_selection_()
Definition logger_esp32.cpp:210
esphome::logger::Logger::pre_setup
void pre_setup()
Set up this component.
Definition logger_esp32.cpp:97
esphome::logger::Logger::uart_num_
uart_port_t uart_num_
Definition logger.h:240
esphome::logger::Logger::write_msg_
void write_msg_(const char *msg)
Definition logger_esp32.cpp:175
esphome::logger::UART_SELECTIONS
const char *const UART_SELECTIONS[]
Definition logger_esp32.cpp:197
esphome::logger::UART_SELECTION_UART2
@ UART_SELECTION_UART2
Definition logger.h:73
esphome::logger::UART_SELECTION_USB_SERIAL_JTAG
@ UART_SELECTION_USB_SERIAL_JTAG
Definition logger.h:79
esphome::logger::UART_SELECTION_USB_CDC
@ UART_SELECTION_USB_CDC
Definition logger.h:76
esphome::logger::UART_SELECTION_UART0
@ UART_SELECTION_UART0
Definition logger.h:67
esphome::logger::UART_SELECTION_UART1
@ UART_SELECTION_UART1
Definition logger.h:71
esphome::logger::global_logger
Logger * global_logger
Definition logger.cpp:251
esphome::logger::init_uart
void init_uart(uart_port_t uart_num, uint32_t baud_rate, int tx_buffer_size)
Definition logger_esp32.cpp:79
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
Generated by doxygen 1.12.0