CommandOutput Namespace Reference

Visual output formatting system for UART command interface. More...

Functions
void	PrintSuccess (const char *format,...)
	Print a success message to the ESP-IDF log.
void	PrintError (const char *format,...)
	Print an error message to the ESP-IDF log.
void	PrintInfo (const char *format,...)
	Print an informational message to the ESP-IDF log.
void	PrintWarning (const char *format,...)
	Print a warning message to the ESP-IDF log.
void	PrintHeader (const char *title)
	Print a boxed header line for human-readable UART output.
void	PrintSeparator ()
	Print a boxed separator line for UART output.
void	PrintFooter ()
	Print a boxed footer line for UART output.
void	PrintTableRow (const char *label, const char *value)
	Print a key/value row within the boxed UART output format.
void	PrintEmptyLine ()
	Print an empty boxed line for spacing in UART output.
void	PrintCommandResult (const char *command, bool success, const char *details=nullptr)
	Print a success/failure result line for a command.

Variables
static constexpr int	BOX_WIDTH = 78

Detailed Description

Visual output formatting system for UART command interface.

Provides formatted output functions for the UART command parser, including boxed headers, success/error messages, and table formatting. All output uses ESP-IDF logging macros for consistency.

Function Documentation

PrintCommandResult()

void CommandOutput::PrintCommandResult	(	const char *	command,
		bool	success,
		const char *	details = nullptr )

Print a success/failure result line for a command.

Parameters

command	Command name (displayed).
success	Whether the command succeeded.
details	Optional additional details.

Here is the call graph for this function:

Here is the caller graph for this function:

PrintEmptyLine()

void CommandOutput::PrintEmptyLine

(

)

Print an empty boxed line for spacing in UART output.

Here is the call graph for this function:

Here is the caller graph for this function:

PrintError()

void CommandOutput::PrintError	(	const char *	format,
			... )

Print an error message to the ESP-IDF log.

Parameters

format	printf-style format string.
...	printf-style arguments.

Note

Uses ESP_LOGE and includes an error glyph prefix.

Here is the call graph for this function:

Here is the caller graph for this function:

PrintFooter()

void CommandOutput::PrintFooter

(

)

Print a boxed footer line for UART output.

Here is the call graph for this function:

Here is the caller graph for this function:

PrintHeader()

void CommandOutput::PrintHeader

(

const char *

title

)

Print a boxed header line for human-readable UART output.

Parameters

title

Title to center in the header.

Note

This is presentation-only and does not affect system state.

Here is the call graph for this function:

Here is the caller graph for this function:

PrintInfo()

void CommandOutput::PrintInfo	(	const char *	format,
			... )

Print an informational message to the ESP-IDF log.

Parameters

format	printf-style format string.
...	printf-style arguments.

Note

Uses ESP_LOGI and includes an info glyph prefix.

Here is the call graph for this function:

Here is the caller graph for this function:

PrintSeparator()

void CommandOutput::PrintSeparator

(

)

Print a boxed separator line for UART output.

Here is the call graph for this function:

Here is the caller graph for this function:

PrintSuccess()

void CommandOutput::PrintSuccess	(	const char *	format,
			... )

Print a success message to the ESP-IDF log.

Parameters

format	printf-style format string.
...	printf-style arguments.

Note

Uses ESP_LOGI and includes a success glyph prefix.

Here is the call graph for this function:

Here is the caller graph for this function:

PrintTableRow()

void CommandOutput::PrintTableRow	(	const char *	label,
		const char *	value )

Print a key/value row within the boxed UART output format.

Parameters

label	Left column label.
value	Right column value (will be truncated to fit).

Here is the call graph for this function:

Here is the caller graph for this function:

PrintWarning()

void CommandOutput::PrintWarning	(	const char *	format,
			... )

Print a warning message to the ESP-IDF log.

Parameters

format	printf-style format string.
...	printf-style arguments.

Note

Uses ESP_LOGW and includes a warning glyph prefix.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

BOX_WIDTH

constexpr int CommandOutput::BOX_WIDTH = 78

staticconstexpr