nRF5 SDK v16.0.0
Macros
Command line interface configuration

Macros

#define NRF_CLI_ENABLED
 Enable/disable the CLI module. More...
 
#define NRF_CLI_ARGC_MAX
 Maximum number of parameters passed to the command handler. More...
 
#define NRF_CLI_BUILD_IN_CMDS_ENABLED
 CLI built-in commands. More...
 
#define NRF_CLI_CMD_BUFF_SIZE
 Maximum buffer size for a single command. More...
 
#define NRF_CLI_ECHO_STATUS
 CLI echo status. If set, echo is ON. More...
 
#define NRF_CLI_WILDCARD_ENABLED
 Enable wildcard functionality for CLI commands. More...
 
#define NRF_CLI_METAKEYS_ENABLED
 Enable additional control keys for CLI commands like ctrl+a, ctrl+e, ctrl+w, ctrl+u. More...
 
#define NRF_CLI_PRINTF_BUFF_SIZE
 Maximum print buffer size. More...
 
#define NRF_CLI_HISTORY_ENABLED
 Enable CLI history mode. More...
 
#define NRF_CLI_HISTORY_ELEMENT_SIZE
 Size of one memory object reserved for CLI history. More...
 
#define NRF_CLI_HISTORY_ELEMENT_COUNT
 Number of history memory objects. More...
 
#define NRF_CLI_VT100_COLORS_ENABLED
 CLI VT100 colors. More...
 
#define NRF_CLI_STATISTICS_ENABLED
 Enable CLI statistics. More...
 
#define NRF_CLI_LOG_BACKEND
 Enable logger backend interface. More...
 
#define NRF_CLI_USES_TASK_MANAGER_ENABLED
 Enable CLI to use task_manager. More...
 

Detailed Description

Macro Definition Documentation

#define NRF_CLI_ARGC_MAX

Maximum number of parameters passed to the command handler.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_BUILD_IN_CMDS_ENABLED

CLI built-in commands.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_CMD_BUFF_SIZE

Maximum buffer size for a single command.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_ECHO_STATUS

CLI echo status. If set, echo is ON.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_ENABLED

Enable/disable the CLI module.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_HISTORY_ELEMENT_COUNT

Number of history memory objects.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_HISTORY_ELEMENT_SIZE

Size of one memory object reserved for CLI history.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_HISTORY_ENABLED

Enable CLI history mode.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_LOG_BACKEND

Enable logger backend interface.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_METAKEYS_ENABLED

Enable additional control keys for CLI commands like ctrl+a, ctrl+e, ctrl+w, ctrl+u.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_PRINTF_BUFF_SIZE

Maximum print buffer size.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_STATISTICS_ENABLED

Enable CLI statistics.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_USES_TASK_MANAGER_ENABLED

Enable CLI to use task_manager.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_VT100_COLORS_ENABLED

CLI VT100 colors.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.
#define NRF_CLI_WILDCARD_ENABLED

Enable wildcard functionality for CLI commands.

Set to 1 to activate.

Note
This is an NRF_CONFIG macro.

Documentation feedback | Developer Zone | Subscribe | Updated