Awesome

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:

// 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( <command>, (int func)(int argc, char *argv[]), <help>, <man>);
//execute some existing commands
cmd_exe( <command> );

Full API is described here

Configuration

Following defines can be used to configure defaults:

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:

Pre defines return codes

each command should return some of pre-defines return codes. These codes are reserved and used in test tools.

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.

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

//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.

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.