#include "cmdline.h"
To use the cmdline system, you will need to associate command strings (commands the user will be typing) with your function that you wish to have called when the user enters that command. This is done by using the cmdlineAddCommand() function.
To setup the cmdline system, you must do these things:
To operate the cmdline system, you must do these things repeatedly:
The cmdline library does not assume an input or output device, but can be configured to use any user function for output using cmdlineSetOutputFunc() and accepts input by calling cmdlineInputFunc(). This means the cmdline library can operate over any interface including UART (serial port), I2c, ethernet, etc.
FOR MORE INFORMATION ABOUT USING cmdline SEE THE AVRLIB EXAMPLE ***** CODE IN THE avrlib/examples DIRECTORY *****
Typedefs | |
typedef void(* | CmdlineFuncPtrType )(void) |
Functions | |
void | cmdlineInit (void) |
initalize the command line system | |
void | cmdlineAddCommand (u08 *newCmdString, CmdlineFuncPtrType newCmdFuncPtr) |
add a new command to the database of known commands | |
void | cmdlineSetOutputFunc (void(*output_func)(unsigned char c)) |
sets the function used for sending characters to the user terminal | |
void | cmdlineInputFunc (unsigned char c) |
call this function to pass input charaters from the user terminal | |
void | cmdlineMainLoop (void) |
call this function in your program's main loop | |
void | cmdlineRepaint (void) |
void | cmdlineDoHistory (u08 action) |
void | cmdlineProcessInputString (void) |
void | cmdlinePrintPrompt (void) |
void | cmdlinePrintError (void) |
u08 * | cmdlineGetArgStr (u08 argnum) |
returns a string pointer to argument number [argnum] on the command line | |
long | cmdlineGetArgInt (u08 argnum) |
returns the decimal integer interpretation of argument number [argnum] | |
long | cmdlineGetArgHex (u08 argnum) |
returns the hex integer interpretation of argument number [argnum] |