CN111443915B - 一种在单片机上实现cli命令界面的方法和系统 - Google Patents

Abstract

本发明提出了一种在单片机上实现CLI命令界面的方法，首先定义全局变量CLI_SCAN和调用功能函数信息记录结构体USRCMD_PARA_STRUCT。然后接收用户登录的信息；识别从键盘输入的中断读取字符并输出处理信息；根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回；响应动作，执行动作匹配的功能函数，输出结果；将命令添加到历史命令。基于该方法，还提出在单片机上实现CLI命令界面的系统，本发明能够实现的辅助功能包括设置用户权限，支持TAB键或？命令补全、查看历史命令等。实现一个命令行界面的人机交互接口，使嵌入式单片机的配置、管理和测试更加高效以及脚本自动化。

Description

一种在单片机上实现CLI命令界面的方法和系统

技术领域

本发明属于一种嵌入式设备命令行界面管理技术领域，特别涉及一种在单片机上实现CLI命令界面的方法和系统。

背景技术

命令行界面CLI是一种以文本模式与设备进行交互的方式，该程序允许用户键入指示计算机执行特定任务的文本命令，CLI包含多个组件：用户输入/输出，命令行编辑，历史命令，完成的命令，输入解析、参数验证和命令调度/执行，错误处理和报告。CLI对系统要求较低,在嵌入式系统中更适用；并且有更高的执行效率，只需键入一些字符就可完成对设备的配置和管理。

在现有技术中，还没有针对单片机设置命令行界面的人机交互接口，导致单片机的配置、测试和管理繁琐复杂，也不能够实现脚本自动化。

发明内容

本发明提出了一种在单片机上实现CLI命令界面的方法和系统，在单片机上实现一个命令行界面的人机交互接口，使嵌入式单片机的配置、管理和测试更加高效便捷以及脚本自动化，解决现有技术中单片机不足的问题。

为了实现上述目的，本发明提出了一种在单片机上实现CLI命令界面的方法，该方法包括以下步骤：

接收用户登录的信息；

识别从键盘输入的中断读取字符并输出处理信息；

根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回；

响应动作，执行动作匹配的功能函数，输出结果；

将执行过的命令添加到历史命令。

进一步的，在执行所述方法之前还包括：

定义全局变量CLI_SCAN，用来描述CLI的session窗口，记录一次启动的信息；

定义调用功能函数信息记录结构体USRCMD_PARA_STRUCT，将输入命令解析后的关键字和CLIMAP中获取的信息整合，便于之后的调用和结果输出。

进一步的，所述接收用户登录的信息时，首先判断用户名是否有效，如果用户名无效或者输入密码错误均返回error；密码正确则隐藏输出；

其中用户名根据权限定义为：debug、admain和guest；Debug用户权限最高，每次登录的密码需要单独由密码生成函数根据设定的算法生成；admain的用户密码和guest的用户密码均在login_users结构体中定义，或者输入pass命令自行修改。

进一步的，所述识别从键盘输入的中断读取字符并输出处理信息包括：

首先设置超时阈值，如果超过阈值无输入则退出并重新登录；

然后识别并判断从键盘输入的中断读取字符，如果输入的是转义字符,输出escSequences结构体定义的转义字符部分；如果无输入或者无效字符，则返回0；

正常字符则直接返回。

进一步的，所述根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回包括：

输出的处理信息为"\n"时，返回ACTION_CMD；

以escSequences结构体定义的内容结束时，直接移动光标到指定位置，返回ACTION_NONE；

读取到backspace键，删除前一个字符；

读取到正常的字符,插入到cmd_line中光标的位置,后面的字符后移，如果超出cmd_line长度,丢弃最后一个字符，光标再回到原来的位置的下一个字符；

读取到"t"、"？"，返回"(UINT32)？"。

进一步的，所述响应动作，执行动作匹配的功能函数，输出结果包括：

如果动作为辅助功能，查看历史命令、tab键或？直接调用相应的功能函数显示结果；

如果动作为ACTION_CMD，则解析输入命令，分解成关键字段，利用关键字查找在历史命令map中匹配的命令；匹配成功后，检查命令的权限，有权限，则调用该命令对应的底层功能函数，无则返回"NO PERMISSION！"；匹配失败则返回"No match command，Pleasecheck your syntax"。

进一步的，所述如果动作为ACTION_CMD，则解析输入命令，分解成关键字段的方法为：

搜索命令行中分隔符，获取后面的tokens；

将命令行以关键字数组方式存储，返回关键字个数。

进一步的，所述利用关键字查找在历史命令map中匹配的命令的方法时，首先定义CLIMAP结构体，其中定义的内容包括：命令等级，命令行，关键字数组，关键字个数，调用的功能函数。

本发明实施例还提出了一种在单片机上实现CLI命令界面的系统，包括接收登录信息模块、识别字符模块、执行动作模块、响应模块和添加模块；

所述接收登录信息模块用于接收用户登录的信息，

所述识别字符模块用于识别从键盘输入的中断读取字符并输出处理信息；

所述执行动作模块根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回；

所述响应模块用于响应动作，执行动作匹配的功能函数，输出结果；

所述添加模块用于将执行过的命令添加到历史命令。

进一步的，所述系统还包括第一定义模块和第二定义模块；

所述第一定义模块用于定义全局变量CLI_SCAN，用来描述CLI的session窗口，记录一次启动的信息；

所述第二定义模块用于定义调用功能函数信息记录结构体USRCMD_PARA_STRUCT，将输入命令解析后的关键字和CLIMAP中获取的信息整合，便于之后的调用和结果输出。

发明内容中提供的效果仅仅是实施例的效果，而不是发明所有的全部效果，上述技术方案中的一个技术方案具有如下优点或有益效果：

本发明实施例提出了一种在单片机上实现CLI命令界面的方法，该方法首先定义全局变量CLI_SCAN，用来描述CLI的session窗口，记录一次启动的信息；定义调用功能函数信息记录结构体USRCMD_PARA_STRUCT，将输入命令解析后的关键字和CLIMAP中获取的信息整合，便于之后的调用和结果输出。然后单片机接收用户登录的信息；识别从键盘输入的中断读取字符并输出处理信息；根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回；响应动作，执行动作匹配的功能函数，输出结果；将执行过的命令添加到历史命令。基于本发明提出的一种在单片机上实现CLI命令界面的方法，还提出了一种在单片机上实现CLI命令界面的系统，本发明能够实现的辅助功能包括设置用户权限，支持TAB键或？命令补全、查看历史命令以及“help”指令。通过本发明能够实现一个命令行界面的人机交互接口，使嵌入式单片机的配置、管理和测试更加高效便捷以及脚本自动化。

附图说明

如图1给出了本发明实施例1一种在单片机上实现CLI命令界面的方法流程图；

如图2给出了本发明实施例1一种在单片机上实现CLI命令界面的系统结构图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

实施例1

本发明实施例1提出了一种在单片机上实现CLI命令界面的方法，能够实现一个命令行界面的人机交互接口，如图1所示给出一种在单片机上实现CLI命令界面的方法流程图。

在步骤S101中，首先定义全局变量CLI_SCAN，用来描述CLI的session窗口，记录一次启动的信息；将来可以增加目的IP和端口等属性后通用于telnet。

具体的内容为：

typedef struct

{

UINT32 key；/*get_input时使用暂存输入的每个字符*/

int cmd_len；/*cmd_input使用指向cmd_line的最终长度位置*/

int cur_pos；/*cmd_input指向当前光标位置*/

int login_level；/*登录级别*/

char login_name[MAX_NAME_LEN]；

char login_password[MAX_PASSWORD_LEN]；//暂存输入密码

char cmd_line[CMD_LINE_LENGTH]；

char cmd_tmp[CMD_LINE_LENGTH]；/*暂存cmd_line,因为经过line2tokens后,cmd_line会被破坏掉*/

char*cmd_tokens[CLI_CMD_MAX_TOKENS]；

char retInfo[CLI_CMD_MAX_RETINFO_LEN]；

char hist_cmd_table[CLI_MAX_HIST_CMD_NUM][CMD_LINE_LENGTH]；//存放历史命令的数组表

int hist_cmd_num；/*记录历史命令行*/

int hist_cmd_curr；/*记录当前命令行*/

}CLI_SCRN。

定义调用功能函数信息记录结构体USRCMD_PARA_STRUCT，将输入命令解析后的关键字和CLIMAP中获取的信息整合，便于之后的调用和结果输出。若是匹配到功能函数，该调用的信息会存储在结构体USRCMD_PARA_STRUCT中，具体的内容为：

typedef struct usrcmd_para_struct

{

cli_func this；/*指向本函数*/

BOOL firstin；/*是否第一次调用此函数*/

unsigned char argc；

char**argv；

char*retInfo；/*函数返回的信息*/

}USRCMD_PARA_STRUCT。

定义可执行的命令信息结构体，通过结构体可调用底层功能函数，内容如下：

typedef struct

{

priv_t level；

char*cmd；

char*keyWords[CLI_CMD_MAX_KEYWORDS]；

unsigned char keyWMin；

cli_func func；

}CLICMDMAP。

在步骤S102中，单片机接收用户登录的信息；首先判断用户名是否有效，如果用户名无效或者输入密码错误均返回error；密码正确则隐藏输出，密码显示为*。

其中用户名根据权限定义为：debug、admain和guest；Debug用户权限最高，每次登录的密码需要单独由密码生成函数根据设定的算法生成；admain的用户密码和guest的用户密码均在login_users结构体中定义，或者输入pass命令自行修改。

在步骤S103中，识别从键盘输入的中断读取字符并输出处理信息；首先设置超时阈值，如果超过阈值无输入则退出并重新登录；然后识别并判断从键盘输入的中断读取字符，如果输入的是转义字符,输出escSequences结构体定义的转义字符部分；如果无输入或者无效字符，则返回0；正常字符则直接返回。

在步骤S104中，根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回；

输出的处理信息为"\n"时，返回ACTION_CMD；以escSequences结构体定义的内容结束时，直接移动光标到指定位置，返回ACTION_NONE；读取到backspace键，删除前一个字符；读取到正常的字符,插入到cmd_line中光标的位置,后面的字符后移，如果超出cmd_line长度,丢弃最后一个字符，光标再回到原来的位置的下一个字符；读取到"t"、"？"，返回"(UINT32)？"。

在步骤S105中，响应动作，执行动作匹配的功能函数，输出结果；如果动作为辅助功能，查看历史命令、tab键或？直接调用相应的功能函数显示结果；

如果动作为ACTION_CMD，则解析输入命令，分解成关键字段，利用关键字查找在历史命令map中匹配的命令；匹配成功后，检查命令的权限，有权限，则调用该命令对应的底层功能函数，无则返回"NO PERMISSION！"；匹配失败则返回"No match command，Pleasecheck your syntax"。

其中，如果动作为ACTION_CMD，则解析输入命令，分解成关键字段的方法为：搜索命令行中分隔符，获取后面的tokens；将命令行以关键字数组方式存储，返回关键字个数。

另外，利用关键字查找在历史命令map中匹配的命令的方法时，首先定义CLIMAP结构体，其中定义的内容包括：命令等级，命令行，关键字数组，关键字个数，调用的功能函数；原则上寻找命令体内常用的命令在前，调试命令在后；匹配时查询完毕整个命令CLIMAP结构,而不是遇到0结束。

在步骤S106中，判断命令是否重复，如果没有重新，则执行步骤S107；如果重复，则执行步骤S108。

在步骤S107中，将执行过的命令添加到历史命令。其中历史命令以map表的形式，超过数组表存放最大数(10)后，从表内第二行历史命令起将其位置依次向前移一行；将当前命令存放在数组表的最后一行。

在步骤S108中，舍弃重复的命令。

基于本发明提出的一种在单片机上实现CLI命令界面的方法，还提出了一种在单片机上实现CLI命令界面的系统，如图2给出了一种在单片机上实现CLI命令界面的系统结构图，该系统包括第一定义模块、第二定义模块、接收登录信息模块、识别字符模块、执行动作模块、响应模块和添加模块。

第一定义模块用于定义全局变量CLI_SCAN，用来描述CLI的session窗口，记录一次启动的信息。

第二定义模块用于定义调用功能函数信息记录结构体USRCMD_PARA_STRUCT，将输入命令解析后的关键字和CLIMAP中获取的信息整合，便于之后的调用和结果输出。

接收登录信息模块用于接收用户登录的信息。

识别字符模块用于识别从键盘输入的中断读取字符并输出处理信息。

执行动作模块根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回。

响应模块用于响应动作，执行动作匹配的功能函数，输出结果。

添加模块用于将执行过的命令添加到历史命令。

内容仅仅是对本发明的结构所作的举例和说明，所属本技术领域的技术人员对所描述的具体实施例做各种各样的修改或补充或采用类似的方式替代，只要不偏离发明的结构或者超越本权利要求书所定义的范围，均应属于本发明的保护范围。

Claims (8)

1.一种在单片机上实现CLI命令界面的方法，其特征在于，包括以下步骤：

接收用户登录的信息；

识别从键盘输入的中断读取字符并输出处理信息；

根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回；

响应动作，执行动作匹配的功能函数，输出结果；

将执行过的命令添加到历史命令；

在执行所述方法之前还包括：

定义全局变量CLI_SCAN，用来描述CLI的session窗口，记录一次启动的信息；

定义调用功能函数信息记录结构体USRCMD_PARA_STRUCT，将输入命令解析后的关键字和CLIMAP中获取的信息整合，便于之后的调用和结果输出。

2.根据权利要求1所述的一种在单片机上实现CLI命令界面的方法，其特征在于，所述接收用户登录的信息时，首先判断用户名是否有效，如果用户名无效或者输入密码错误均返回error；密码正确则隐藏输出；

其中用户名根据权限定义为：debug、admain和guest；Debug用户权限最高，每次登录的密码需要单独由密码生成函数根据设定的算法生成；admain的用户密码和guest的用户密码均在login_users结构体中定义，或者输入pass命令自行修改。

3.根据权利要求1所述的一种在单片机上实现CLI命令界面的方法，其特征在于，所述识别从键盘输入的中断读取字符并输出处理信息包括：

首先设置超时阈值，如果超过阈值无输入则退出并重新登录；

然后识别并判断从键盘输入的中断读取字符，如果输入的是转义字符,输出escSequences结构体定义的转义字符部分；如果无输入或者无效字符，则返回0；

正常字符则直接返回。

4.根据权利要求1所述的一种在单片机上实现CLI命令界面的方法，其特征在于，所述根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回包括：

输出的处理信息为"\n"时，返回ACTION_CMD；

以escSequences结构体定义的内容结束时，直接移动光标到指定位置，返回ACTION_NONE；

读取到backspace键，删除前一个字符；

读取到正常的字符,插入到cmd_line中光标的位置,后面的字符后移，如果超出cmd_line长度,丢弃最后一个字符，光标再回到原来的位置的下一个字符；

读取到"t"、"？"，返回"(UINT32)？"。

5.根据权利要求1所述的一种在单片机上实现CLI命令界面的方法，其特征在于，所述响应动作，执行动作匹配的功能函数，输出结果包括：

如果动作为辅助功能，查看历史命令、tab键或？直接调用相应的功能函数显示结果；

如果动作为ACTION_CMD，则解析输入命令，分解成关键字段，利用关键字查找在历史命令map中匹配的命令；匹配成功后，检查命令的权限，有权限，则调用该命令对应的底层功能函数，无则返回"NO PERMISSION！"；匹配失败则返回"No match command，Please checkyour syntax"。

6.根据权利要求5所述的一种在单片机上实现CLI命令界面的方法，其特征在于，所述如果动作为ACTION_CMD，则解析输入命令，分解成关键字段的方法为：

搜索命令行中分隔符，获取后面的tokens；

将命令行以关键字数组方式存储，返回关键字个数。

7.根据权利要求5所述的一种在单片机上实现CLI命令界面的方法，其特征在于，所述利用关键字查找在历史命令map中匹配的命令的方法时，首先定义CLIMAP结构体，其中定义的内容包括：命令等级，命令行，关键字数组，关键字个数，调用的功能函数。

8.一种在单片机上实现CLI命令界面的系统，其特征在于，包括接收登录信息模块、识别字符模块、执行动作模块、响应模块和添加模块；

所述接收登录信息模块用于接收用户登录的信息，

所述识别字符模块用于识别从键盘输入的中断读取字符并输出处理信息；

所述执行动作模块根据输出的处理信息，读取整条命令输出结果符；根据结果符，判断下一步执行的动作类型并返回；

所述响应模块用于响应动作，执行动作匹配的功能函数，输出结果；

所述添加模块用于将执行过的命令添加到历史命令；

所述系统还包括第一定义模块和第二定义模块；

所述第一定义模块用于定义全局变量CLI_SCAN，用来描述CLI的session窗口，记录一次启动的信息；

所述第二定义模块用于定义调用功能函数信息记录结构体USRCMD_PARA_STRUCT，将输入命令解析后的关键字和CLIMAP中获取的信息整合，便于之后的调用和结果输出。

Images