console.h File Reference

Console subsystem public API. More...

#include "stm32f401re_gpio.h"
#include "stm32f401re_usart.h"
#include "err.h"

Include dependency graph for console.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	CONSOLE_HANDLE_ts
	Configuration handle for initializing the console subsystem. More...

Functions
ERR_te	console_init (CONSOLE_HANDLE_ts *console_handle)
	Initializes the console subsystem.
ERR_te	console_run (void)
	Runs the console state machine. Must be called periodically.

Detailed Description

Console subsystem public API.

Author

github.com/Baksi675

This module provides a USART-based interactive console that bridges raw serial input to the command dispatch subsystem (Command Module).

Features include:

• USART peripheral and GPIO initialization for serial reception
• Circular-buffer-backed receive path via an ISR callback
• Console mode toggled by Ctrl+C, with local echo and backspace handling
• Command execution via cmd_execute on carriage return

Typical usage:

• Populate a CONSOLE_HANDLE_ts with the target USART instance, baud rate, and RX GPIO configuration
• Call console_init once at startup
• Call console_run periodically from the main loop or scheduler

Version

0.1

Date

2026-01-23

Copyright

Copyright (c) 2026

Definition in file console.h.