分享一个在STM32H743项目中应用的开源shell --->letter-shell

feelingcode

一个体积极小的嵌入式shell


letter-shell  ：https://github.com/NevermindZZT/letter-shell/issues功能

• 命令自动补全，使用tab键补全命令
• 命令长帮助，使用help [command]显示命令长帮助
• 长帮助补全，输入命令后双击tab键补全命令长帮助指令
• 快捷键，支持使用Ctrl + A~Z组合按键直接调用函数
• shell变量，支持在shell中查看和修改变量值，支持变量作为命令参数
  

还有这个作者 基于C语言的json数据映射解析库  cson : https://github.com/NevermindZZT/cson

简介

CSON是一个简单的cJSON的二次封装，相比于使用原生cJSON一层一层解析的方式，CSON采用模型映射的方式，使用模型将结构体的特征进行描述，然后根据模型，将json数据直接解析成结构体，免去使用原生cJSON需要多次调用API的复杂性，可以很大程度减少代码冗余，增加代码逻辑性。

CSON的模型映射借鉴了高级语言(比如说Java)的反射机制，通过建立数据模型，记录结构体的元素，类型，偏移，然后直接在内存层面进行操作，对C语言提供类似于gson这样的高效json解析工具

eric2013

谢谢楼主分享

gpfrank

谢谢楼主分享。

gpfrank

非常感谢分享。这个正好需要！

JimmyKudo

感谢分享，有用

firedchicken

谢谢分享，6666666666

fang316

感谢!!!!   <2020.08.06 - 14:23>

北海之风

学习学习                                          

morning_enr6U

1. static Shell shell;
   
2. static char shellBuffer[512] __ALIGNED(4) ;
   
3. 
   
4. struct vx_ringbuffer vxRing;
   
5. static vx_uint8_t VxRingBuffer[128] __ALIGNED(4) ;
   
6. 
   
7. static TX_EVENT_FLAGS_GROUP shellEventFlag;
   
8. static volatile uint8_t shellModuleInit_OK = 0;
   
9. //static SemaphoreHandle_t shellMutex;
   
10. 
    
11. /**
    
12. * @brief 用户shell写
    
13. *
    
14. * @param data 数据
    
15. * @param len 数据长度
    
16. *
    
17. * @return short 实际写入的数据长度
    
18. */
    
19. short userShellWrite(char *data, unsigned short len)
    
20. {
    
21.     User_UART_Send(data, len);
    
22.     return len;
    
23. }
    
24. 
    
25. 
    
26. /**
    
27. * @brief 用户shell读
    
28. *
    
29. * @param data 数据
    
30. * @param len 数据长度
    
31. *
    
32. * @return short 实际读取到
    
33. */
    
34. short userShellRead(char *data, unsigned short len)
    
35. {
    
36.     /* 目前，shell的解读任务，一次只能get一个字节，这里忽略参数：len */
    
37.     return vx_ringbuffer_getchar(&vxRing, (vx_uint8_t *)data);
    
38. }
    
39. 
    
40. /**
    
41. * @brief 驱动层接口RingBuffer写函数，将字符设备的接收数据，缓存至RingBuffer
    
42. *        并释放OS Event，通知Shell 线程来解析数据。
    
43. *
    
44. * @param pbuf 字符设备待写入数据
    
45. * @param len 数据长度
    
46. *
    
47. * @return NULL
    
48. */
    
49. void userWriteShellRingbuffer(uint8_t *pbuf, uint16_t len)
    
50. {
    
51.     if(0x55 == shellModuleInit_OK)
    
52.     {
    
53.         vx_ringbuffer_put(&vxRing, pbuf, len);
    
54.         /* release flag to shell task */
    
55.         if (tx_event_flags_set(&shellEventFlag, 0x01, TX_OR) != TX_SUCCESS)
    
56.         {
    
57.             VX_ASSERT(1);
    
58.         }
    
59.     }
    
60. }
    
61. 
    
62. 
    
63. /**
    
64. * @brief 用户shell上锁
    
65. *
    
66. * @param shell shell
    
67. *
    
68. * @return int 0
    
69. */
    
70. int userShellLock(Shell *shell)
    
71. {
    
72.     //xSemaphoreTakeRecursive(shellMutex, portMAX_DELAY);
    
73.     return 0;
    
74. }
    
75. 
    
76. /**
    
77. * @brief 用户shell解锁
    
78. *
    
79. * @param shell shell
    
80. *
    
81. * @return int 0
    
82. */
    
83. int userShellUnlock(Shell *shell)
    
84. {
    
85.     //xSemaphoreGiveRecursive(shellMutex);
    
86.     return 0;
    
87. }
    
88. 
    
89. /**
    
90. * @brief 用户shell初始化
    
91. *
    
92. */
    
93. void userShellInit(void)
    
94. {
    
95.     //shellMutex = xSemaphoreCreateMutex();
    
96. 
    
97.     shell.write = userShellWrite;
    
98.     shell.read = userShellRead;
    
99.     //shell.lock = userShellLock;
    
100.     //shell.unlock = userShellUnlock;
     
101.     shellInit(&shell, shellBuffer, 512);
     
102.     /* user ringBuffer init */
     
103.     vx_ringbuffer_init(&vxRing, VxRingBuffer, 128);
     
104. 
     
105.     /* Create the event flags group.  */
     
106.     if (tx_event_flags_create(&shellEventFlag, "ShellEvent Flag") != TX_SUCCESS)
     
107.     {
     
108.         VX_ASSERT(1);
     
109.     }
     
110. 
     
111.     shellModuleInit_OK = 0x55;
     
112. }
     
113. 
     
114. /**
     
115. * @brief 用户shell线程入口函数，目前ShellTask调用的read()接口，一次解析一个Byte，
     
116. *        而uart驱动层使用了DMA_RX接收控制台串口数据，中间使用RingBuffer来做缓冲，
     
117. *        那么，为了提高效率，在uart驱动层调用RingBuffer写接口（一次可能多个字节）后，
     
118. *        触发OS的预定Event通知userShellThread Task， 此处调用 shellTask；在shellTask
     
119. *        内部，循环读取RingBuffer数据后，退出循环，回到任务主体，重新等待uart驱动层数据。
     
120. *
     
121. * @param NULL
     
122. *
     
123. * @return int 0
     
124. */
     
125. void userShellThread_Entry(ULONG thread_input)
     
126. {
     
127.     ULONG   actual_flags = 0;
     
128. 
     
129.     userShellInit();
     
130. 
     
131.     while(1)
     
132.     {
     
133.         if (tx_event_flags_get(&shellEventFlag, 0x01, TX_OR_CLEAR,
     
134.                                &actual_flags, TX_WAIT_FOREVER) != TX_SUCCESS)
     
135.         {
     
136.             VX_ASSERT(1);
     
137.         }
     
138.         else
     
139.         {
     
140.             shellTask((void *)&shell);
     
141.         }
     
142.     }
     
143. }

复制代码

morning_enr6U

Letter Shell 在ThreadX下，工作的非常不错。AC6 编译环境。

mingliangSui

morning_enr6U 发表于 2021-12-20 20:35

可以给参考一下demo吗

WangYI741

mingliangSui 发表于 2022-10-10 17:30
可以给参考一下demo吗

这是原作者在STM32F407IGHx上移植的例程