适用stm32的命令行解释器shell

记录一下这个shell的应用说明

源码的地址:
https://gitee.com/somebug/atomlib
shell 层与硬件无关,有无操作系统都可以使用,适用于stm32等32位小端的单片机,支持历史纪录功能,tab 键补全命令,提供命令行参数解释函数,可以响应tab、backspace、上下左右编辑等功能,并提供一个简易版的vi 文本编辑功能。支持多交互接口,各个接口间数据流互不影响。
其中此文件夹中的文件都与硬件平台无关,但可能与编译平台有关。此库编译版本要在C99以上,或用GCC编译。根据不同的硬件平台分别写了不同的控制台demo, F1 文件夹的是STM32F1 相关的控制台, F4 则是 F4xx 系列的控制台,但是L1平台的我并没有调通,手上也没有这个板子,所以先放着。

文件说明:
avltree.c :平衡二叉树相关实现代码,在注册命令较多的时候可以启用平衡二叉树进行索引匹配。
getopt.c :有些编译环境,如 KEIL5 中,没有函数getopt() ,这是其源码,是我在网上找的。要是用 gcc 相关的编译平台可以 #include <unistd.h> 找到 getopt() 函数支持。
heaplib.c : 内存管理,其实这个是我原封不动从freertos 的 heap_4.c 拷过来的,在heaplib.h 提供了部分宏支持,可以脱离操作系统使用。
shell.c:命令行相关,支持 table 键补全,支持上下左右箭头响应,提供参数解析,历史纪录。支持多个交互,如串口,telnet,或者usb,可各自建立交互。
tasklib.c:协程控制器。有需要的话使用协程可以简化代码的编写。我把它模拟成一个操作系统。
ustdio.c:提供 printk 函数,重定义 printf 函数
vim.c:这是我仿照 linux 的 vi 写的一个建议的文本编辑器,依赖 shell ,可以实现简易的文本编辑。
F1/F4/L1:不同硬件平台的相关串口控制台实现,提供串口在线升级功能。
LittleFS: LittleFS 是一个用于 spi flash 的文件系统,先放这。

基本使用

使用这个库的基本功能只需要把 shell.c 、shell.h 、ustdio.c 、ustdio.h 和 kernel.h 这几个文件包含进文件工程里面即可。系统的使用可以大致分为以下几个步骤:
0.初始化硬件部分。
1.编写硬件对应的void puts(char * buf , uint16_t len) 发送函数。
2.shell_init(sign,puts)初始化输入标志和默认输出。
3.新建一个交互shellx 并初始化shell_input_init(&shellx,puts);
4.接收到一包数据后,调用shell_input(&shellx,buf,len)
以下用stm32cubemx新建串口工程实际说明。Mcu选择为STM32F103VET6;
配置 SYS -> DEBUG 为 Serial Wire :
sysopt
配置 RCC -> HSE 为 Crystal

内置 "cmd-list" 命令获取所有命令列表 支持 tab 键补全命令 支持 backspace 回退,这个在 putty 上有 bug ,还没修复。在secureCRT正常。 支持上下箭头回溯历史,这个功能没有做的很好; 支持左右箭头编辑当前命令行输入; 提供 shell_cmdparam()函数转换命令后所跟的数字参数(字符串转整型),详见 demo 提供 shell_option_suport() 函数,使命令行支持 getopt()函数,详见 demo 系统共有9个文件,全部与硬件无关,编译语言要在 C99 以上(keil 在 project -> Options .. -> c/c++ -> C99 勾上) kernel.h // 一些必要的宏定义 shell.c,shell.h //具体的命令行解释的实现 ustdio.c,ustdio.h //非标准输出文件,重新链接 printf ,并提供一个小巧型的 printk 函数 avltree.c,avltree.h //平衡二叉树支持,shell 默认用链表建立查询机制,有必要可在shell.h 中开启二叉树 getopt.c,getopt.h //网上找的 getopt() 源码 除了 getopt.c,getopt.h 两个文件是我从网上找的源码,主要实现命令行的 getopt()解析,其他的都是笔者所写。 使用: 1,首先把 shell.c ustdio.c 加入工程,这两个文件是必须的。 如果不用 getopt()函数可以不添加getopt.c文件。 shell默认使用链表来构建查询系统,但也提供了平衡二叉树的方式,在shell.h中有开启的开关,如不需要可以不添加avltree.c。 include "shell.h" 2,先对硬件进行基本的初始化。 撰写串口发送函数,形如 void usart_puts(char * str , uint16_t len) ; 调用函数 shell_init("shell >",usart_puts); //初始化shell的输入标志和默认输出指向 串口接收以包为单位。 3,新建全局变量 struct shell_input serial_shell ; 并初始化 SHELL_INPUT_INIT(&serial;_shell ,usart_puts);初始化输入缓存和输出交互; 4,串口接收到一整包函数后,调用 shell_input(&serial;_shell , packet , pktlen) ;
评论 15
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值