Command Line Interface#

sl_cli_arg_t#

sl_cli_arg_t

Enum of all the argument types.

sl_cli_argument_type_t#

typedef uint8_t sl_cli_argument_type_t

Argument type typedef.

sl_cli_command_func_t#

typedef void(* sl_cli_command_func_t) (sl_cli_command_arg_t *arguments) )(sl_cli_command_arg_t *arguments)

Command handler data type.

sl_cli_command_function_t#

typedef void(* sl_cli_command_function_t) (char *arg_str, void *user) )(char *arg_str, void *user)

Redirect command function.

sl_cli_input_type_t#

typedef uint8_t sl_cli_input_type_t

sl cli input type t

sl_cli_handle_t#

typedef sl_cli_t* sl_cli_handle_t

sl cli handle t

sl_cli_default_handle#

sl_cli_handle_t sl_cli_default_handle

The default CLI handle.

sl_cli_default_command_group#

sl_cli_command_group_t* sl_cli_default_command_group

The default CLI command group.

sl_cli_simple_password_init#

sl_status_t sl_cli_simple_password_init (void )

Initialize module.

Returns

• Initialization status .

sl_cli_simple_password_logout#

sl_status_t sl_cli_simple_password_logout (sl_cli_handle_t handle)

Logout connected user from an instance.

Returns

• Initialization status.

sl_cli_set_simple_password#

sl_status_t sl_cli_set_simple_password (char * new_password)

Set a new password.

Returns

• Operation status.

sl_cli_simple_password_destroy_key#

sl_status_t sl_cli_simple_password_destroy_key (void )

Destroy password key and force to configure a new password.

Returns

• Operation status.

sl_cli_reset_security_warning_flag#

sl_status_t sl_cli_reset_security_warning_flag (void )

Reset security warning flag.

Returns

• Operation status.

sl_cli_command_add_command_group#

bool sl_cli_command_add_command_group (sl_cli_handle_t handle, sl_cli_command_group_t * command_group)

Add a new command group.

Returns

• Returns true if the command_group could be added, false otherwise.

sl_cli_command_remove_command_group#

bool sl_cli_command_remove_command_group (sl_cli_handle_t handle, sl_cli_command_group_t * command_group)

Remove a command group.

Returns

• Returns true if the command_group could be removed, false otherwise.

sl_cli_command_find#

const sl_cli_command_entry_t * sl_cli_command_find (sl_cli_handle_t handle, int * token_c, char * token_v, int * arg_ofs, bool * single_flag, bool * help_flag)

Find a command given the command groups and input arguments.

Returns

• A pointer to a command entry for the given command. If the command is not found, the returned value can be NULL. If a help command is issued, the returned value may point to a command entry table.

sl_cli_command_execute#

sl_status_t sl_cli_command_execute (sl_cli_handle_t handle, char * input)

Find and execute a command given the string input and the command table.

Note

• The input string will be modified in-place.

Returns

• Status of the execution.

sl_cli_tokenize#

sl_status_t sl_cli_tokenize (char input, int * token_c, char * token_v)

Split a C-string on space, ignoring sections in {} or "".

Note

• This function modifies the content of the input string, and points the pointers in tokens to addresses in the input string. In quote strings ("") or curly braces ({}), the string will not be split, The quotes will be removed, but curly braces are kept for validation. To avoid '"' being interpreted as start/end of quote string, it may be escaped using '\"', both within and outside of "...". '{' may be escaped using * '\{'. There is no need for escaping '}', since only hex digits are allowed within {...}. Backslash also needs be be escaped, as '\'.

Returns

• Status of the operation.

sl_cli_input_char#

bool sl_cli_input_char (sl_cli_handle_t handle, char c)

Handle new input char from the terminal, both in terms of writing back to terminal and writing to the input buffer.

This function should be called every time new input is detected. The behavior of the function is highly configurable through settings in cli_config.h.

Returns

• Returns true if newline or return is detected, false otherwise.

sl_cli_input_clear#

void sl_cli_input_clear (sl_cli_handle_t handle)

Empty the input buffer.

This function should be called after newline has been detected and the information in the buffer has been processed.

sl_cli_get_argument_hex#

uint8_t * sl_cli_get_argument_hex (sl_cli_command_arg_t * a, size_t n, size_t * l)

Get the hex argument length and value.

Returns

• A pointer to the value buffer.

sl_cli_clear#

void sl_cli_clear (sl_cli_handle_t handle)

Clear (reset) a CLI.

sl_cli_redirect_command#

void sl_cli_redirect_command (sl_cli_handle_t handle, sl_cli_command_function_t command_function, const char * prompt, void * aux)

Redirect user input.

Normally, an input string is passed to the CLI command handler for execution, but with the redirect function the input string will be passed to the alternative function. If the alternative input function should not to be used, this function can be called with NULL in the command_function, prompt and aux.

sl_cli_handle_input#

sl_status_t sl_cli_handle_input (sl_cli_handle_t handle, char * string)

Handle input.

Execute a complete command line with command and arguments.

Returns

• Execution status. Note: If the command is redirected, the function will always return SL_STATUS_OK.

sl_cli_instance_init#

sl_status_t sl_cli_instance_init (sl_cli_handle_t handle, sl_cli_instance_parameters_t * parameters)

Initialize a CLI instance.

Returns

• Initialization status.

sl_cli_is_ok_to_sleep#

bool sl_cli_is_ok_to_sleep (sl_cli_handle_t handle)

Check if the CLI instance can allow sleep.

This function is available in a bare metal configuration only.

Returns

• A boolean that is true if the CLI allows sleep, else false.

sl_cli_tick_instance#

void sl_cli_tick_instance (sl_cli_handle_t handle)

The bare metal tick function.

SL_CLI_NVM3_KEY_COUNT#

#define SL_CLI_NVM3_KEY_COUNT

(0x100)

sl cli nvm3 key count

SL_CLI_NVM3_KEY_BEGIN#

#define SL_CLI_NVM3_KEY_BEGIN

(0x3000)

sl cli nvm3 key begin

SL_CLI_NVM3_KEY_END#

#define SL_CLI_NVM3_KEY_END

(SL_CLI_NVM3_KEY_BEGIN + SL_CLI_NVM3_KEY_COUNT)

sl cli nvm3 key end

SL_CLI_INPUT_ORDINARY#

#define SL_CLI_INPUT_ORDINARY

(0U)

Ordinary text or non-special characters.

SL_CLI_INPUT_RETURN#

#define SL_CLI_INPUT_RETURN

(1U)

RETURN character.

SL_CLI_INPUT_ESCAPE#

#define SL_CLI_INPUT_ESCAPE

(2U)

escape character (0xb)

SL_CLI_INPUT_ARROW#

#define SL_CLI_INPUT_ARROW

(3U)

Must follow escape character. (0x5b)

SL_CLI_COMMAND#

#define SL_CLI_COMMAND

A macro, which is used to create commands.

SL_CLI_COMMAND_GROUP#

#define SL_CLI_COMMAND_GROUP

A macro, which is used to create command groups.

SL_CLI_ARG_UINT8#

#define SL_CLI_ARG_UINT8

(0x00U)

UINT8 argument type.

SL_CLI_ARG_UINT16#

#define SL_CLI_ARG_UINT16

(0x01U)

UINT16 argument type.

SL_CLI_ARG_UINT32#

#define SL_CLI_ARG_UINT32

(0x02U)

UINT32 argument type.

SL_CLI_ARG_INT8#

#define SL_CLI_ARG_INT8

(0x03U)

INT8 argument type.

SL_CLI_ARG_INT16#

#define SL_CLI_ARG_INT16

(0x04U)

INT16 argument type.

SL_CLI_ARG_INT32#

#define SL_CLI_ARG_INT32

(0x05U)

INT32 argument type.

SL_CLI_ARG_STRING#

#define SL_CLI_ARG_STRING

(0x06U)

STRING argument type.

SL_CLI_ARG_HEX#

#define SL_CLI_ARG_HEX

(0x07U)

HEX argument type.

SL_CLI_ARG_UINT8OPT#

#define SL_CLI_ARG_UINT8OPT

(0x10U)

Optional (zero or more) UINT8 argument type.

SL_CLI_ARG_UINT16OPT#

#define SL_CLI_ARG_UINT16OPT

(0x11U)

Optional (zero or more) UINT16 argument type.

SL_CLI_ARG_UINT32OPT#

#define SL_CLI_ARG_UINT32OPT

(0x12U)

Optional (zero or more) UINT32 argument type.

SL_CLI_ARG_INT8OPT#

#define SL_CLI_ARG_INT8OPT

(0x13U)

Optional (zero or more) INT8 argument type.

SL_CLI_ARG_INT16OPT#

#define SL_CLI_ARG_INT16OPT

(0x14U)

Optional (zero or more) INT16 argument type.

SL_CLI_ARG_INT32OPT#

#define SL_CLI_ARG_INT32OPT

(0x15U)

Optional (zero or more) INT32 argument type.

SL_CLI_ARG_STRINGOPT#

#define SL_CLI_ARG_STRINGOPT

(0x16U)

Optional (zero or more) STRING argument type.

SL_CLI_ARG_HEXOPT#

#define SL_CLI_ARG_HEXOPT

(0x17U)

Optional (zero or more) HEX argument type.

SL_CLI_ARG_ADDITIONAL#

#define SL_CLI_ARG_ADDITIONAL

(0x20U)

ADDITIONAL argument type.

SL_CLI_ARG_WILDCARD#

#define SL_CLI_ARG_WILDCARD

(0x21U)

WILDCARD argument type.

SL_CLI_ARG_GROUP#

#define SL_CLI_ARG_GROUP

(0xFEU)

GROUP argument type.

SL_CLI_ARG_END#

#define SL_CLI_ARG_END

(0xFFU)

END argument type.

SL_CLI_INPUT_DIRECTION_UP#

#define SL_CLI_INPUT_DIRECTION_UP

(1)

MACROS ************************************.

Define the UP-direction.

SL_CLI_INPUT_DIRECTION_DOWN#

#define SL_CLI_INPUT_DIRECTION_DOWN

(-1)

Define the DOWN-direction.

SL_CLI_TICK_ENABLE#

#define SL_CLI_TICK_ENABLE

1

Enable the CLI tick.

Trigger the creation of a tick task or the implentation of the tick handling function.

sl_cli_get_argument_count#

#define sl_cli_get_argument_count

(a)

Obtain the number of command arguments.

Users obtain the number of command arguments with this macro.

Returns

• The number of command arguments.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the number of arguments (after the command strings).
  int arg_count = sl_cli_get_argument_count(args); // arg_count = 4
}

sl_cli_get_argument_type#

#define sl_cli_get_argument_type

(a, n)

Obtain the type of argument.

Users obtain the type of the argument with this macro.

Returns

• enum of the argument type.

For auto-generated commands, it could be useful in the handler to know the type of the argument.

sl_cli_get_argument_int8#

#define sl_cli_get_argument_int8

(a, n)

Obtain int8 arguments.

Returns

• The argument value.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the arguments (after the command strings).
  char *text_ptr = sl_cli_get_argument_string(args, 0);  // char ptr to
  // "hello"
  uint8_t num1_u8 = sl_cli_get_argument_uint8(args, 1);  // num1_u8 = 255
  int16_t num2_i16 = sl_cli_get_argument_int16(args, 2); // num2_i16 = -100
  size_t hex_array_size;
  uint8_t *hex_array_ptr = sl_cli_get_argument_hex(args, 3, &hex_array_size);
  // uint8_t ptr to {0xAA, 0xBB, 0xCC}, hex_array_size = 3
}

sl_cli_get_argument_int16#

#define sl_cli_get_argument_int16

(a, n)

Obtain int16 arguments.

Returns

• The argument value.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the arguments (after the command strings).
  char *text_ptr = sl_cli_get_argument_string(args, 0);  // char ptr to
  // "hello"
  uint8_t num1_u8 = sl_cli_get_argument_uint8(args, 1);  // num1_u8 = 255
  int16_t num2_i16 = sl_cli_get_argument_int16(args, 2); // num2_i16 = -100
  size_t hex_array_size;
  uint8_t *hex_array_ptr = sl_cli_get_argument_hex(args, 3, &hex_array_size);
  // uint8_t ptr to {0xAA, 0xBB, 0xCC}, hex_array_size = 3
}

sl_cli_get_argument_int32#

#define sl_cli_get_argument_int32

(a, n)

Obtain int32 arguments.

Returns

• The argument value.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the arguments (after the command strings).
  char *text_ptr = sl_cli_get_argument_string(args, 0);  // char ptr to
  // "hello"
  uint8_t num1_u8 = sl_cli_get_argument_uint8(args, 1);  // num1_u8 = 255
  int16_t num2_i16 = sl_cli_get_argument_int16(args, 2); // num2_i16 = -100
  size_t hex_array_size;
  uint8_t *hex_array_ptr = sl_cli_get_argument_hex(args, 3, &hex_array_size);
  // uint8_t ptr to {0xAA, 0xBB, 0xCC}, hex_array_size = 3
}

sl_cli_get_argument_uint8#

#define sl_cli_get_argument_uint8

(a, n)

Obtain uint8 arguments.

Returns

• The argument value.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the arguments (after the command strings).
  char *text_ptr = sl_cli_get_argument_string(args, 0);  // char ptr to
  // "hello"
  uint8_t num1_u8 = sl_cli_get_argument_uint8(args, 1);  // num1_u8 = 255
  int16_t num2_i16 = sl_cli_get_argument_int16(args, 2); // num2_i16 = -100
  size_t hex_array_size;
  uint8_t *hex_array_ptr = sl_cli_get_argument_hex(args, 3, &hex_array_size);
  // uint8_t ptr to {0xAA, 0xBB, 0xCC}, hex_array_size = 3
}

sl_cli_get_argument_uint16#

#define sl_cli_get_argument_uint16

(a, n)

Obtain uint16 arguments.

Returns

• The argument value.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the arguments (after the command strings).
  char *text_ptr = sl_cli_get_argument_string(args, 0);  // char ptr to
  // "hello"
  uint8_t num1_u8 = sl_cli_get_argument_uint8(args, 1);  // num1_u8 = 255
  int16_t num2_i16 = sl_cli_get_argument_int16(args, 2); // num2_i16 = -100
  size_t hex_array_size;
  uint8_t *hex_array_ptr = sl_cli_get_argument_hex(args, 3, &hex_array_size);
  // uint8_t ptr to {0xAA, 0xBB, 0xCC}, hex_array_size = 3
}

sl_cli_get_argument_uint32#

#define sl_cli_get_argument_uint32

(a, n)

Obtain uint32 arguments.

Returns

• The argument value.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the arguments (after the command strings).
  char *text_ptr = sl_cli_get_argument_string(args, 0);  // char ptr to
  // "hello"
  uint8_t num1_u8 = sl_cli_get_argument_uint8(args, 1);  // num1_u8 = 255
  int16_t num2_i16 = sl_cli_get_argument_int16(args, 2); // num2_i16 = -100
  size_t hex_array_size;
  uint8_t *hex_array_ptr = sl_cli_get_argument_hex(args, 3, &hex_array_size);
  // uint8_t ptr to {0xAA, 0xBB, 0xCC}, hex_array_size = 3
}

sl_cli_get_argument_string#

#define sl_cli_get_argument_string

(a, n)

Obtain string arguments.

Returns

• The argument value. For hex arguments, the return value is a pointer to a buffer containing decoded values. For string arguments, the return value is a pointer to the string.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the arguments (after the command strings).
  char *text_ptr = sl_cli_get_argument_string(args, 0);  // char ptr to
  // "hello"
  uint8_t num1_u8 = sl_cli_get_argument_uint8(args, 1);  // num1_u8 = 255
  int16_t num2_i16 = sl_cli_get_argument_int16(args, 2); // num2_i16 = -100
  size_t hex_array_size;
  uint8_t *hex_array_ptr = sl_cli_get_argument_hex(args, 3, &hex_array_size);
  // uint8_t ptr to {0xAA, 0xBB, 0xCC}, hex_array_size = 3
}

sl_cli_get_command_count#

#define sl_cli_get_command_count

(a)

Obtain the number of command strings.

Users obtain the number of command strings with this macro.

Returns

• The number of command strings.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the number of command strings (before the arguments).
  int cmd_count = sl_cli_get_command_count(args); // cmd_count = 2
  // (first string being "example_sub_menu" and second "example_command")
}

sl_cli_get_command_string#

#define sl_cli_get_command_string

(a, n)

Obtain the command string(s).

Users get the command string with this macro. If the command is used in a group, both the group string(s) and command string can be obtained. The total number of command strings is available in the command argument arg_ofs variable.

An example could be the CLI input of example_sub_menu example_command hello 255 -100 {AA BB CC} with corresponding C code of:

void example_command(sl_cli_command_arg_t *args)
{
  // Get the command strings (before the arguments).
  char *cmd1_ptr = sl_cli_get_command_string(args, 0); // char ptr to
  // "example_sub_menu"
  char *cmd2_ptr = sl_cli_get_command_string(args, 1); // char ptr to
  // "example_command"
}