Command Interpreter#

EMBER_MAX_COMMAND_ARGUMENTS#

#define EMBER_MAX_COMMAND_ARGUMENTS

16

The maximum number of arguments a command can have. A nested command counts as an argument.

EMBER_COMMAND_BUFFER_LENGTH#

#define EMBER_COMMAND_BUFFER_LENGTH

100

The maximum number of arguments a command can have. A nested command counts as an argument.

EMBER_COMMAND_INTEPRETER_HAS_DESCRIPTION_FIELD#

#define EMBER_COMMAND_INTEPRETER_HAS_DESCRIPTION_FIELD

Whether or not the command entry structure will include descriptions for the commands. This consumes additional CONST space. By default descriptions are not included.

emberCommandArgumentCount#

uint8_t emberCommandArgumentCount (void )

Returns the number of arguments for the current command.

emberUnsignedCommandArgument#

uint32_t emberUnsignedCommandArgument (uint8_t argNum)

Retrieves unsigned integer arguments.

emberSignedCommandArgument#

int32_t emberSignedCommandArgument (uint8_t argNum)

Retrieves signed integer arguments.

emberStringToHostOrderIpv4Address#

bool emberStringToHostOrderIpv4Address (const uint8_t * string, uint32_t * hostOrderIpv4Address)

Parses an IPv4 address string and returns a host order uint32_t. Returns true if address is valid dotted quad notation (A.B.C.D), false otherwise.

emberStringArgumentToHostOrderIpv4Address#

bool emberStringArgumentToHostOrderIpv4Address (uint8_t argNum, uint32_t * hostOrderIpv4Address)

Parses an IPv4 address string from a command argument and returns host order uint32_t. Returns true if address is valid dotted quad notation (A.B.C.D), false otherwise.

emberStringCommandArgument#

uint8_t* emberStringCommandArgument (int8_t argNum, uint8_t * length)

Retrieve quoted string or hex string arguments. Hex strings have already been converted into binary. To retrieve the name of the command itself, use an argNum of -1. For example, to retrieve the first character of the command, do: uint8_t firstChar = emberStringCommandArgument(-1, NULL)[0]. If the command is nested, an index of -2, -3, etc will work to retrieve the higher level command names. Note that [-1] only returns the text entered. If an abbreviated command name is entered only the text entered will be returned with [-1].

emberCommandName#

const char* emberCommandName (void )

A convenience macro for copying security key arguments to an EmberKeyData pointer.

emberCopyStringArgument#

uint8_t emberCopyStringArgument (int8_t argNum, uint8_t * destination, uint8_t maxLength, bool leftPad)

Copies the string argument to the given destination up to maxLength. If the argument length is nonzero but less than maxLength and leftPad is true, leading zeroes are prepended to bring the total length of the target up to maxLength. If the argument is longer than the maxLength, it is truncated to maxLength. Returns the minimum of the argument length and maxLength.

This function is commonly used for reading in hex strings such as EUI64 or key data and left padding them with zeroes. See emberCopyKeyArgument and emberCopyEui64Argument for convenience macros for this purpose.

emberCopyBigEndianEui64Argument#

uint8_t emberCopyBigEndianEui64Argument (int8_t index, EmberEUI64 destination)

Copies eui64 arguments in big-endian format to an EmberEUI64. This is useful because eui64s are often presented to users in big-endian format even though they are used in software in little-endian format.

emberCopyKeyArgument#

#define emberCopyKeyArgument

A convenience macro for copying security key arguments to an EmberKeyData pointer.

emberCopyEui64Argument#

#define emberCopyEui64Argument

(index, eui64)

A convenience macro for copying eui64 arguments to an EmberEUI64.

emberGetEui64Argument#

#define emberGetEui64Argument

(index, eui64)

A convenience macro for copying security key arguments to an EmberKeyData pointer.

EmberCommandStatus#

EmberCommandStatus

Command error states.

If you change this list, ensure you also change the strings that describe these errors in the array emberCommandErrorNames[] in command-interpreter.c.

CommandAction#

typedef void(* CommandAction) (void) )(void)

emberCurrentCommand#

EmberCommandEntry* emberCurrentCommand

A pointer to the currently matching command entry. Only valid from within a command function. If the original command was nested, points to the final (non-nested) command entry.

emberCommandTable#

EmberCommandEntry emberCommandTable[]

emberCommandInterpreter2Configuration#

uint8_t emberCommandInterpreter2Configuration

Configuration byte.

emberCommandReaderSetDefaultBase#

void emberCommandReaderSetDefaultBase (uint8_t base)

emberCommandActionHandler#

void emberCommandActionHandler (const CommandAction action)

The application may implement this handler. To override the default handler, define EMBER_APPLICATION_HAS_COMMAND_ACTION_HANDLER in the CONFIGURATION_HEADER.

emberCommandErrorHandler#

void emberCommandErrorHandler (EmberCommandStatus status)

The application may implement this handler. To override the default handler, define EMBER_APPLICATION_HAS_COMMAND_ERROR_HANDLER in the CONFIGURATION_HEADER. Defining this will also remove the help functions emberPrintCommandUsage(), emberPrintCommandUsageNotes(), and emberPrintCommandTable().

emberPrintCommandUsage#

void emberPrintCommandUsage (EmberCommandEntry * entry)

emberPrintCommandUsageNotes#

void emberPrintCommandUsageNotes (void )

emberPrintCommandTable#

void emberPrintCommandTable (void )

emberCommandClearBuffer#

void emberCommandClearBuffer (void )

emberCommandReaderInit#

void emberCommandReaderInit (void )

Initialize the command interpreter.

emberProcessCommandString#

bool emberProcessCommandString (uint8_t * input, uint8_t sizeOrPort)

Process the given string as a command.

emberCommandInterpreterBusy#

bool emberCommandInterpreterBusy (void )

Returns true interpreter is reading a command.

MAX_TOKEN_COUNT#

#define MAX_TOKEN_COUNT

(EMBER_MAX_COMMAND_ARGUMENTS + 1)

emberCommandEntryAction#

#define emberCommandEntryAction

(name, action, argumentTypes, description)

emberCommandEntryActionWithDetails#

#define emberCommandEntryActionWithDetails

(name, action, argumentTypes, description, argumentDescriptionArray)

emberCommandEntrySubMenu#

#define emberCommandEntrySubMenu

(name, subMenu, description)

emberCommandEntryTerminator#

#define emberCommandEntryTerminator

()

EMBER_COMMAND_INTERPRETER_CONFIGURATION_ECHO#

#define EMBER_COMMAND_INTERPRETER_CONFIGURATION_ECHO

(0x01)

emberProcessCommandInput#

#define emberProcessCommandInput

(port)

Process input coming in on the given serial port.

Returns

• true if an end of line character was read. If the application uses a command line prompt, this indicates it is time to print the prompt.

  void emberProcessCommandInput(uint8_t port);
  

emberCommandInterpreterEchoOn#

#define emberCommandInterpreterEchoOn

Turn echo of command line on.

emberCommandInterpreterEchoOff#

#define emberCommandInterpreterEchoOff

Turn echo of command line off.

emberCommandInterpreterIsEchoOn#

#define emberCommandInterpreterIsEchoOn

Returns true if echo is on, false otherwise.