Struct representing an instance of the CLI.
Public Attributes#
The input buffer.
True when a tick is in progress.
The current command prompt.
The next tick shall write a prompt.
Length of input buffer.
The position the user is currently typing to.
The total length of the current input.
Keeps track of last input.
Base for the command group list.
Function pointer to an alternate command function.
User defined command argument.
Instance session data; own by submodule.
The iostream used by the CLI.
A delay after the CLI task has started before any actions in ticks.
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.
142 of file platform/service/cli/inc/sl_cli_types.htick_in_progress#
bool sl_cli_t::tick_in_progress
True when a tick is in progress.
143 of file platform/service/cli/inc/sl_cli_types.hprompt_string#
const char* sl_cli_t::prompt_string
The current command prompt.
144 of file platform/service/cli/inc/sl_cli_types.hreq_prompt#
bool sl_cli_t::req_prompt
The next tick shall write a prompt.
145 of file platform/service/cli/inc/sl_cli_types.hinput_size#
int sl_cli_t::input_size
Length of input buffer.
146 of file platform/service/cli/inc/sl_cli_types.hinput_pos#
int sl_cli_t::input_pos
The position the user is currently typing to.
147 of file platform/service/cli/inc/sl_cli_types.hinput_len#
int sl_cli_t::input_len
The total length of the current input.
148 of file platform/service/cli/inc/sl_cli_types.hlast_input_type#
sl_cli_input_type_t sl_cli_t::last_input_type
Keeps track of last input.
149 of file platform/service/cli/inc/sl_cli_types.hcommand_group#
sl_slist_node_t* sl_cli_t::command_group
Base for the command group list.
150 of file platform/service/cli/inc/sl_cli_types.hcommand_function#
sl_cli_command_function_t sl_cli_t::command_function
Function pointer to an alternate command function.
151 of file platform/service/cli/inc/sl_cli_types.haux_argument#
void* sl_cli_t::aux_argument
User defined command argument.
152 of file platform/service/cli/inc/sl_cli_types.hsession_data#
void* sl_cli_t::session_data
Instance session data; own by submodule.
153 of file platform/service/cli/inc/sl_cli_types.hiostream_handle#
sl_iostream_t* sl_cli_t::iostream_handle
The iostream used by the CLI.
158 of file platform/service/cli/inc/sl_cli_types.hstart_delay_tick#
uint32_t sl_cli_t::start_delay_tick
A delay after the CLI task has started before any actions in ticks.
163 of file platform/service/cli/inc/sl_cli_types.hloop_delay_tick#
uint32_t sl_cli_t::loop_delay_tick
A delay in the CLI task loop in ticks.
164 of file platform/service/cli/inc/sl_cli_types.h