周末在家,闲来无事,顺便把前段时间研究的一个开源代码库的移植案例整理分享出来,希望给大家提供便利。
我移植的MCU是小华HC32F072。
一、开源nr_micro_shell介绍
在进行调试和维护时,常常需要与单片机进行交互,获取、设置某些参数或执行某些操作,nr_micro_shell正是为满足这一需求,针对资源较少的MCU编写的基本命令行工具。
虽然RT_Thread组件中已经提供了强大的finsh命令行交互工具,但对于ROM、RAM资源较少的单片机,finsh还是略显的庞大。在这些平台上,若仍想保留基本的命令行交互功能,nr_micro_shell是一个不错的选择。
nr_micro_shell具有三大优点:
(1)占用资源少,使用简单,灵活方便。使用过程只涉及shell_init()和shell()两个函数,无论使用RTOS,还是裸机,都可以方便的应用该工具,不需要额外的编码工作。
(2)交互体验好。完全类似于linux shell命令行,当串口终端支持ANSI(如Hypertrm终端)时,其不仅支持基本的命令行交互,还提供Tab键命令补全,查询历史命令,方向键移动光标修改功能。
(3)扩展性好。nr_micro_shell为用户提供自定义命令的标准函数原型,只需要按照命令编写命令函数,并注册命令函数,即可使用命令。
nr_micro_shell和相同配置下的finsh (finsh不使用msh)占用资源对比,如下表所示:
原始工程 | 添加nr_micro_shell增加量 | 添加finsh增加量 | |
ROM | 63660 | +3832 | +26908 |
RAM | 4696 | +1104 | +1304 |
代码仓库地址:https://gitee.com/nrush/nr_micro_shell
二、移植步骤
这么优秀的一个代码库,我们又该如何移植呢?如果你学会了移植到某一款MCU上之后,其他MCU都是照葫芦画瓢。
1、使用git工具下载源码到你的工程目录下:
这就需要在自己工程中的串口接收中断函数中添加一个shell(ch);接口函数:
值得注意的是,此接口也可以不放在中断里面哦,也可以放在RTOS中的某个任务里。
(4)万事俱备,只欠东风啦!那是啥呢?聪明的你应该想到了,那就是初始化!调用 shell_init();接口即可。
三、测试验证
四、扩展
那么,如何添加自己的命令呢?源码nr_micro_shell_commands.c中有模板:
我自己添加的cmd如下:
/**
* [url=home.php?mod=space&uid=247401]@brief[/url] ls command
*/
void shell_ls_cmd(char argc, char *argv)
{
unsigned int i = 0;
if (argc > 1)
{
if (!strcmp("cmd", &argv[argv[1]]))
{
for (i = 0; nr_shell.static_cmd[i].fp != NULL; i++)
{
shell_printf("%s",nr_shell.static_cmd[i].cmd);
shell_printf("\r\n");
}
}
else if (!strcmp("-v", &argv[argv[1]]))
{
shell_printf("version date: 20230326.\r\n");
}
else if (!strcmp("-h", &argv[argv[1]]))
{
shell_printf("useage: ls [options]\r\n");
shell_printf("options: \r\n");
shell_printf("\t -h \t: show help\r\n");
shell_printf("\t -v \t: show version\r\n");
shell_printf("\t cmd \t: show all commands\r\n");
}
}
else
{
shell_printf("ls need more arguments!\r\n");
}
}
/*
argc是参数的数目
argv存储每个参数的起始地址和内容
*/
void shell_reboot_cmd(char argc, char *argv)
{
if (!strcmp("reboot", &argv[argv[0]]))
{
shell_printf("MCU Reboot now!!\r\n");
MCU_soft_Reset();
}
}
/*显示各种输入信号的信息*/
void shell_speed_cmd(char argc, char *argv)
{
if (!strcmp("speed", &argv[argv[0]]))
{
shell_printf("\r\n供电电压 = %d (MV) 油量 = %02d%%",Analog.Bat_vol,Analog.Oil_precent);
shell_printf("\r\n轴流滚筒转速 = %d rpm",Drum.Speed);
shell_printf("\r\n割台上下限范围 = [%d - %d]",Getai.Limit_Down_height,Getai.Limit_UP_height);
}
}
/**
* [url=home.php?mod=space&uid=247401]@brief[/url] 显示配置参数
*/
void shell_config_opt_cmd(char argc, char *argv)
{
if (argc > 1)
{
if (!strcmp("erase", &argv[argv[1]]))
{
shell_printf("Erease Flash Sector [250 ~ 254] !!\r\n");
Flash_SectorErase(Sector250_BaseAddr);
Flash_SectorErase(Sector251_BaseAddr);
Flash_SectorErase(Sector253_BaseAddr);
Flash_SectorErase(Sector254_BaseAddr);
Flash_SectorErase(Sector255_BaseAddr);
}
else if (!strcmp("read", &argv[argv[1]]))
{
shell_printf("dump flash config.\r\n");
}
}
else
{
shell_printf("config need another arguments!\r\n");
shell_printf("You can press 'config erase' or 'config read'!\r\n");
}
}
#ifdef NR_SHELL_USING_EXPORT_CMD
NR_SHELL_CMD_EXPORT(ls, shell_ls_cmd);
NR_SHELL_CMD_EXPORT(test, shell_test_cmd);
#else
const static_cmd_st static_cmd[] =
{
{"ls", shell_ls_cmd},
{"config", shell_config_opt_cmd},
{"reboot", shell_reboot_cmd},
{"speed", shell_speed_cmd},
{"\0", NULL}};
#endif
至此,整个移植过程就完美结束啦!
END
→点关注,不迷路←