MicroShell is a lightweight pure C implementation of shell emulator dedicated for embedded bare-metal systems.
Lightweight pure C implementation of virtual shell, compatible with VT100 terminal. Support root tree, run-time mounting paths, global commands, and much more. Works out-of-the-box on Arduino-compatible boards. Dedicated for bare-metal embedded systems. Thanks to the asynchronous architecture it does not block operations and can be easily implemented even on small microcontrollers with relatively small resources.
Project Homepage
LIVE DEMO <- needs PC web browser (not mobile)
In case you didn't use git clone --recursive you'll need to manually pull in additional submodules with:
git submodule update --init
Build, test and run DEMO:
cmake -Bbuild .
cd build
make
make test
make coverage
./bin/demo
Define I/O interface:
// non-blocking read interface
static int ush_read(struct ush_object *self, char *ch)
{
// should be implemented as a FIFO
if (Serial.available() > 0) {
*ch = Serial.read();
return 1;
}
return 0;
}
// non-blocking write interface
static int ush_write(struct ush_object *self, char ch)
{
// should be implemented as a FIFO
return (Serial.write(ch) == 1);
}
// I/O interface descriptor
static const struct ush_io_interface ush_iface = {
.read = ush_read,
.write = ush_write,
};
Define shell descriptor and shell instance:
// working buffers allocations (size could be customized)
#define BUF_IN_SIZE 32
#define BUF_OUT_SIZE 32
#define PATH_MAX_SIZE 32
static char ush_in_buf[BUF_IN_SIZE];
static char ush_out_buf[BUF_OUT_SIZE];
// microshell instance handler
static struct ush_object ush;
// microshell descriptor
static const struct ush_descriptor ush_desc = {
.io = &ush_iface, // I/O interface pointer
.input_buffer = ush_in_buf, // working input buffer
.input_buffer_size = sizeof(ush_in_buf), // working input buffer size
.output_buffer = ush_out_buf, // working output buffer
.output_buffer_size = sizeof(ush_out_buf), // working output buffer size
.path_max_length = PATH_MAX_SIZE, // path maximum length (stack)
.hostname = "arduino", // hostname (in prompt)
};
// root directory handler
static struct ush_node_object root;
Setup and run:
void setup()
{
// initialize I/O interface
Serial.begin(115200UL);
// initialize microshell instance
ush_init(&ush, &ush_desc);
// mount root directory (root must be first)
ush_node_mount(&ush, "/", &root, NULL, 0);
// mount other directories here
// ...
}
void loop()
{
// non-blocking microshell service
ush_service(&ush);
// do other non-blocking stuff here
// ...
}
If You want to contribute this project - excellent! Fork it, make bugs, and send a PR :)
If You want to support me in developing this project - please donate!