KM3NeT CLB  2.0
KM3NeT CLB v2 Embedded Software
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
shell.h
Go to the documentation of this file.
1 /*
2  * KM3NeT CLB v2 Firmware
3  * ----------------------
4  *
5  * Copyright 2013 KM3NeT Collaboration
6  *
7  * All Rights Reserved.
8  *
9  *
10  * File : shell.h
11  * Created : 8 feb. 2013
12  * Author : Vincent van Beveren
13  */
14 
15 
16 #ifndef SHELL_H_
17 #define SHELL_H_
18 
19 /**
20  * @file
21  *
22  * @ingroup util
23  *
24  * The shell is a ASCII command interpreter and effort has been made to simplify creation of
25  * additional shell commands.
26  *
27  * See the tutorial [Adding your own shell commands](@ref addshellcmd).
28  *
29  *
30  */
31 
32 /**
33  * Stub function. Implemented by application.
34  *
35  * Polls the UART for characters. Should not block.
36  * Return -1 if there is no character.
37  */
38 int _shellChar();
39 
40 /**
41  * Sets the prompt for the shell. Default this is `~>`.
42  *
43  * @param newPrompt A char pointer to the new prompt, or null to reset to the default.
44  */
45 void shellSetPrompt(const char * newPrompt);
46 
47 /**
48  * Checks if there is any ASCII characters of the UART, and execute any commands issued. This
49  * function will exit, once done. Call repeatedly from the main-loop.
50  */
51 void shellDo();
52 
53 #endif /* SHELL_H_ */
int _shellChar()
Stub function.
Definition: sys.c:174
void shellSetPrompt(const char *newPrompt)
Sets the prompt for the shell.
Definition: shell.c:85
void shellDo()
Checks if there is any ASCII characters of the UART, and execute any commands issued.
Definition: shell.c:159