SAMV71 Xplained Ultra Software Package 1.4

shell.h File Reference

Go to the source code of this file.

Functions

void shell_init (void)
void shell_start (void)
void shell_input (char *command)
void shell_quit (char *)
void shell_output (char *str1, char *str2)
void shell_prompt (char *prompt)

Detailed Description

Interface for the Contiki shell.

Author:
Adam Dunkels <adam@dunkels.com>

Some of the functions declared in this file must be implemented as a shell back-end in the architecture specific files of a Contiki port.

Definition in file shell.h.


Function Documentation

void shell_init ( void   ) 

Initialize the shell.

Called when the shell front-end process starts. This function may be used to start listening for signals.

Definition at line 105 of file shell.c.

void shell_input ( char *  command  ) 

Process a shell command.

This function will be called by the shell GUI / telnet server whan a command has been entered that should be processed by the shell back-end.

Parameters:
command The command to be processed.

Definition at line 118 of file shell.c.

Here is the call graph for this function:

void shell_output ( char *  str1,
char *  str2 
)

Print a string to the shell window.

This function is implemented by the shell GUI / telnet server and can be called by the shell back-end to output a string in the shell window. The string is automatically appended with a linebreak.

Parameters:
str1 The first half of the string to be output.
str2 The second half of the string to be output.

Definition at line 113 of file telnetd.c.

Here is the call graph for this function:

void shell_prompt ( char *  prompt  ) 

Print a prompt to the shell window.

This function can be used by the shell back-end to print out a prompt to the shell window.

Parameters:
prompt The prompt to be printed.

Definition at line 101 of file telnetd.c.

Here is the call graph for this function:

void shell_quit ( char *   ) 

Quit the shell.

Definition at line 79 of file telnetd.c.

Here is the call graph for this function:

void shell_start ( void   ) 

Start the shell back-end.

Called by the front-end when a new shell is started.

Definition at line 110 of file shell.c.

Here is the call graph for this function:

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines