esphome::logger Namespace Reference

Data Structures
struct	CStrCompare
struct	FlashTag
struct	LogBuffer
struct	LogCallback
	Lightweight callback for receiving log messages without virtual dispatch overhead. More...
class	Logger
	Logger component for all ESPHome logging. More...
class	LoggerLevelListener
	Interface for receiving log level changes without std::function overhead. More...
class	LoggerLevelSelect
class	LoggerMessageTrigger
class	TaskLogBuffer
	Task log buffer for ESP32 platform using FreeRTOS ring buffer. More...

Typedefs
using	FatalErrorEsf = ::arch_esf

Enumerations
enum	UARTSelection : uint8_t {   UART_SELECTION_DEFAULT = 0 , UART_SELECTION_UART0 = 0 , UART_SELECTION_UART0 = 0 , UART_SELECTION_UART1 ,   UART_SELECTION_UART2 , UART_SELECTION_USB_CDC , UART_SELECTION_USB_SERIAL_JTAG , UART_SELECTION_UART0_SWAP }
	Enum for logging UART selection. More...

Functions
	ESPHOME_LOG_TAG (TAG, "logger")
	PROGMEM_STRING_TABLE (LogLevelStrings, "NONE", "ERROR", "WARN", "INFO", "CONFIG", "DEBUG", "VERBOSE", "VERY_VERBOSE")
bool	crash_log_pending ()
	Whether a crash record from before this boot is waiting to be reported.
void	log_crash_to_client ()
	Log the previous crash for a client that just subscribed to the logs.
void	init_uart (uart_port_t uart_num, uint32_t baud_rate, int tx_buffer_size)
	__attribute__ ((section(".noinit"))) struct
void	k_sys_fatal_error_handler (unsigned int reason, const FatalErrorEsf *esf)

Variables
Logger *	global_logger = nullptr
	crash_buf
__thread bool	non_main_task_recursion_guard_

Typedef Documentation

FatalErrorEsf

typedef z_arch_esf_t esphome::logger::FatalErrorEsf = ::arch_esf

Definition at line 22 of file logger_zephyr.cpp.

Enumeration Type Documentation

UARTSelection

enum esphome::logger::UARTSelection : uint8_t

Enum for logging UART selection.

Advanced configuration (pin selection, etc) is not supported.

Enumerator
UART_SELECTION_DEFAULT
UART_SELECTION_UART0
UART_SELECTION_UART0
UART_SELECTION_UART1
UART_SELECTION_UART2
UART_SELECTION_USB_CDC
UART_SELECTION_USB_SERIAL_JTAG
UART_SELECTION_UART0_SWAP

Definition at line 109 of file logger.h.

Function Documentation

__attribute__()

esphome::logger::__attribute__

(

(section(".noinit"))

)

Definition at line 27 of file logger_zephyr.cpp.

crash_log_pending()

bool esphome::logger::crash_log_pending

(

)

Whether a crash record from before this boot is waiting to be reported.

Definition at line 166 of file logger_esp32.cpp.

ESPHOME_LOG_TAG()

esphome::logger::ESPHOME_LOG_TAG	(	TAG	,
		"logger"	)

init_uart()

void esphome::logger::init_uart	(	uart_port_t	uart_num,
		uint32_t	baud_rate,
		int	tx_buffer_size )

Definition at line 76 of file logger_esp32.cpp.

k_sys_fatal_error_handler()

void esphome::logger::k_sys_fatal_error_handler	(	unsigned int	reason,
		const FatalErrorEsf *	esf )

Definition at line 192 of file logger_zephyr.cpp.

log_crash_to_client()

void esphome::logger::log_crash_to_client

(

)

Log the previous crash for a client that just subscribed to the logs.

On the ESP32 the record is kept until a client has seen it, so this call also clears it there.

Definition at line 167 of file logger_esp32.cpp.

PROGMEM_STRING_TABLE()

esphome::logger::PROGMEM_STRING_TABLE	(	LogLevelStrings	,
		"NONE"	,
		"ERROR"	,
		"WARN"	,
		"INFO"	,
		"CONFIG"	,
		"DEBUG"	,
		"VERBOSE"	,
		"VERY_VERBOSE"	)

Variable Documentation

crash_buf

esphome::logger::crash_buf

Definition at line 35 of file logger_zephyr.cpp.

global_logger

Logger * esphome::logger::global_logger = nullptr

Definition at line 276 of file logger.cpp.

non_main_task_recursion_guard_

__thread bool esphome::logger::non_main_task_recursion_guard_

Definition at line 7 of file task_log_buffer_zephyr.cpp.