RT-Thread系列09——Finsh自定义命令

====>>> 文章汇总（有代码汇总） <<<====

目标：使用Finsh自定义命令。

• RT-Thread studio，版本: 2.2.6。
• RT-Thread：标准版，4.0.3版本。

Finsh组件是创建工程后就默认开启的，无需任何配置。

1. 无参数命令

对于这种无参数的是最简单的，比如下面的函数，只需要使用MSH_CMD_EXPORT将需要导入的函数名导入就可以了。
格式为：MSH_CMD_EXPORT(函数名，简要介绍)

void no_params_func_test(void)
{
    printf("hello rtthread \n");
}
MSH_CMD_EXPORT(no_params_func_test, no params func test);

然后向串口发送no_params_func_test，即可看到函数执行结果。

2. 带参数命令

首先，带参数的函数定义格式如下，其中参数argc表示命令的参数个数，argv表示具体的参数。

void have_params_func_test(int argc, char **argv)
{
    // 输出参数个数
    rt_kprintf("argc = %d \n", argc);
}
MSH_CMD_EXPORT(have_params_func_test, have params func test);

然后看函数如何判断我们传入了多少个参数。
可以看到，
如果发送：命令，参数个数 = 1。
如果发送：命令+空格+字符串1，参数个数 = 2。
如果发送：命令+空格+字符串1+空格+字符串2，参数个数 = 3。
…
所以我们实际传入的参数实际上是从第二个（索引1）开始的。

2.1. 字符串参数

结论：argv[1]就表示第一个参数的字符串指针，argv[2]就表示第二个参数的字符串指针。。。以此类推，函数中使用时，要先判断函数个数是不是符合预期，然后再做处理。

示例

void str_params_test(int argc, char **argv)
{
    // 输出参数个数
    rt_kprintf("argc = %d \n", argc);

    // 如果有一个参数
    if(argc == 2)
    {
        // 判断第一个参数是不是 OK
        if(!rt_strcmp(argv[1], "ok"))
            rt_kprintf("argv[1] = ok \n");
    }

    // 如果有二个参数
    if(argc == 3)
    {
        // 判断第一个参数是不是 OK
        if(!rt_strcmp(argv[1], "ok"))
            rt_kprintf("argv[1] = ok \n");

        // 判断第二个参数是不是 OK
        if(!rt_strcmp(argv[2], "ok"))
            rt_kprintf("argv[2] = ok \n");
    }
}
MSH_CMD_EXPORT(str_params_test, str params test);

效果如下：

2.2. 数字型参数

跟字符串参数相比，我们只需要将字符串转换为数字类型即可。
这里将字符串转换为整型用的函数是atoi()。
如果是浮点数等类型，自行搜索转换函数。

int int_params_test(int argc, char **argv)
{
    int count1, count2;

    if(argc == 2)
    {
        count1 = atoi(argv[1]);
        rt_kprintf("argc = %d, argv = %d \n", argc, count1);
    }
    else if(argc == 3)
    {
        count1 = atoi(argv[1]);
        count2 = atoi(argv[2]);
        rt_kprintf("argc = %d, argv1 = %d, argv2 = %d \n", argc, count1, count2);
    }
    return 0;
}
MSH_CMD_EXPORT(int_params_test, int params test);

效果如下：

注意：使用函数atoi()，需要打开ilbc组件以使用C语言标准库。