Command Interpreter Plugin#

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)

Retrieve signed integer arguments.

emberStringCommandArgument#

uint8_t * emberStringCommandArgument (int8_t argNum, uint8_t * length)

Retrieve quoted string or hexadecimal string arguments. Hexadecimal strings are already converted into binary. ASCII strings are null terminated. The null terminator is not included in the returned length argument. To retrieve the name of the command itself, use an argNum of -1. For example, to retrieve the first character of the command, uint8_t firstChar = emberStringCommandArgument(-1, NULL)[0]. If the command is nested, an index of -2, -3, and so on retrieves 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.

emberGetStringArgument#

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

Copy the string argument to the given destination up to maxLength. If the argument length is not zero 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. ASCII strings are null terminated but the null terminator is not included in the returned length.

This function is commonly used for reading in hexadecimal strings, such as EUI64 or key data and left padding them with zeros. See emberGetKeyArgument and emberGetEui64Argument for convenience macros for this purpose.

emberGetIpArgument#

bool emberGetIpArgument (uint8_t index, uint8_t * target)

Parse and return, via target, an IP address at the provided index. Returns true if an IP address was successfully parsed Returns false otherwise.

emberGetIpPrefixArgument#

bool emberGetIpPrefixArgument (uint8_t index, uint8_t * target)

Parse and return, via target, an IP prefix at the provided index. Returns true if an IP prefix was successfully parsed. Returns false otherwise.

emberGetExtendedPanIdArgument#

void emberGetExtendedPanIdArgument (int8_t index, uint8_t * extendedPanId)

Copy the extended PAN ID argument to the given destination, reversing the bytes. Extended PAN IDs are stored little endian so reversing the bytes means they are big endian in the input command string.

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.

emberGetKeyArgument#

#define emberGetKeyArgument

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

emberGetEui64Argument#

#define emberGetEui64Argument

(index, eui64)

Copy the EUI64 argument to the given EmberEui64 destination reversing the bytes. EUI64's are stored little endian so reversing the bytes means they are big endian in the input command string.

emberCommandErrorHandler#

void emberCommandErrorHandler (EmberCommandStatus status, EmberCommandEntry * command)

EMBER_MAX_COMMAND_ARGUMENTS#

#define EMBER_MAX_COMMAND_ARGUMENTS

20

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

200

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

EMBER_CUSTOM_COMMAND_BUFFER_LENGTH#

#define EMBER_CUSTOM_COMMAND_BUFFER_LENGTH

(EMBER_COMMAND_BUFFER_LENGTH - 3)

The maximum message size for custom commands reserves three bytes for the length (1 bytes) and the custom command identifier (2 bytes).

EMBER_COMMAND_INTEPRETER_HAS_DESCRIPTION_FIELD#

#define EMBER_COMMAND_INTEPRETER_HAS_DESCRIPTION_FIELD

Indicate whether or not the command entry structure includes descriptions for the commands. This consumes additional CONST space, which is expensive on the XAP. By default, descriptions are not included.

EmberCommandStatus#

EmberCommandStatus

Command error states.

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

CommandAction#

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

EmberCommandErrorHandler#

typedef void EmberCommandErrorHandler(EmberCommandStatus status, EmberCommandEntry *command) (EmberCommandStatus status, EmberCommandEntry *command)

Type of error handlers; the command argument is currently always NULL.

emberCommandTable#

EmberCommandEntry emberCommandTable[]

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 (const uint8_t * input, uint16_t sizeOrPort)

Process the given string as a command.

emberHexToInt#

uint8_t emberHexToInt (uint8_t ch)

Return the value of a hexadecimal digit ch (0 - 15). Returns a value > 15 if ch is not a hexadecimal digit.

emberStringToIpAddress#

bool emberStringToIpAddress (const uint8_t * string, uint8_t stringLength, uint8_t * target)

Parse textual representations of IPv6 addresses as described in http://www.ietf.org/rfc/rfc4291.txt.

emberStringToIpPrefix#

bool emberStringToIpPrefix (const uint8_t * string, uint8_t stringLength, uint8_t * target)

Parse textual representations of IPv6 prefixes as described in http://www.ietf.org/rfc/rfc4291.txt.

emberInitializeCommandState#

void emberInitializeCommandState (EmberCommandState * state)

Must be called to initialize a command state before passing it to emberRunCommandInterpreter().

emberRunCommandInterpreter#

bool emberRunCommandInterpreter (bool commandIsBinary, EmberCommandState * state, EmberCommandEntry * commands, EmberCommandErrorHandler * errorHandler, const uint8_t * input, uint16_t sizeOrPort)

For use when additional different command streams are used.

emberCommandReaderSetDefaultBase#

void emberCommandReaderSetDefaultBase (uint8_t base)

MAX_TOKEN_COUNT#

#define MAX_TOKEN_COUNT

(EMBER_MAX_COMMAND_ARGUMENTS + 1)

emberCommandEntryAction#

#define emberCommandEntryAction

(name, command, arguments, description)

emberCommandEntrySubMenu#

#define emberCommandEntrySubMenu

(name, nestedCommands, description)

emberCommandEntryTerminator#

#define emberCommandEntryTerminator

()

emberCommand#

#define emberCommand

emberCommandEntryAction

emberNestedCommand#

#define emberNestedCommand

emberCommandEntrySubMenu

emberProcessCommandInput#

#define emberProcessCommandInput

(port)

Process the 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);