The CommandProcessor is the interface to install a run-time menu into an embedded system.
Dependents: A_CANAdapter USB2I2C
Diff: CommandProcessor.h
- Revision:
- 11:4a3cd3f2183b
- Parent:
- 10:9e52bd1a4a71
- Child:
- 12:a8c56bf811b9
diff -r 9e52bd1a4a71 -r 4a3cd3f2183b CommandProcessor.h --- a/CommandProcessor.h Sat Apr 23 14:04:19 2011 +0000 +++ b/CommandProcessor.h Sat Apr 23 14:15:10 2011 +0000 @@ -140,13 +140,19 @@ initok ///< this indicates that the menu system was successfully initialized } INITRESULT_T; -/// Configuration options +/// Configuration options to control startup and some runtime behavior +/// +/// Permissible values are created by combining +/// \li CFG_ENABLE_TERMINATE +/// \li CFG_ENABLE_SYSTEM +/// \li CFG_ECHO_ON +/// \li CFG_CASE_INSENSITIVE typedef unsigned long CONFIG_T; -#define CFG_ENABLE_TERMINATE 0x0001 -#define CFG_ENABLE_SYSTEM 0x0002 -#define CFG_ECHO_ON 0x2000 -#define CFG_CASE_INSENSITIVE 0x4000 +#define CFG_ENABLE_TERMINATE 0x0001 ///<- Enable the exit option +#define CFG_ENABLE_SYSTEM 0x0002 ///<- Enable various system options (help, etc) +#define CFG_ECHO_ON 0x2000 ///<- Initialize with command prompt Echo on +#define CFG_CASE_INSENSITIVE 0x4000 ///<- Enable case insensitive command entry /// This is the type for the basic callback, when a menu pick is activated.