Interface: CommandRegister

The interface for registering commands.

See lib/Commands/... for examples of components that register commands.

See interfaces/Command.h for the data structures used in this interface

Implemented by lib/Command.td

Author: Wei Hong (wei.hong@intel-research.net)

Components requiring this interface:: tos.lib.Commands.CommandAttrM
tos.lib.Commands.CommandLedsM
tos.lib.Commands.CommandPotM
tos.lib.Commands.CommandResetM
tos.lib.Commands.CommandSounderM

Commands

result_t registerCommand (char *name, TOSType retType, uint8_t retLen, ParamList *paramList) Register a command with the specified name, return type, return length, and parameters.
result_t commandDone(char *commandName, char *resultBuf, SchemaErrorNo errorNo) Should be called when a specified command invocation has completed

Parameters:
The - name of the command that completed
resultBuf - The buffer where the result was written
errorNo - The result code for the command

result_t commandFunc (char *commandName, char *resultBuf, SchemaErrorNo *errorNo, ParamVals *params) Called by Command.td when a specified command is invoked by the user.

result_t registerCommand(char *name, TOSType retType, uint8_t retLen, ParamList *paramList)

Parameters:

name - The name of the command to register

retType - The type of the command (see SchemaType.h)

retLen - The length (in bytes) of the command

paramList - The parameters to this command (see Command.h for the def of paramList)

result_t commandFunc(char *commandName, char *resultBuf, SchemaErrorNo *errorNo, ParamVals *params)

Called by Command.td when a specified command is invoked by the user. The implementer must actually carry out the command.

Parameters:

The - name of the command that was invoked

The - buffer where the command result should be written

An - error code (may be SCHEMA_RESULT_PENDING, in which case commandDone must be called at some time in the future.)