sl_cli Struct Reference
Struct representing an instance of the CLI.
#include <sl_cli_types.h>
Data Fields |
|
| bool | tick_in_progress |
|
True when a tick is in progress.
|
|
| const char * | prompt_string |
|
The current command prompt.
|
|
| bool | req_prompt |
|
The next tick shall write a prompt.
|
|
| char | input_buffer [SL_CLI_INPUT_BUFFER_SIZE] |
|
The input buffer.
|
|
| int | input_size |
|
Length of input buffer.
|
|
| int | input_pos |
|
The position the user is currently typing to.
|
|
| int | input_len |
|
The total length of the current input.
|
|
| sl_cli_input_type_t | last_input_type |
|
Keeps track of last input.
|
|
| sl_slist_node_t * | command_group |
|
Base for the command group list.
|
|
| sl_cli_command_function_t | command_function |
|
Function pointer to an alternate command function.
|
|
| void * | aux_argument |
|
User defined command argument.
|
|
| sl_iostream_t * | iostream_handle |
|
The iostream used by the CLI.
|
|
| uint32_t | start_delay_tick |
|
A delay after the CLI task has started before any actions in ticks.
|
|
| uint32_t | loop_delay_tick |
|
A delay in the CLI task loop in ticks.
|
|
Struct representing an instance of the CLI.
Field Documentation
◆ tick_in_progress
| bool sl_cli::tick_in_progress |
True when a tick is in progress.
◆ prompt_string
| const char* sl_cli::prompt_string |
The current command prompt.
◆ req_prompt
| bool sl_cli::req_prompt |
The next tick shall write a prompt.
◆ input_buffer
| char sl_cli::input_buffer[SL_CLI_INPUT_BUFFER_SIZE] |
The input buffer.
◆ input_size
| int sl_cli::input_size |
Length of input buffer.
◆ input_pos
| int sl_cli::input_pos |
The position the user is currently typing to.
◆ input_len
| int sl_cli::input_len |
The total length of the current input.
◆ last_input_type
| sl_cli_input_type_t sl_cli::last_input_type |
Keeps track of last input.
◆ command_group
| sl_slist_node_t* sl_cli::command_group |
Base for the command group list.
◆ command_function
| sl_cli_command_function_t sl_cli::command_function |
Function pointer to an alternate command function.
◆ aux_argument
| void* sl_cli::aux_argument |
User defined command argument.
◆ iostream_handle
| sl_iostream_t * sl_cli::iostream_handle |
The iostream used by the CLI.
◆ start_delay_tick
| uint32_t sl_cli::start_delay_tick |
A delay after the CLI task has started before any actions in ticks.
◆ loop_delay_tick
| uint32_t sl_cli::loop_delay_tick |
A delay in the CLI task loop in ticks.