cdc::ui::Console Class Reference

#include <Console.h>

Static Public Member Functions
static void	init ()
	Initializes console wrapper state.
static void	printf (const char *format,...) __attribute__((format(printf
	Prints formatted text to console.
static void static void	vprintf (const char *format, va_list args)
	Prints formatted text with explicit varargs list.
static void	print (const char *str)
	Prints raw string to console.
static void	putchar (char c)
	Writes a single character to console.
static int	getchar ()
	Reads one character from console input.
static void	flush ()
	Flushes pending console output.
static bool	available ()
	Checks whether console input is available.
static void	showPrompt ()
	Prints standard shell prompt.

Detailed Description

Console I/O Abstraction

Provides printf-style output and character input for serial commands. Works over USB CDC, UART, or BLE UART depending on configuration.

Definition at line 14 of file Console.h.

Member Function Documentation

available()

bool cdc::serial::Console::available ( )

static

Checks whether console input is available.

Check if data is available

Returns

true if at least one character can be read.

Definition at line 90 of file Console.cpp.

flush()

void cdc::serial::Console::flush ( )

static

Flushes pending console output.

Flush output buffer

Returns

void

Definition at line 82 of file Console.cpp.

getchar()

int cdc::serial::Console::getchar ( )

static

Reads one character from console input.

Get character (non-blocking)

Returns

Character or -1 if no input available

Character code or negative value if none available.

Definition at line 74 of file Console.cpp.

init()

void cdc::serial::Console::init ( )

static

Initializes console wrapper state.

Initialize console (USB CDC or UART)

Returns

void

Definition at line 19 of file Console.cpp.

print()

void cdc::serial::Console::print ( const char * str )

static

Prints raw string to console.

Print string without formatting

Parameters

str	Null-terminated text.

Returns

void

Definition at line 56 of file Console.cpp.

printf()

void cdc::serial::Console::printf ( const char * format, ... )

static

Prints formatted text to console.

Print formatted string

Parameters

format

Printf-style format string.

Returns

void

Definition at line 30 of file Console.cpp.

putchar()

void cdc::serial::Console::putchar ( char c )

static

Writes a single character to console.

Print character

Parameters

c	Character to write.

Returns

void

Definition at line 66 of file Console.cpp.

showPrompt()

void cdc::serial::Console::showPrompt ( )

static

Prints standard shell prompt.

Show prompt ("> ")

Returns

void

Definition at line 98 of file Console.cpp.

vprintf()

void cdc::serial::Console::vprintf ( const char * format, va_list args )

static

Prints formatted text with explicit varargs list.

Print formatted string (va_list version)

Parameters

format	Printf-style format string.
args	Variable argument list.

Returns

void

Definition at line 43 of file Console.cpp.

---

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

• components/serial_cmd/include/serial_cmd/Console.h
• components/serial_cmd/src/Console.cpp