Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 1017 Bytes

README.md

File metadata and controls

24 lines (15 loc) · 1017 Bytes

CLIant

CLIant is a lib allowing user to call functions with Shell-like command lines. For an embedded bare-metal system target, this can be used to debug/test functions with receiving Shell-like command lines from serial.

CLIant Schema

However some Linux examples are provided in order to quickly try CLIant and better understand the way it works, with named FIFO as input entry for command lines.

Get started

  1. Create your own function on the following model
int myFunction(int argc, char **argv)
  1. Declare a command with 4 parameters : label (the first word of your command line. = argv[0]), a reference to your myFunction, an option description and a global description of the command.

  2. Get input command lines from a serial, a named pipe, ...

  3. Call cmd parse function to parse the command and call the dedicated function.

Examples

Each example directory contains its own README.