You are viewing documentation for version:
Struct representing an instance of the CLI.
Public Attributes#
bool
True when a tick is in progress.
const char *
The current command prompt.
bool
The next tick shall write a prompt.
int
The position the user is currently typing to.
int
The total length of the current input.
Keeps track of last input.
sl_slist_node_t *
Base for the command group list.
Function pointer to an alternate command function.
void *
User defined command argument.
void *
Instance session data; own by submodule.
The iostream used by the CLI.
uint32_t
A delay after the CLI task has started before any actions in ticks.
uint32_t
A delay in the CLI task loop in ticks.
Public Attribute Documentation#
input_buffer#
char sl_cli_t::input_buffer[SL_CLI_INPUT_BUFFER_SIZE]
The input buffer.
tick_in_progress#
bool sl_cli_t::tick_in_progress
True when a tick is in progress.
prompt_string#
const char* sl_cli_t::prompt_string
The current command prompt.
req_prompt#
bool sl_cli_t::req_prompt
The next tick shall write a prompt.
input_size#
int sl_cli_t::input_size
Length of input buffer.
input_pos#
int sl_cli_t::input_pos
The position the user is currently typing to.
input_len#
int sl_cli_t::input_len
The total length of the current input.
last_input_type#
sl_cli_input_type_t sl_cli_t::last_input_type
Keeps track of last input.
command_group#
sl_slist_node_t* sl_cli_t::command_group
Base for the command group list.
command_function#
sl_cli_command_function_t sl_cli_t::command_function
Function pointer to an alternate command function.
aux_argument#
void* sl_cli_t::aux_argument
User defined command argument.
session_data#
void* sl_cli_t::session_data
Instance session data; own by submodule.
iostream_handle#
sl_iostream_t* sl_cli_t::iostream_handle
The iostream used by the CLI.
start_delay_tick#
uint32_t sl_cli_t::start_delay_tick
A delay after the CLI task has started before any actions in ticks.
loop_delay_tick#
uint32_t sl_cli_t::loop_delay_tick
A delay in the CLI task loop in ticks.
