Shellminator is a simple-to-use terminal interface library. You can use it with any VT-100 terminal emulator like PuTTY, Terraterm or minicom. With this library, you can create user-friendly command line interfaces for your embedded projects. Shellminator has command history support, that means you can browse your previous commands with the arrow keys on the keyboard. The library is Arduino compatible out of the box, but if you want to use it with other platforms, you can do that in Shellminator-IO source files.

Key changes in V1.2:

New shortcut keys.
Option to set the timeout of the internal client.
Advanced search functions( Ctrl-R, Page-Up, Page-Down )
Banner text change option.
Path text change option. Also change it to blue color
Websocket channel
Terminal buzzer command, with mute option
QR-code generation
History command
Help command

Breaking changes in V1.2:

The response channel is now uses the Stream class. This way it is more flexible and you doesn't have to create a class for every peripheral.

Installing

Shellminator is available as library for both PlatformIO and Arduino IDE.

For more advanced cases such as custom commands you should add CommanderAPI, also available from the libraries or at this location: https://github.com/dani007200964/Commander-API

Running

The examples folder contains example instructions for learning how to run and use Shellminator. Support for WiFi and Serial is included. For more advanced command examples look at https://github.com/dani007200964/Commander-API/tree/master/examples

Those advanced examples include commands for changing/reading the pins and scanning WiFi networks that are available.

Donation

If this project help you reduce time to develop, you can give me a cup of coffee ☕ ☕ ☕

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License & copyright

📧 hajna.nosp@m.l.da.nosp@m.niel9.nosp@m.6@gm.nosp@m.ail.c.nosp@m.om

Licensed under the MIT License.