https://github.com/basilfx/arduino-commandline

No-nonsense serial command line interpreter.
https://github.com/basilfx/arduino-commandline

Last synced: 10 months ago
JSON representation

No-nonsense serial command line interpreter.

• Host: GitHub
• URL: https://github.com/basilfx/arduino-commandline
• Owner: basilfx
• License: mit
• Created: 2013-08-14T01:38:39.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2015-08-02T00:01:53.000Z (almost 11 years ago)
• Last Synced: 2025-04-10T19:56:39.430Z (about 1 year ago)
• Language: C++
• Homepage:
• Size: 116 KB
• Stars: 27
• Watchers: 3
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CommandLine v2.1.0

No-nonsense serial command line interpreter for Arduino.

## Installation

* [Download](https://github.com/basilfx/Arduino-CommandLine/archive/master.zip) or clone this repository to `Arduino/libraries/CommandLine`.

* Restart Arduino IDE.

* Check the examples.

## Howto

A `CommandLine` instance wraps a `Serial` instance. The `CommandLine::update` method should be invoked to run the read, print and eval loop.

Commands can be added with `CommandLine::add` by passing a `Command` structure that takes a command and a callback. Alternatively, you can add a command on-the-fly. In that case, it will allocate memory via `malloc`, but you cannot remove or disable a command afterwards.

A command can be a single word only (no spaces). It will be tokenized using `strtok` using spaces. If an input string matches a command (first match), the attached callback will be invoked with a `char *` to the rest of the arguments (should be parsed using `strtok`).

Basic support for history is added in version 2.1.0.

## Configuration

This library shouldn't be the biggest part of your flash and/or memory footprint. Therefore, several parameters and functions that can be toggled or modified to improve memory usage. Just define them before `CommandLine.h` is included.

* `COMMANDLINE_BUFFER` — number of characters to buffer for one line. Default is 32 characters.

* `COMMANDLINE_COUNT` — number of commands that can be added or remove (including on-the-fly ones). Default is 8.

* `COMMANDLINE_PRE_POST` — if defined, enable support for pre and post callback.

* `COMMANDLINE_HISTORY` — number of commands to keep in history (for up/down key support). Default is 2.

### Note 1

Due to the limitations (or design choices) of the Arduino IDE and its build process, the above defines cannot be overridden when using the Arduino IDE. There are three options:

* Add `CommandLine.cpp` and `CommandLine.h` to your project and modify `CommandLine.h` as desired. Make sure you remove the library from your `Arduino/libraries/` folder.

* Modify the `*.build.extra_flags` property in `boards.txt` to add compiler defines (e.g. `-DCOMMANDLINE_PRE_POST`).

* Use a Makefile to compile your sketch and add the desired defines (e.g. `CXX_FLAGS=-DCOMMANDLINE_PRE_POST`).

### Note 2

Enabling history support may cause memory issues. When enabled, it will allocate `N * COMMANDLINE_BUFFER` bytes, so use with caution.

## License

See the `LICENSE` file (MIT license).