Command Busy.

Definition at line 70 of file ns_cmdline.h.

Command callback function missing.

Definition at line 76 of file ns_cmdline.h.

Command not found.

Definition at line 77 of file ns_cmdline.h.

Command not implemented.

Definition at line 75 of file ns_cmdline.h.

Execution continue in background.

Definition at line 71 of file ns_cmdline.h.

Execution Fail.

Definition at line 73 of file ns_cmdline.h.

Command parameters was incorrect.

Definition at line 74 of file ns_cmdline.h.

Execution Success.

Definition at line 72 of file ns_cmdline.h.

typedef for print functions

Definition at line 82 of file ns_cmdline.h.

typedef for ready cb function

Definition at line 102 of file ns_cmdline.h.

Callback called when your command is run.

Parameters

argc	argc is the count of arguments given in argv pointer list. value begins from 1 and this means that the 0 item in list argv is a string to name of command.
argv	argv is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.

Definition at line 231 of file ns_cmdline.h.

Add command to intepreter.

Parameters

name	command string
callback	This function is called when command line start executing
info	Command short description which is visible in help command, or null if not in use
man	Help page for this command. This is shown when executing command with invalid parameters or command with –help parameter. Can be null if not in use.

Add alias to interpreter.

Aliases are replaced with values before executing a command. All aliases must be started from beginning of line. null or empty value deletes alias.

Parameters

alias	alias name
value	value for alias. Values can be any visible ASCII -characters.

Enter character to console.

insert key pressess to cmdline called from main loop of application

Parameters

u_data

char to be added to console

Configure function, which will be called when Ctrl+A is pressed.

Parameters

sohf	control function which called every time when user input control keys

delete command from intepreter

Parameters

name	command to be delete

Echo off.

Echo on.

Get echo state.

Returns

true if echo is on otherwise false

Command executer.

Command executer, which split&push command(s) to the buffer and start executing commands in cmd tasklet. if not, execute command directly. If command implementation returns CMDLINE_RETCODE_EXCUTING_CONTINUE, executor will wait for cmd_ready() before continue to next command.

Parameters

str	command string, e.g. "help"

Free cmd class.

check if command option is present.

e.g. cmd: "mycmd -c"

Parameters

argc	argc is the count of arguments given in argv pointer list. value begins from 1 and this means that the 0 item in list argv is a string to name of command.
argv	is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.
key	option key to be find

Returns

true if option found otherwise false

Configure command history size (default 32)

Parameters

max	maximum history size max > 0 -> configure new value max = 0 -> just return current value

Returns

current history max-size

Initialize cmdline class.

This is command line editor without any commands. Application needs to add commands that should be enabled. usage e.g.

Parameters

outf	console printing function (like vprintf)

Initialize screen.

Retrieve output mutex lock This can be used to retrieve the output mutex when multiple cmd_printf/cmd_vprintf calls must be guaranteed to be grouped together in a thread safe manner.

Must be released by a following call to cmd_mutex_unlock() For example:

• 1 cmd_mutex_lock();

  2 for (i = 0; i < 10; i++) {

  3  cmd_printf("%02x ", i);

  4 }

  5 // without locking a print from another thread could happen here

  6 cmd_printf("\r\n);

  7 cmd_mutex_unlock();
  Exact behaviour depends on the implementation of the configured mutex, but counting mutexes are required.

Configure mutex wait function By default, cmd_printf calls may not be thread safe, depending on the implementation of the used output.

This can be used to set a callback function that will be called after each cmd_printf call. The specific implementation is up to the application developer, but simple mutex locking is assumed.

Release output mutex lock This can be used to release the output mutex once it has been retrieved with cmd_mutex_lock() Exact behaviour depends on the implementation of the configured mutex, but counting mutexes are required.

Configure mutex wait function By default, cmd_printf calls may not be thread safe, depending on the implementation of the used output.

This can be used to set a callback function that will be called before each cmd_printf call. The specific implementation is up to the application developer, but simple mutex locking is assumed.

execute next command if any

Parameters

retcode

last command return value

Reconfigure default cmdline out function (cmd_printf)

Parameters

outf	select console print function

Refresh output.

find command parameter by key.

if exists, return true, otherwise false. e.g. cmd: "mycmd enable 1"

Parameters

argc	argc is the count of arguments given in argv pointer list. value begins from 1 and this means that the 0 item in list argv is a string to name of command.
argv	is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.
key	parameter key to be find
value	parameter value to be fetch, if key not found value are untouched. "1" and "on" and "true" and "enable" and "allow" are True -value, all others false.

Returns

true if parameter key and value found otherwise false

find command parameter by key and return value (next parameter) in float.

Only whitespaces are allowed in addition to the float to be read. e.g. cmd: "mycmd mykey myvalue"

Parameters

argc	argc is the count of arguments given in argv pointer list. values begin from 1 and this means that the item 0 in the list argv is a string to name of command.
argv	is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.
key	parameter key to be found
value	A pointer to a variable where to write the converted number. If value cannot be converted, it is not touched.

Returns

true if parameter key and a float found, otherwise return false

find command parameter index by key.

e.g.

Parameters

argc	argc is the count of arguments given in argv pointer list. value begins from 1 and this means that the 0 item in list argv is a string to name of command.
argv	is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.
key	option key, which index you want to find out.

Returns

index where parameter was or -1 when not found

find command parameter by key and return value (next parameter) in integer.

Only whitespaces are allowed in addition to the float to be read. e.g. cmd: "mycmd mykey myvalue"

Parameters

argc	argc is the count of arguments given in argv pointer list. value begins from 1 and this means that the item 0 in the list argv is a string to name of command.
argv	is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.
key	parameter key to be found
value	A pointer to a variable where to write the converted number. If value cannot be converted, it is not touched.

Returns

true if parameter key and an integer is found, otherwise return false

Get last command line parameter as string.

e.g. cmd: "mycmd hello world" cmd_parameter_last -> "world" cmd: "mycmd" cmd_parameter_last() -> NULL

Parameters

argc	argc is the count of arguments given in argv pointer list. value begins from 1 and this means that the 0 item in list argv is a string to name of command.
argv	is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.

Returns

pointer to last parameter or NULL when there is no any parameters.

find command parameter by key and return value (next parameter) in int64.

e.g. cmd: "mycmd mykey myvalue"

Supports following formats: number -> direct conversion 11:22:33:44:55:66:77:88 -> converts to number seconds,tics -> converts thread type timestamp to int64

Parameters

argc	argc is the count of arguments given in argv pointer list. value begins from 1 and this means that the 0 item in list argv is a string to name of command.
argv	is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.
key	parameter key to be find
value	parameter value to be fetch, if key not found value are untouched.

Returns

true if parameter key and value found otherwise false

find command parameter by key and return value (next parameter).

if exists, return parameter pointer, otherwise null. e.g. cmd: "mycmd mykey myvalue"

Parameters

argc	argc is the count of arguments given in argv pointer list. value begins from 1 and this means that the 0 item in list argv is a string to name of command.
argv	is list of arguments. List size is given in argc parameter. Value in argv[0] is string to name of command.
key	parameter key to be find
value	pointer to pointer, which will point to cli input data when key and value found. if key or value not found this parameter are untouched.

Returns

true if parameter key and value found otherwise false

command line print function This function should be used when user want to print something to the console

Parameters

fmt	console print function (like printf)

Command ready function for special cases.

This need to be call if command implementation return CMDLINE_RETCODE_EXECUTING_CONTINUE because there is some background stuff ongoing before command is finally completed. Normally there is some event, which call cmd_ready().

Parameters

retcode

return code for command

Request screen size from host Response are stored to variables: COLUMNS and LINES - as integer values.

Note: Require terminal that handle request codes, like screen.

Reset cmdline to default values detach external commands, delete all variables and aliases.

Configure cb which will be called after commands are executed or cmd_ready is called.

Parameters

cb	callback function for command ready

Add Variable to interpreter.

Variables are replaced with values before executing a command. To use variables from cli, use dollar ($) -character so that interpreter knows user want to use variable in that place. null or empty value deletes variable.

Parameters

variable	Variable name, which will be replaced in interpreter.
value	Value for variable. Values can contains white spaces and '"' or '"' characters.

Add integer variable to interpreter.

Variables are replaced with values before executing a command.

Parameters

variable	Variable name, which will be replaced in interpreter.
value	Value for variable

command line print function This function should be used when user want to print something to the console with vprintf functionality

Parameters

fmt	The format string is a character string, beginning and ending in its initial shift state, if any. The format string is composed of zero or more directives.
ap	list of parameters needed by format string. This must correspond properly with the conversion specifier.

default cmd response function, use stdout

Parameters

fmt	The format string is a character string, beginning and ending in its initial shift state, if any. The format string is composed of zero or more directives.
ap	list of parameters needed by format string. This must correspond properly with the conversion specifier.