Command Interpreter

Application Utilities API Reference

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

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

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

Turn echo of command line off.

Turn echo of command line on.

Returns true if echo is on, false otherwise.

A convenience macro for copying eui64 arguments to an EmberEUI64.

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

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

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

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.

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

Returns the number of arguments for the current command.

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().

Returns true interpreter is reading a command.

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

Initialize the command interpreter.

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.

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.

Process the given string as a command.

Retrieves signed integer arguments.

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.

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].

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.

Retrieves unsigned integer arguments.

Configuration byte.

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.