7#if defined(USE_ESP32) || defined(USE_HOST)
24#if defined(USE_ESP8266)
25#include <HardwareSerial.h>
28#include <HardwareSerial.h>
34#include <driver/uart.h>
38#include <zephyr/kernel.h>
59 void (*
fn)(
void *, uint8_t,
const char *,
const char *, size_t);
60 void invoke(uint8_t level,
const char *tag,
const char *
message,
size_t message_len)
const {
61 this->
fn(this->instance, level, tag,
message, message_len);
65#ifdef USE_LOGGER_LEVEL_LISTENERS
95 bool operator()(
const char *a,
const char *b)
const {
return strcmp(a, b) < 0; }
102static constexpr size_t THREAD_NAME_BUF_SIZE = 64;
104#if defined(USE_ESP32) || defined(USE_ESP8266) || defined(USE_RP2) || defined(USE_LIBRETINY) || defined(USE_ZEPHYR)
117#if defined(USE_LIBRETINY) || defined(USE_ESP32_VARIANT_ESP32)
120#ifdef USE_LOGGER_USB_CDC
123#ifdef USE_LOGGER_USB_SERIAL_JTAG
152#if defined(USE_ESPHOME_TASK_LOG_BUFFER) || (defined(USE_ZEPHYR) && defined(USE_LOGGER_UART_SELECTION_USB_CDC))
153 void loop()
override;
155#if defined(USE_RP2_CRASH_HANDLER) && defined(USE_LOGGER_UART_SELECTION_USB_CDC)
156 void setup()
override;
161#if defined(USE_ARDUINO) && !defined(USE_ESP32)
171#if defined(USE_ESP32) || defined(USE_ESP8266) || defined(USE_RP2) || defined(USE_LIBRETINY) || defined(USE_ZEPHYR)
179#ifdef USE_LOGGER_RUNTIME_TAG_LEVELS
183#ifdef USE_LOGGER_BOOT_LOG_PER_TAG_LEVELS
200 inline uint8_t
level_for(
const char *tag);
201#ifdef USE_LOG_LISTENERS
203 void add_log_callback(
void *instance,
void (*fn)(
void *, uint8_t,
const char *,
const char *,
size_t)) {
208 void add_log_callback(
void *instance,
void (*fn)(
void *, uint8_t,
const char *,
const char *,
size_t)) {}
211#ifdef USE_LOGGER_LEVEL_LISTENERS
218 void log_vprintf_(uint8_t level,
const char *tag,
int line,
const char *
format, va_list args);
221 void log_vprintf_(uint8_t level,
const char *tag,
int line,
const __FlashStringHelper *
format, va_list args);
239#if defined(USE_ESP32) || defined(USE_HOST) || defined(USE_LIBRETINY) || defined(USE_ZEPHYR)
243 const char *thread_name);
245#if defined(USE_ZEPHYR) && defined(USE_LOGGER_UART_SELECTION_USB_CDC)
249#if defined(USE_HOST) || defined(USE_ZEPHYR)
258 va_list args,
LogBuffer &buf,
const char *thread_name) {
267 const __FlashStringHelper *
format, va_list args,
276#ifdef USE_LOG_LISTENERS
278 cb.invoke(level, tag, buf.
data, buf.
pos);
297 template<
typename FormatType>
299 FormatType
format, va_list args,
const char *thread_name) {
303 if constexpr (std::is_same_v<FormatType, const __FlashStringHelper *>) {
310#ifdef USE_LOGGER_BOOT_LOG_BUFFER
318#ifdef USE_ESPHOME_TASK_LOG_BUFFER
322 const char *thread_name,
const char *text, uint16_t text_length,
326#ifdef USE_LOGGER_BOOT_LOG_BUFFER
338#ifdef USE_LOGGER_BOOT_LOG_BUFFER
346#if defined(USE_ARDUINO) && !defined(USE_ESP32)
349#if defined(USE_ZEPHYR)
351#ifdef USE_BOOTLOADER_ADAFRUIT
356#if defined(USE_ESP32) || defined(USE_LIBRETINY) || defined(USE_ZEPHYR)
375#ifdef USE_LOGGER_BOOT_LOG_PER_TAG_LEVELS
378#ifdef USE_LOGGER_RUNTIME_TAG_LEVELS
381#ifdef USE_LOG_LISTENERS
385#ifdef USE_LOGGER_LEVEL_LISTENERS
389#ifdef USE_LOGGER_BOOT_LOG_BUFFER
395#if defined(USE_ESP32) || defined(USE_ESP8266) || defined(USE_RP2) || defined(USE_ZEPHYR)
401#if defined(USE_ESP32) || defined(USE_HOST) || defined(USE_LIBRETINY) || defined(USE_ZEPHYR)
415#ifdef USE_ESPHOME_TASK_LOG_BUFFER
418#ifdef USE_LOGGER_BOOT_LOG_BUFFER
424#if defined(USE_ESP32) || defined(USE_LIBRETINY)
431#if defined(USE_ESP32)
432 return pcTaskGetName(task);
433#elif defined(USE_LIBRETINY)
434 return pcTaskGetTaskName(task);
441#elif defined(USE_HOST)
444 pthread_t current_thread = pthread_self();
449 if (pthread_getname_np(current_thread, buff.data(), buff.size()) == 0) {
455#elif defined(USE_ZEPHYR)
457 if (current_task ==
nullptr) {
458 current_task = k_current_get();
463 const char *name = k_thread_name_get(current_task);
468 std::snprintf(buff.data(), buff.size(),
"%p", current_task);
475#if defined(USE_ESP32) || defined(USE_HOST)
480 pthread_setspecific(key_,
reinterpret_cast<void *
>(1));
498#elif defined(USE_LIBRETINY) || defined(USE_ZEPHYR)
516#if defined(USE_ESPHOME_TASK_LOG_BUFFER) && !(defined(USE_ZEPHYR) && defined(USE_LOGGER_UART_SELECTION_USB_CDC))
535 [](
void *self, uint8_t level,
const char *tag,
const char *
message,
size_t message_len) {
537 if (level <= trigger->
level_) {
541 ESPHOME_strncpy_P(
trigger->ram_tag_, tag, MAX_TAG_LENGTH);
556#ifdef USE_CRASH_HANDLER
568#if defined(USE_ESP32)
570#elif defined(USE_ESP8266)
572#elif defined(USE_RP2)
574#elif defined(USE_LIBRETINY)
void disable_loop()
Disable this component's loop.
Minimal static vector - saves memory by avoiding std::vector overhead.
void trigger(const Ts &...x) ESPHOME_ALWAYS_INLINE
NonMainTaskRecursionGuard & operator=(const NonMainTaskRecursionGuard &)=delete
~NonMainTaskRecursionGuard()
NonMainTaskRecursionGuard & operator=(NonMainTaskRecursionGuard &&)=delete
NonMainTaskRecursionGuard(const NonMainTaskRecursionGuard &)=delete
NonMainTaskRecursionGuard(pthread_key_t key)
NonMainTaskRecursionGuard(NonMainTaskRecursionGuard &&)=delete
RecursionGuard & operator=(const RecursionGuard &)=delete
RecursionGuard(const RecursionGuard &)=delete
RecursionGuard & operator=(RecursionGuard &&)=delete
RecursionGuard(RecursionGuard &&)=delete
RecursionGuard(bool &flag)
Logger component for all ESPHome logging.
void add_level_listener(LoggerLevelListener *listener)
Register a listener for log level changes.
void HOT notify_listeners_(uint8_t level, const char *tag, const LogBuffer &buf)
char boot_log_buffer_[ESPHOME_LOGGER_BOOT_LOG_BUFFER_SIZE]
void HOT format_log_to_buffer_with_terminator_p_(uint8_t level, const char *tag, int line, const __FlashStringHelper *format, va_list args, LogBuffer &buf)
void write_msg_(const char *msg, uint16_t len)
const char *HOT get_thread_name_()
void dump_config() override
const char * get_thread_name_(TaskHandle_t task)
bool HOT is_non_main_task_recursive_() const
uint32_t get_baud_rate() const
const char *HOT get_thread_name_(std::span< char > buff, k_tid_t current_task=nullptr)
NonMainTaskRecursionGuard make_non_main_task_guard_()
const LogString * get_uart_selection_()
uint8_t level_for(const char *tag)
StaticVector< LogCallback, ESPHOME_LOG_MAX_LISTENERS > log_callbacks_
Stream * get_hw_serial() const
void log_vprintf_(uint8_t level, const char *tag, int line, const char *format, va_list args)
void HOT log_message_to_buffer_and_send_(bool &recursion_guard, uint8_t level, const char *tag, int line, FormatType format, va_list args, const char *thread_name)
void create_pthread_key()
void pre_setup()
Set up this component.
void replay_boot_logs()
Send the lines captured during boot to the listeners and stop capturing; safe to call repeatedly.
char tx_buffer_[ESPHOME_LOGGER_TX_BUFFER_SIZE+1]
void HOT format_buffered_message_and_notify_(uint8_t level, const char *tag, uint16_t line, const char *thread_name, const char *text, uint16_t text_length, LogBuffer &buf)
void write_msg_(const char *msg, uint16_t len)
float get_setup_priority() const override
std::map< const char *, uint8_t, CStrCompare > log_levels_
const char *HOT get_thread_name_(std::span< char > buff)
UARTSelection get_uart() const
Get the UART used by the logger.
std::vector< LoggerLevelListener * > level_listeners_
bool non_main_task_recursion_guard_
void disable_loop_when_buffer_empty_()
void HOT format_log_to_buffer_with_terminator_(uint8_t level, const char *tag, int line, const char *format, va_list args, LogBuffer &buf, const char *thread_name)
pthread_key_t log_recursion_key_
RecursionGuard make_non_main_task_guard_()
void HOT write_log_buffer_to_console_(LogBuffer &buf)
uart_port_t get_uart_num() const
uint8_t boot_level_for_(const char *tag)
void set_log_level(uint8_t level)
Set the default log level for this logger.
void set_baud_rate(uint32_t baud_rate)
Manually set the baud rate for serial, set to 0 to disable.
void set_uart_selection(UARTSelection uart_selection)
void boot_log_capture_(uint8_t level, const char *tag, const LogBuffer &buf)
Copy a formatted line at or above the boot log level (outer ANSI codes stripped) into the boot log bu...
bool global_recursion_guard_
void add_log_callback(void *instance, void(*fn)(void *, uint8_t, const char *, const char *, size_t))
Register a log callback to receive log messages.
bool & main_loop_recursion_guard_()
void set_boot_log_level(const char *tag, uint8_t log_level)
Set the boot log level of the specified tag.
void HOT write_to_console_(LogBuffer &buf)
void log_vprintf_non_main_thread_(uint8_t level, const char *tag, int line, const char *format, va_list args, const char *thread_name)
logger::TaskLogBuffer log_buffer_
uint16_t boot_log_dropped_
bool main_task_recursion_guard_
std::map< const char *, uint8_t, CStrCompare > boot_log_levels_
Logger(uint32_t baud_rate)
Interface for receiving log level changes without std::function overhead.
virtual void on_log_level_change(uint8_t level)=0
char ram_tag_[MAX_TAG_LENGTH+1]
LoggerMessageTrigger(Logger *parent, uint8_t level)
Task log buffer for ESP32 platform using FreeRTOS ring buffer.
const LogString * message
bool crash_log_pending()
Whether a crash record from before this boot is waiting to be reported.
UARTSelection
Enum for logging UART selection.
@ UART_SELECTION_UART0_SWAP
@ UART_SELECTION_USB_SERIAL_JTAG
void log_crash_to_client()
Log the previous crash for a client that just subscribed to the logs.
constexpr float BUS
For communication buses like i2c/spi.
bool operator()(const char *a, const char *b) const
bool operator()(FlashTag t, const char *key) const
bool operator()(const char *key, FlashTag t) const
void HOT format_body_p(PGM_P format, va_list args)
void write_body(const char *text, uint16_t text_length)
void HOT write_header(uint8_t level, const char *tag, int line, const char *thread_name)
void HOT format_body(const char *format, va_list args)
void terminate_with_newline()
Lightweight callback for receiving log messages without virtual dispatch overhead.
void invoke(uint8_t level, const char *tag, const char *message, size_t message_len) const
void(* fn)(void *, uint8_t, const char *, const char *, size_t)