The CommandProcessor is the interface to install a run-time menu into an embedded system.

Dependents:   A_CANAdapter USB2I2C

Embed: (wiki syntax)

« Back to documentation index

CMD_T Struct Reference

CMD_T Struct Reference

This defines the type for a single item to be added to the CommandProcessor menu. More...

#include <CommandProcessor.h>

Data Fields

char * command
 a pointer to the command to match (e.g. 'Help')
char * helptext
 a pointer to some text to show when user types 'Help'
MENU_CALLBACK callback
 the function to call when user enters this command
VISIBLE_T visible
 a flag that determines if this command is visible in Help.

Detailed Description

This defines the type for a single item to be added to the CommandProcessor menu.

This is defined in the application code, and a pointer to this item is passed to the CommandProcessor to add this item to the menu system.

example:

 const CMD_T WhoCmd = {"who", "Shows who is logged on, or 'who id' for specifics", Who, visible};

Definition at line 206 of file CommandProcessor.h.


Field Documentation

the function to call when user enters this command

Definition at line 210 of file CommandProcessor.h.

char* command

a pointer to the command to match (e.g. 'Help')

Definition at line 208 of file CommandProcessor.h.

char* helptext

a pointer to some text to show when user types 'Help'

Definition at line 209 of file CommandProcessor.h.

a flag that determines if this command is visible in Help.

Definition at line 211 of file CommandProcessor.h.