A Command Interpreter with support for used defined commands, subsystems, macros, help and parameter parsing.
Diff: cmdb.h
- Revision:
- 15:d9680ef7b3f8
- Parent:
- 14:c652ce068f6c
- Child:
- 16:ec8147828286
diff -r c652ce068f6c -r d9680ef7b3f8 cmdb.h --- a/cmdb.h Fri Feb 11 19:30:30 2011 +0000 +++ b/cmdb.h Fri Mar 11 11:01:41 2011 +0000 @@ -384,26 +384,26 @@ //------------------------------------------------------------------------------ -/** Command Interpreter class.<br/> - * <br/> - * Steps to take:<br/> - * <br/> - * 1) Create a std::vector<cmd> and fill it with at least<br/> - * the mandatory commands IDLE and HELP.<br/> - * <br/> - * 2) Create an Cmdb class instance and pass it the vector,<br/> - * a Serial port object like Serial serial(USBTX, USBRX); <br/> - * and finally a command dispatcher function.<br/> - * <br/> - * 3) Feed the interpreter with characters received from your serial port.<br/> - * Note: Cmdb self does not retrieve input it must be handed to it.<br/> - * It implements basic members for checking/reading the serial port.<br/> - * <br/> - * 4) Handle commands added by the application by the Cid and parameters passed.<br/> - * <br/> - * Note: Predefined commands and all subsystems transitions are handled by the internal dispatcher.<br/> - * So the passed dispatcher only has to handle user/application defined commands'.<br/> - * <br/> +/** Command Interpreter class. + * + * Steps to take: + * + * 1) Create a std::vector<cmd> and fill it with at least + * the mandatory commands IDLE and HELP. + * + * 2) Create an Cmdb class instance and pass it the vector, + * a Serial port object like Serial serial(USBTX, USBRX); + * and finally a command dispatcher function. + * + * 3) Feed the interpreter with characters received from your serial port. + * Note: Cmdb self does not retrieve input it must be handed to it. + * It implements basic members for checking/reading the serial port. + * + * 4) Handle commands added by the application by the Cid and parameters passed. + * + * Note: Predefined commands and all subsystems transitions are handled by the internal dispatcher. + * So the passed dispatcher only has to handle user/application defined commands'. + * * @see main.cpp for a demo. */ class Cmdb {