【灵动Motor-DK电机控制板】-03串口shell移植

流水源

   上期实现了串口的发送接收数据，本次就利用串口的发送接收移植一些开源的shell框架。
本次移植的是nr_micro_shell和letter_shell这2种，以前也在其他MCU平台移植过，所以本次移植就很容易了。
下面先移植nr_micro_shell.
首先添加nr_micro_shell源码到工程中。添加头文件路径。

然后修改nr_micro_shell的配置文件nr_micro_shell_config.h.主要移植配置如下2个，其他项按需配置。
一个串口printf输出打印，一个串口单字节输出。


先在串口初始化后初始化shell。直接调用nr_micro_shell的初始化函数。
    shell_init();
然后在串口接收处处理串口接收的数据。

1. void shell_usart_loop(void)
   
2. {
   
3.     if(shell_uart_rx.read_i != shell_uart_rx.write_i)
   
4.     {
   
5.         shell(shell_uart_rx.buff[shell_uart_rx.read_i++]);
   
6.         shell_uart_rx.read_i &= 0x7f;
   
7.     }
   
8. }

复制代码

编译成功

下载程序到板上，连接串口。


打开串口助手输入命令查看效果




2、移植letter_shell.
和上面移植差不多，首先下载letter_shell源码，加入到工程中，添加源码的头文件路径。

下面是移植的接口文件代码：
首先是配置文件：

1. /**
   
2. * @file shell_cfg_user.h
   
3. * @author Letter (nevermindzzt@gmail.com)
   
4. * @brief shell config
   
5. * @version 3.0.0
   
6. * @date 2019-12-31
   
7. *
   
8. * @copyright (c) 2019 Letter
   
9. *
   
10. */
    
11. 
    
12. #ifndef __SHELL_CFG_USER_H__
    
13. #define __SHELL_CFG_USER_H__
    
14. 
    
15. #include "stdlib.h"
    
16. #include "main.h"
    
17. 
    
18. #if 0
    
19. #define     SHELL_TASK_WHILE                //是否使用默认shell任务while循环
    
20. #define     SHELL_USING_CMD_EXPORT          //是否使用命令导出方式
    
21. #define     SHELL_USING_COMPANION           //是否使用shell伴生对象功能
    
22. #define     SHELL_SUPPORT_END_LINE          //是否支持shell尾行模式
    
23. #define     SHELL_HELP_LIST_USER            //是否在输入命令列表中列出用户
    
24. #define     SHELL_HELP_LIST_VAR             //是否在输入命令列表中列出变量
    
25. #define     SHELL_HELP_LIST_KEY             //是否在输入命令列表中列出按键
    
26. #define     SHELL_ENTER_LF                  //使用LF作为命令行回车触发
    
27. #define     SHELL_ENTER_CR                  //使用CR作为命令行回车触发
    
28. #define     SHELL_ENTER_CRLF                //使用CRLF作为命令行回车触发
    
29. #define     SHELL_EXEC_UNDEF_FUNC           //使用执行未导出函数的功能
    
30. #define     SHELL_COMMAND_MAX_LENGTH        //shell命令最大长度
    
31. #define     SHELL_PARAMETER_MAX_NUMBER      //shell命令参数最大数量
    
32. #define     SHELL_HISTORY_MAX_NUMBER        //历史命令记录数量
    
33. #define     SHELL_DOUBLE_CLICK_TIME         //双击间隔(ms)
    
34. #define     SHELL_QUICK_HELP                //快速帮助
    
35. #define     SHELL_MAX_NUMBER                //管理的最大shell数量
    
36. #define     SHELL_GET_TICK()                //获取系统时间(ms)
    
37. #define     SHELL_USING_LOCK                //是否使用锁
    
38. #define     SHELL_MALLOC(size)              //内存分配函数(shell本身不需要)
    
39. #define     SHELL_FREE(obj)                 //内存释放函数(shell本身不需要)
    
40. #define     SHELL_SHOW_INFO                 //是否显示shell信息
    
41. #define     SHELL_CLS_WHEN_LOGIN            //是否在登录后清除命令行
    
42. #define     SHELL_DEFAULT_USER              //shell默认用户
    
43. #define     SHELL_DEFAULT_USER_PASSWORD     //默认用户密码
    
44. #define     SHELL_LOCK_TIMEOUT              //shell自动锁定超时
    
45. 
    
46. #endif
    
47. 
    
48. /**
    
49. * @brief 是否使用shell伴生对象
    
50. *        一些扩展的组件(文件系统支持，日志工具等)需要使用伴生对象
    
51. */
    
52. #define     SHELL_USING_COMPANION       1
    
53. 
    
54. 
    
55. /**
    
56. * @brief 支持shell尾行模式
    
57. */
    
58. #define     SHELL_SUPPORT_END_LINE      1
    
59. 
    
60. 
    
61. /**
    
62. * @brief 使用LF作为命令行回车触发
    
63. *        可以和SHELL_ENTER_CR同时开启
    
64. */
    
65. #define     SHELL_ENTER_LF              1
    
66. 
    
67. /**
    
68. * @brief 使用CR作为命令行回车触发
    
69. *        可以和SHELL_ENTER_LF同时开启
    
70. */
    
71. #define     SHELL_ENTER_CR              1
    
72. 
    
73. /**
    
74. * @brief 使用CRLF作为命令行回车触发
    
75. *        不可以和SHELL_ENTER_LF或SHELL_ENTER_CR同时开启
    
76. */
    
77. #define     SHELL_ENTER_CRLF            0
    
78. 
    
79. /**
    
80. * @brief shell格式化输入的缓冲大小
    
81. *        为0时不使用shell格式化输入
    
82. * @note shell格式化输入会阻塞shellTask, 仅适用于在有操作系统的情况下使用
    
83. */
    
84. //#define     SHELL_SCAN_BUFFER          0
    
85. 
    
86. /**
    
87. * @brief 获取系统时间(ms)
    
88. *        定义此宏为获取系统Tick，如`HAL_GetTick()`
    
89. * @note 此宏不定义时无法使用双击tab补全命令help，无法使用shell超时锁定
    
90. */
    
91. //#define     SHELL_GET_TICK()            HAL_GetTick()
    
92. 
    
93. /**
    
94. * @brief 使用锁
    
95. * @note 使用shell锁时，需要对加锁和解锁进行实现
    
96. */
    
97. //#define     SHELL_USING_LOCK            0
    
98. 
    
99. /**
    
100. * @brief shell内存分配
     
101. *        shell本身不需要此接口，若使用shell伴生对象，需要进行定义
     
102. */
     
103. #define     SHELL_MALLOC(size)          malloc(size)
     
104. 
     
105. /**
     
106. * @brief shell内存释放
     
107. *        shell本身不需要此接口，若使用shell伴生对象，需要进行定义
     
108. */
     
109. #define     SHELL_FREE(obj)             free(obj)
     
110. 
     
111. 
     
112. 
     
113. 
     
114. #endif
     
115. 
     
116. 
     
117. 
     

复制代码

下面是接口代码及测试命令：

1. /**
   
2. * @file shell_port.c
   
3. * @author Letter (NevermindZZT@gmail.com)
   
4. * @brief
   
5. * @version 0.1
   
6. * @date 2019-02-22
   
7. *
   
8. * @copyright (c) 2019 Letter
   
9. *
   
10. */
    
11. 
    
12. #include "shell_cfg_user.h"
    
13. #include "platform.h"
    
14. #include "shell.h"
    
15. 
    
16. 
    
17. Shell shell;
    
18. char shellBuffer[512];
    
19. 
    
20. 
    
21. /**
    
22. * @brief 用户shell写
    
23. *
    
24. * @param data 数据
    
25. * @param len 数据长度
    
26. *
    
27. * @return short 实际写入的数据长度
    
28. */
    
29. short userShellWrite(char *data, unsigned short len)
    
30. {
    
31.     for(uint32_t i=0;i<len;i++)
    
32.         stdout_putchar(data[i]);
    
33.     return len;
    
34. }
    
35. 
    
36. 
    
37. /**
    
38. * @brief 用户shell读
    
39. *
    
40. * @param data 数据
    
41. * @param len 数据长度
    
42. *
    
43. * @return short 实际读取到
    
44. */
    
45. short userShellRead(char *data, unsigned short len)
    
46. {
    
47.     uint32_t rlen = 0;
    
48.     for(uint32_t i=0;i<len;i++)
    
49.     {
    
50.         if(shell_uart_rx.read_i != shell_uart_rx.write_i)
    
51.         {
    
52.             data[rlen++] = shell_uart_rx.buff[shell_uart_rx.read_i++];
    
53.             shell_uart_rx.read_i &= 0x7f;
    
54.         }
    
55.     }
    
56.     return rlen;
    
57. }
    
58. 
    
59. /**
    
60. * @brief 用户shell上锁
    
61. *
    
62. * @param shell shell
    
63. *
    
64. * @return int 0
    
65. */
    
66. int userShellLock(Shell *shell)
    
67. {
    
68.     return 0;
    
69. }
    
70. 
    
71. /**
    
72. * @brief 用户shell解锁
    
73. *
    
74. * @param shell shell
    
75. *
    
76. * @return int 0
    
77. */
    
78. int userShellUnlock(Shell *shell)
    
79. {
    
80.     return 0;
    
81. }
    
82. 
    
83. /**
    
84. * @brief 用户shell初始化
    
85. *
    
86. */
    
87. void userShellInit(void)
    
88. {
    
89.     shell.write = userShellWrite;
    
90.     shell.read = userShellRead;
    
91. //    shell.lock = userShellLock;
    
92. //    shell.unlock = userShellUnlock;
    
93.     shellInit(&shell, shellBuffer, 512);
    
94. 
    
95. }
    
96. 
    
97. //测试添加用户：
    
98. SHELL_EXPORT_USER(SHELL_CMD_PERMISSION(0x01), root, 123456, add user);
    
99. 
    
100. 
     
101. //测试添加mian命令
     
102. int func(int argc, char *argv[])
     
103. {
     
104.     printf("%d parameter(s)\r\n", argc);
     
105.     for (char i = 1; i < argc; i++)
     
106.     {
     
107.         printf("%s\r\n", argv[i]);
     
108.     }
     
109.     return  0;
     
110. }
     
111. SHELL_EXPORT_CMD(SHELL_CMD_PERMISSION(0x01)|SHELL_CMD_TYPE(SHELL_TYPE_CMD_MAIN), func, func, test1);
     
112. //letter:/$ func "hello world"
     
113. //2 parameter(s)
     
114. //hello world
     
115. SHELL_EXPORT_CMD(SHELL_CMD_PERMISSION(0x02)|SHELL_CMD_TYPE(SHELL_TYPE_CMD_MAIN), func2, func, test2);
     
116. 
     
117. 
     
118. 
     
119. //测试添加func命令
     
120. int func1(int i, char ch, char *str)
     
121. {
     
122.     printf("input int: %d, char: %c, string: %s\r\n", i, ch, str);
     
123.     return  0;
     
124. }
     
125. SHELL_EXPORT_CMD(SHELL_CMD_PERMISSION(0)|SHELL_CMD_TYPE(SHELL_TYPE_CMD_FUNC), func1, func1, test3);
     
126. //letter:/$ func1 666 'A' "hello world"
     
127. //input int: 666, char: A, string: hello world
     
128. 
     
129. 
     
130. 
     

复制代码

接口初始化shell


主循环处理串口接收的数据：


编译下载查看串口数据：


GPIO_LED_Toggle.zip (3.14 MB, 下载次数: 3)

2023-7-25 18:48 上传

点击文件名下载附件

meiyao

不简单，大佬就是大佬，写个串口都这么秀

yangjiaxu

看着还挺有意思的啊，哈哈，这个micro shell是一般应用在哪儿啊