console.hpp File Reference

Interactive console REPL and command management. More...

#include <idfxx/cpu>
#include <idfxx/error>
#include <idfxx/gpio>
#include <idfxx/uart>
#include <esp_console.h>
#include <filesystem>
#include <functional>
#include <optional>
#include <string_view>
#include <utility>

Go to the source code of this file.

Classes
struct	idfxx::console::command
	Command descriptor for registration. More...
struct	idfxx::console::config
	Configuration for low-level console initialization. More...
class	idfxx::console::repl
	Interactive REPL (Read-Eval-Print Loop) console. More...
struct	idfxx::console::repl::config
	REPL configuration parameters. More...

Namespaces
namespace	idfxx
namespace	idfxx::console

Typedefs
using	idfxx::console::handler = std::move_only_function< int(int argc, char **argv)>
	Command handler callback type.

Functions
void	idfxx::console::register_command (const command &cmd, handler callback)
	Registers a command with a callback handler.
void	idfxx::console::deregister_command (std::string_view name)
	Deregisters a previously registered command.
void	idfxx::console::register_help_command ()
	Registers the built-in 'help' command.
void	idfxx::console::deregister_help_command ()
	Deregisters the built-in 'help' command.
result< void >	idfxx::console::try_register_command (const command &cmd, handler callback)
	Registers a command with a callback handler.
result< void >	idfxx::console::try_deregister_command (std::string_view name)
	Deregisters a previously registered command.
result< void >	idfxx::console::try_register_help_command ()
	Registers the built-in 'help' command.
result< void >	idfxx::console::try_deregister_help_command ()
	Deregisters the built-in 'help' command.
void	idfxx::console::init (const config &cfg={})
	Initializes the console module.
void	idfxx::console::deinit ()
	Deinitializes the console module.
int	idfxx::console::run (std::string_view cmdline)
	Runs a command line string.
result< void >	idfxx::console::try_init (const config &cfg={})
	Initializes the console module.
result< void >	idfxx::console::try_deinit ()
	Deinitializes the console module.
result< int >	idfxx::console::try_run (std::string_view cmdline)
	Runs a command line string.

Detailed Description

Interactive console REPL and command management.

Definition in file console.hpp.