Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/PelionIoT/mbed-client-cli

Command Line Interface library for device
https://github.com/PelionIoT/mbed-client-cli

cli interpreter mbed-client-cli

Last synced: 3 months ago
JSON representation

Command Line Interface library for device

Host: GitHub
URL: https://github.com/PelionIoT/mbed-client-cli
Owner: PelionIoT
License: apache-2.0
Created: 2015-08-24T05:10:00.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2021-11-30T13:10:43.000Z (over 2 years ago)
Last Synced: 2024-03-15T16:19:18.849Z (3 months ago)
Topics: cli, interpreter, mbed-client-cli
Language: C
Homepage:
Size: 337 KB
Stars: 16
Watchers: 120
Forks: 13
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

AwesomeInterpreter - mbed-client-cli

README

        # mbed-client-cli

This is the Command Line Library for a CLI application. It uses only ansi C features so it is portable and works in Mbed OS, linux and windows.

## Features

Library provides features such:

* Adding commands to the interpreter.

* Deleting commands from the interpreter.

* Executing commands.

* Adding command aliases to the interpreter.

* Searching command arguments.

* implements several VT100/VT220 features, e.g.

  * move cursor left/right (or skipping word by pressing alt+left/right)

  * delete characters

  * CTRL+W to remove previous word

  * browse command history by pressing up/down

* implements basic commands, e.g.

  * echo

  * help

  * (un)set

  * alias

  * history

  * true/false

  * clear

## API

Command Line Library basic API's is described in the snipplet below:

```c++

// if thread safety for CLI terminal output is needed

// configure output mutex wait cb before initialization so it's available immediately

cmd_set_mutex_wait_func( (func)(void) );

// configure output mutex release cb before initialization so it's available immediately

cmd_set_mutex_wait_func( (func)(void) );

// initialize cmdline with print function

cmd_init( (func)(const char* fmt, va_list ap) );

// configure ready cb

cmd_set_ready_cb( (func)(int retcode)  );

// register command for library

cmd_add( , (int func)(int argc, char *argv[]), , );

//execute some existing commands

cmd_exe(  );

```

Full API is described [here](mbed-client-cli/ns_cmdline.h)

### Configuration

Following defines can be used to configure defaults:

|define|type|default value|description|

|------|----|-------------|-----------|

|`MBED_CONF_CMDLINE_USE_MINIMUM_SET`|bool|false|Use preconfigured minimum build. See more details from below|

|`MBED_CONF_CMDLINE_ENABLE_ALIASES`|bool|true|Enable aliases|

|`MBED_CONF_CMDLINE_USE_DUMMY_SET_ECHO_COMMANDS`|bool|true|Enable dummy `set` and `echo` commands|

|`MBED_CONF_CMDLINE_INIT_AUTOMATION_MODE`|bool|false|Enable automation mode during initalize phase|

|`MBED_CONF_CMDLINE_ENABLE_ESCAPE_HANDLING`|bool|true|Enable escape handling|

|`MBED_CONF_CMDLINE_ENABLE_OPERATORS`|bool|true|Enable operators. E.g. `echo abc && echo def`|

|`MBED_CONF_CMDLINE_ENABLE_INTERNAL_COMMANDS`|bool|true|Enable internal commands. E.g. `echo`|

|`MBED_CONF_CMDLINE_ENABLE_INTERNAL_VARIABLES`|bool|true|Enable internal variables|

|`MBED_CONF_CMDLINE_BOOT_MESSAGE`|C string|`ARM Ltd\r\n`|default boot message|

|`MBED_CONF_CMDLINE_MAX_LINE_LENGTH`|int|2000|maximum command line length|

|`MBED_CONF_CMDLINE_ARGS_MAX_COUNT`|int|30|maximum count of command arguments|

|`MBED_CONF_CMDLINE_ENABLE_HISTORY`|bool|true|Enable command history. browsable using key up/down|

|`MBED_CONF_CMDLINE_HISTORY_MAX_COUNT`|int|32|maximum history size|

|`MBED_CONF_CMDLINE_INCLUDE_MAN`|bool|true|Include man pages|

|`MBED_CONF_CMDLINE_ENABLE_INTERNAL_TRACES`|bool|false|Enable cli internal traces|

|`MBED_CONF_CMDLINE_ENABLE_DEEP_INTERNAL_TRACES`|bool|false|Enable cli deep internal traces|

#### Minimize footprint

To reduce required flash and RAM usage there is pre-defined profile which can be enabled by using precompiler variable:

`MBED_CONF_CMDLINE_USE_MINIMUM_SET=1`

This switch off most of features and reduce buffer sizes. Below is whole configueration:

|define|value|

|------|----|

|`MBED_CONF_CMDLINE_ENABLE_ALIASES`|false|

|`MBED_CONF_CMDLINE_USE_DUMMY_SET_ECHO_COMMANDS`|false|

|`MBED_CONF_CMDLINE_INIT_AUTOMATION_MODE`|false|

|`MBED_CONF_CMDLINE_ENABLE_ESCAPE_HANDLING`|false|

|`MBED_CONF_CMDLINE_ENABLE_OPERATORS`|false|

|`MBED_CONF_CMDLINE_ENABLE_INTERNAL_COMMANDS`|false|

|`MBED_CONF_CMDLINE_ENABLE_INTERNAL_VARIABLES`|false|

|`MBED_CONF_CMDLINE_MAX_LINE_LENGTH`|100|

|`MBED_CONF_CMDLINE_ARGS_MAX_COUNT`|10|

|`MBED_CONF_CMDLINE_ENABLE_HISTORY`|false|

|`MBED_CONF_CMDLINE_INCLUDE_MAN`|false|

### Pre defines return codes

each command should return some of pre-defines return codes.

These codes are reserved and used in test tools.

|define|description|

|------|-----------|

|`CMDLINE_RETCODE_COMMAND_BUSY`|Command Busy|

|`CMDLINE_RETCODE_EXCUTING_CONTINUE`|Execution continue in background|

|`CMDLINE_RETCODE_SUCCESS`|Execution Success|

|`CMDLINE_RETCODE_FAIL`|Execution Fail|

|`CMDLINE_RETCODE_INVALID_PARAMETERS`|Command parameters was incorrect|

|`CMDLINE_RETCODE_COMMAND_NOT_IMPLEMENTED`|Command not implemented|

|`CMDLINE_RETCODE_COMMAND_CB_MISSING`|Command callback function missing|

|`CMDLINE_RETCODE_COMMAND_NOT_FOUND`|Command not found|

## Tracing

Command Line Library has trace messages, which are disabled by default.

`MBED_CONF_CMDLINE_ENABLE_INTERNAL_TRACES` flag if defined, enables all the trace prints for debugging.

## Usage example

See full examples [here](example).

###

Adding new commands to the Command Line Library and executing the commands:

```c++

//example print function

void myprint(const char* fmt, va_list ap){ vprintf(fmt, ap); }

// ready cb, calls next command to be executed

void cmd_ready_cb(int retcode) { cmd_next( retcode ); }

// dummy command with some option

int cmd_dummy(int argc, char *argv[]){

  if( cmd_has_option(argc, argv, "o") ) {

    cmd_printf("This is o option");

  } else {

        return CMDLINE_RETCODE_INVALID_PARAMETERS;

  }

  return CMDLINE_RETCODE_SUCCESS;

}

// timer cb (pseudo-timer-code)

void timer_ready_cb(void) {

   cmd_ready(CMDLINE_RETCODE_SUCCESS);

}

// long command, that needs for example some events to complete the command execution

int cmd_long(int argc, char *argv[] ) {

   timer_start( 5000, timer_ready_cb ); //pseudo timer code

   return CMDLINE_RETCODE_EXCUTING_CONTINUE;

}

void main(void) {

   cmd_init( &myprint );              // initialize cmdline with print function

   cmd_set_ready_cb( cmd_ready_cb );  // configure ready cb

   cmd_add("dummy", cmd_dummy, 0, 0); // add one dummy command

   cmd_add("long", cmd_long, 0, 0);   // add one dummy command

   //execute dummy and long commands

   cmd_exe( "dummy;long" );

}

```

## Thread safety

The CLI library is not thread safe, but the CLI terminal output can be locked against other

output streams, for example if both traces and CLI output are using serial out.

Thread safety example for Mbed OS is available [here](example/Mbed-OS/main.cpp).

## Unit tests

Unit tests are available in the `./test` folder. To run the unit tests in linux environment:

```

cd test

./run_unit_tests.sh

```

Unit tests xml output will be generated to folder: `test/build`.

Code coverage report can be found from: `./test/build/html/coverage_index.html`.