commands.h

Go to the documentation of this file.

#ifndef COMMANDS_H
#define COMMANDS_H

//
// Command action function prototypes, see commands.c for the implementation
//

// Common interactive client commands 

int cmd_quit   (char *, MsgType, char *); // quit the application
int cmd_ping   (char *, MsgType, char *); // ping (comm handshake request)
int cmd_pong   (char *, MsgType, char *); // pong (comm handshake acknowledge)
int cmd_info   (char *, MsgType, char *); // return client application info
int cmd_version(char *, MsgType, char *); // return version info
int cmd_verbose(char *, MsgType, char *); // toggle verbose mode
int cmd_debug  (char *, MsgType, char *); // toggle debug (superverbose) mode
int cmd_help   (char *, MsgType, char *); // show command help
int cmd_history(char *, MsgType, char *); // cli history utility
int cmd_status (char *, MsgType, char *); // client STATUS command

// IFW commands

int cmd_filter (char *, MsgType, char *); // set/query the filter position
int cmd_home   (char *, MsgType, char *); // home the filter wheel
int cmd_send   (char *, MsgType, char *); // send a raw IFW command 
int cmd_ports  (char *, MsgType, char *); // show current IFW comm port info
int cmd_setto  (char *, MsgType, char *); // set/query IFW comm timeout
int cmd_init   (char *, MsgType, char *); // initialize/reset runtime params

// Application command/action structure

struct Commands {
  char *cmd;        
  int(* action)(char *args, MsgType msgtype, char *reply);  
  char *usage;        
  char *description;  
}
cmdtab[] = {   
  {"quit"    ,cmd_quit    ,"quit","Terminate the IFWTool session"},
  {"filter"  ,cmd_filter  ,"filter <n>","Set/query the filter position"},
  {"send"    ,cmd_send    ,"send <cmd>","Send a raw IFW command"},
  {"status"  ,cmd_status  ,"status","Report IFWTool application status"},
  {"timeout" ,cmd_setto   ,"timeout <sec>","Set/query the IFW port communications timeout in seconds"},
  {"init"    ,cmd_init    ,"init","(re)Initialize the IFW"},  
  {"home"    ,cmd_home    ,"home", "Restore filter wheel to position 1"},
  {"verbose" ,cmd_verbose ,"verbose","Toggle verbose output mode on/off"},
  {"debug"   ,cmd_debug   ,"debug","Toggle super-verbose debugging output mode on/off"},
  {"history" ,cmd_history ,"history","Show the command history"},
  {"info"    ,cmd_info    ,"info","Report application runtime info"},
  {"version" ,cmd_version ,"version","Report the application version and compilation time"},
  {"ports"   ,cmd_ports   ,"ports","List information about the active IFW comm ports"},
  {"help"    ,cmd_help    ,"help <cmd>","Help command (alias: ? <cmd>)"},
  {"?"       ,cmd_help    ,"",""},  // "" excludes from help
  {"ping"    ,cmd_ping    ,"",""},
  {"pong"    ,cmd_pong    ,"",""}   
};

// Number of commands defined (so we don't have to count correctly)
  
int NumCommands = sizeof(cmdtab)/sizeof(struct Commands);  

// command function return codes

#define CMD_OK   0   
#define CMD_ERR -1   
#define CMD_NOOP 1   

#endif // COMMANDS_H

---