letter-shell/README.md

# letter shell

一个体积极小的嵌入式shell

## 移植说明
- letter shell移植过程比较简单，shell.c文件定义了两个__weak函数，分别实现了串口的接收和串口的发送，如果使用shellMain函数，shell阻塞式运行，则需要根据自己的硬件，重写这两个函数
- 如果采用中断方式，则需要实现串口发送的函数，然后在串口中断里执行shellHandler函数
- 如果使用了操作系统，那么需要实现串口发送函数，并将shellHandler交给串口接收的任务进行处理
- 更特殊的情况，如果使用的是STM32，并且使用了HAL库，那么只需要修改shell.h中的shellUart宏即可
- 如果不采用串口使用shell，只需要类似的实现字符的发送和接收就行
## 使用方式
### 命令定义
- letter shell v1.7版本开始，采用了SHELL_EXPORT_CMD宏进行命令定义，可以在任意位置（函数体外）进行定义，类似SHELL_EXPORT_CMD(help, shellShowCommandList, show command list);其中，help为命令，即在命令行输入的指令，shellShowCommandList为相对应的函数，最后一个参数即为命令描述，会显示在help命令中
### 建议终端软件
- 对于基于串口移植，letter shell建议使用secureCRT软件，letter shell中的相关按键映射都是按照secureCRT进行设计的，使用其他串口软件可能会出现某些功能无法使用的情况
## 更新日志
### 2018/4/20   v1.0
- 第一版
### 2018/4/23   v1.1
- 加入对带参命令的支持
### 2018/4/25   v1.2
- 合并带参函数和不带参函数命令表
### 2018/7/10   v1.3
- 修复带参命令最后输入空格时传入参数数量出错的问题
- 修复不带参数调用带参命令时程序跑死的问题，指令处理相关代码优化
- 加入对于输入超出命令长度的情况的处理措施
### 2018/7/11   v1.4
- 新增对于方向键的处理，暂时未对方向键添加具体功能
- 修复单独的空格，制表符等无效操作被识别为指令进行解析，造成程序死机的问题
- 取消制表符作为参数分隔符的用途
### 2018/7/12   v1.5
- 新增历史命令的功能，使用上下方向键操作
- 新增tab键输入最近一条命令
- 无历史记录时，tab键输入help命令
- 新增一条用于清屏的默认指令
### 2018/7/18   v1.6
- 修改tab键功能，加入自动补全
- 无输入情况下，按下tab输入help命令
- 有输入情况下，进行自动补全
### 2018/7/24 v1.7
- 增加SHELL_TypeDef结构体
- 采用新的命令添加方式，现在可以在任意文件的函数 外部采用宏SHELL_EXPORT_CMD进行命令定义
### 2018/7/26 v1.7.1
- 修复不使用带参函数(SHELL_USE_PARAMETER = 0)的情况下，无法匹配命令的问题
- 修复不使用历史命令(SHELL_USE_HISTORY = 0)的情况下，无法使用命令补全的问题