microrlShell.h File Reference

Simple CLI shell header. More...

#include "ch.h"
#include "hal.h"

Include dependency graph for microrlShell.h:

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

Go to the source code of this file.

Data Structures
struct	ShellCommand
	Custom command entry type. More...
struct	ShellConfig
	Shell descriptor type. More...

Macros
#define	SHELL_DYNAMIC_ENTRIES_NUMBER   0U
#define	shellCreate(C, S, P)   shellCreateFromHeap(C, S, P)

Typedefs
typedef void()	shellcmd_f(BaseSequentialStream *chp, int argc, const char *const argv[])
	Command handler function type.

Functions
void	shellInit (void)
	Shell manager initialization.
thread_t *	shellCreateStatic (const ShellConfig *scp, void *wsp, size_t size, tprio_t prio)
	Spawns a new shell.
bool	shellGetLine (BaseSequentialStream *chp, char *line, unsigned size)
void	modeAlternate (void(*funcp)(uint8_t c, uint32_t mode), uint32_t mode)
void	modeShell (void)

Variables
event_source_t	shell_terminated
	Shell termination event source.

Detailed Description

Simple CLI shell header.

Definition in file microrlShell.h.