shell.h File Reference

Simple CLI shell header. More...

Go to the source code of this file.

Data Structures
struct	ShellCommand
	Custom command entry type. More...
struct	ShellConfig
	Shell descriptor type. More...
Defines
#define	SHELL_MAX_LINE_LENGTH   64
	Shell maximum input line length.
#define	SHELL_MAX_ARGUMENTS   4
	Shell maximum arguments per command.
#define	SHELL_USE_IPRINTF   TRUE
	Enforces the use of iprintf() on newlib.
Typedefs
typedef void(*	shellcmd_t )(BaseChannel *chp, int argc, char *argv[])
	Command handler function type.
Functions
void	shellInit (void)
	Shell manager initialization.
Thread *	shellCreate (const ShellConfig *scp, size_t size, tprio_t prio)
	Spawns a new shell.
void	shellPrint (BaseChannel *chp, const char *msg)
	Prints a string.
void	shellPrintLine (BaseChannel *chp, const char *msg)
	Prints a string with a final newline.
bool_t	shellGetLine (BaseChannel *chp, char *line, unsigned size)
	Reads a whole line from the input channel.
Variables
EventSource	shell_terminated
	Shell termination event source.

---

Detailed Description

Simple CLI shell header.

Definition in file shell.h.