Shinichiro Nakamura / MicroShell

Have you tried to develop a key input feature on your small embedded platform with a serial input? It is not so easy to implement correctly because the input methodology is using a complicated protocol known as VT100. In my recent project "Natural Tiny Shell (NT-Shell)" provides VT100 compatible terminal control features for small embedded systems. However, the middleware is still large for small embedded processors such as 8-bit MCUs, 16-bit MCUs and also for small 32-bit MCUs like Cortex-M0. This "MicroShell" middleware provides a minimal terminal control for the platforms.

Dependents:   MicroShellExample

core/microshell.h@0:e91b984e285d, 2017-02-05 (annotated)

Committer:
shintamainjp
Date:
Sun Feb 05 03:55:01 2017 +0000
Revision:
0:e91b984e285d
first commitment.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
shintamainjp 0:e91b984e285d 1 /**
shintamainjp 0:e91b984e285d 2 * @file microshell.h
shintamainjp 0:e91b984e285d 3 * @author Shinichiro Nakamura (CuBeatSystems)
shintamainjp 0:e91b984e285d 4 * ===============================================================
shintamainjp 0:e91b984e285d 5 * MicroShell (Version 0.0.1)
shintamainjp 0:e91b984e285d 6 * Copyright (c) 2016, 2017 Shinichiro Nakamura (CuBeatSystems)
shintamainjp 0:e91b984e285d 7 * ===============================================================
shintamainjp 0:e91b984e285d 8 * The MIT License : https://opensource.org/licenses/MIT
shintamainjp 0:e91b984e285d 9 *
shintamainjp 0:e91b984e285d 10 * Copyright (c) 2016, 2017 Shinichiro Nakamura (CuBeatSystems)
shintamainjp 0:e91b984e285d 11 *
shintamainjp 0:e91b984e285d 12 * Permission is hereby granted, free of charge, to any person
shintamainjp 0:e91b984e285d 13 * obtaining a copy of this software and associated documentation
shintamainjp 0:e91b984e285d 14 * files (the "Software"), to deal in the Software without
shintamainjp 0:e91b984e285d 15 * restriction, including without limitation the rights to use,
shintamainjp 0:e91b984e285d 16 * copy, modify, merge, publish, distribute, sublicense, and/or
shintamainjp 0:e91b984e285d 17 * sell copies of the Software, and to permit persons to whom the
shintamainjp 0:e91b984e285d 18 * Software is furnished to do so, subject to the following
shintamainjp 0:e91b984e285d 19 * conditions:
shintamainjp 0:e91b984e285d 20 *
shintamainjp 0:e91b984e285d 21 * The above copyright notice and this permission notice shall be
shintamainjp 0:e91b984e285d 22 * included in all copies or substantial portions of the Software.
shintamainjp 0:e91b984e285d 23 *
shintamainjp 0:e91b984e285d 24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
shintamainjp 0:e91b984e285d 25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
shintamainjp 0:e91b984e285d 26 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
shintamainjp 0:e91b984e285d 27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
shintamainjp 0:e91b984e285d 28 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
shintamainjp 0:e91b984e285d 29 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
shintamainjp 0:e91b984e285d 30 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
shintamainjp 0:e91b984e285d 31 * OTHER DEALINGS IN THE SOFTWARE.
shintamainjp 0:e91b984e285d 32 */
shintamainjp 0:e91b984e285d 33
shintamainjp 0:e91b984e285d 34 #ifndef MICROSHELL_H
shintamainjp 0:e91b984e285d 35 #define MICROSHELL_H
shintamainjp 0:e91b984e285d 36
shintamainjp 0:e91b984e285d 37 #include "mscore.h"
shintamainjp 0:e91b984e285d 38
shintamainjp 0:e91b984e285d 39 typedef void (*MICROSHELL_UART_PUTC)(char c);
shintamainjp 0:e91b984e285d 40 typedef char (*MICROSHELL_UART_GETC)(void);
shintamainjp 0:e91b984e285d 41 typedef void (*MICROSHELL_ACTION_HOOK)(MSCORE_ACTION action);
shintamainjp 0:e91b984e285d 42
shintamainjp 0:e91b984e285d 43 typedef struct {
shintamainjp 0:e91b984e285d 44 MSCORE mscore;
shintamainjp 0:e91b984e285d 45 MICROSHELL_UART_PUTC uart_putc;
shintamainjp 0:e91b984e285d 46 MICROSHELL_UART_GETC uart_getc;
shintamainjp 0:e91b984e285d 47 MICROSHELL_ACTION_HOOK action_hook;
shintamainjp 0:e91b984e285d 48 } MICROSHELL;
shintamainjp 0:e91b984e285d 49
shintamainjp 0:e91b984e285d 50 #ifdef __cplusplus
shintamainjp 0:e91b984e285d 51 extern "C" {
shintamainjp 0:e91b984e285d 52 #endif
shintamainjp 0:e91b984e285d 53
shintamainjp 0:e91b984e285d 54 void microshell_init(MICROSHELL *handle, MICROSHELL_UART_PUTC uart_putc, MICROSHELL_UART_GETC uart_getc, MICROSHELL_ACTION_HOOK action_hook);
shintamainjp 0:e91b984e285d 55 char *microshell_getline(MICROSHELL *handle, char *buf, int siz);
shintamainjp 0:e91b984e285d 56
shintamainjp 0:e91b984e285d 57 #ifdef __cplusplus
shintamainjp 0:e91b984e285d 58 }
shintamainjp 0:e91b984e285d 59 #endif
shintamainjp 0:e91b984e285d 60
shintamainjp 0:e91b984e285d 61 #endif
shintamainjp 0:e91b984e285d 62
shintamainjp 0:e91b984e285d 63