KM3NeT CLB  2.0
KM3NeT CLB v2 Embedded Software
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
shell.h File Reference

The shell is a ASCII command interpreter and effort has been made to simplify creation of additional shell commands. More...

Go to the source code of this file.

Functions

int _shellChar ()
 Stub function. More...
 
void shellSetPrompt (const char *newPrompt)
 Sets the prompt for the shell. More...
 
void shellDo ()
 Checks if there is any ASCII characters of the UART, and execute any commands issued. More...
 

Detailed Description

The shell is a ASCII command interpreter and effort has been made to simplify creation of additional shell commands.

See the tutorial Adding your own shell commands.

Definition in file shell.h.

Function Documentation

int _shellChar ( )

Stub function.

Implemented by application.

Polls the UART for characters. Should not block. Return -1 if there is no character.

Definition at line 174 of file sys.c.

void shellDo ( )

Checks if there is any ASCII characters of the UART, and execute any commands issued.

This function will exit, once done. Call repeatedly from the main-loop.

Definition at line 159 of file shell.c.

void shellSetPrompt ( const char *  newPrompt)

Sets the prompt for the shell.

Default this is ~>.

Parameters
newPromptA char pointer to the new prompt, or null to reset to the default.

Definition at line 85 of file shell.c.