ESPHome  2024.11.0
Static Public Member Functions
esphome::uart::UARTDebug Class Reference

This class contains some static methods, that can be used to easily create a logging action for the debugger. More...

#include <uart_debugger.h>

Static Public Member Functions

static void log_hex (UARTDirection direction, std::vector< uint8_t > bytes, uint8_t separator)
 Log the bytes as hex values, separated by the provided separator character. More...
 
static void log_string (UARTDirection direction, std::vector< uint8_t > bytes)
 Log the bytes as string values, escaping unprintable characters. More...
 
static void log_int (UARTDirection direction, std::vector< uint8_t > bytes, uint8_t separator)
 Log the bytes as integer values, separated by the provided separator character. More...
 
static void log_binary (UARTDirection direction, std::vector< uint8_t > bytes, uint8_t separator)
 Log the bytes as '<binary> (<hex>)' values, separated by the provided separator. More...
 

Detailed Description

This class contains some static methods, that can be used to easily create a logging action for the debugger.

Definition at line 81 of file uart_debugger.h.

Member Function Documentation

◆ log_binary()

void esphome::uart::UARTDebug::log_binary ( UARTDirection  direction,
std::vector< uint8_t >  bytes,
uint8_t  separator 
)
static

Log the bytes as '<binary> (<hex>)' values, separated by the provided separator.

Definition at line 180 of file uart_debugger.cpp.

◆ log_hex()

void esphome::uart::UARTDebug::log_hex ( UARTDirection  direction,
std::vector< uint8_t >  bytes,
uint8_t  separator 
)
static

Log the bytes as hex values, separated by the provided separator character.

Definition at line 98 of file uart_debugger.cpp.

◆ log_int()

void esphome::uart::UARTDebug::log_int ( UARTDirection  direction,
std::vector< uint8_t >  bytes,
uint8_t  separator 
)
static

Log the bytes as integer values, separated by the provided separator character.

Definition at line 162 of file uart_debugger.cpp.

◆ log_string()

void esphome::uart::UARTDebug::log_string ( UARTDirection  direction,
std::vector< uint8_t >  bytes 
)
static

Log the bytes as string values, escaping unprintable characters.

Definition at line 118 of file uart_debugger.cpp.


The documentation for this class was generated from the following files: