KETCube terminal command definition. More...

#include <ketCube_terminal_common.h>

Data Fields
char *	cmd
	command format More...

char *	descr
	Human-readable command description/help. More...

ketCube_terminal_command_flags_t	flags
	command flags More...

ketCube_terminal_paramSet_type_t	outputSetType
	cmd output parameter type More...

ketCube_terminal_paramSet_type_t	paramSetType
	cmd input parameter type More...

union {
void(* callback )(void)
	Ptr to a custom callback. More...

struct ketCube_terminal_cmd_t * subCmdList
	Ptr to a subcommand list (if this is root command) More...

struct ketCube_cfg_varDescr_t * cfgVarPtr
	The configuration variable descriptor - RAM/EEPROM (use for generic commands) More...

}	settingsPtr
	Command settings - depends on flags. More...

ketCube_moduleID_t	moduleId

Detailed Description

KETCube terminal command definition.

Field Documentation

◆ callback

void(* ketCube_terminal_cmd_t::callback) (void)

Ptr to a custom callback.

◆ cfgVarPtr

struct ketCube_cfg_varDescr_t* ketCube_terminal_cmd_t::cfgVarPtr

The configuration variable descriptor - RAM/EEPROM (use for generic commands)

◆ cmd

char* ketCube_terminal_cmd_t::cmd

command format

◆ descr

char* ketCube_terminal_cmd_t::descr

Human-readable command description/help.

◆ flags

ketCube_terminal_command_flags_t ketCube_terminal_cmd_t::flags

command flags

◆ moduleId

ketCube_moduleID_t ketCube_terminal_cmd_t::moduleId

◆ outputSetType

ketCube_terminal_paramSet_type_t ketCube_terminal_cmd_t::outputSetType

cmd output parameter type

◆ paramSetType

ketCube_terminal_paramSet_type_t ketCube_terminal_cmd_t::paramSetType

cmd input parameter type

◆ settingsPtr

union { ... } ketCube_terminal_cmd_t::settingsPtr

Command settings - depends on flags.

◆ subCmdList

struct ketCube_terminal_cmd_t* ketCube_terminal_cmd_t::subCmdList

Ptr to a subcommand list (if this is root command)

The documentation for this struct was generated from the following file:

KETCube/core/ketCube_terminal_common.h

Data Fields