# vtor_shell

**Repository Path**: vtor3478/vtor_shell

## Basic Information

- **Project Name**: vtor_shell
- **Description**: vtor_shell,轻量且强大的单片机调试工具
- **Primary Language**: C
- **License**: LGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2025-02-21
- **Last Updated**: 2025-07-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vtor_shell

#### 介绍
vtor_shell  
VtorShell  
vtor-shell  
由 vtor3478@qq.com 使用纯c语言编写的灵活轻量且强大的单片机调试工具  

视频介绍（20241123）：  
https://www.bilibili.com/video/BV1bgBCYzEWY
知乎介绍文档（20250405）：
https://zhuanlan.zhihu.com/p/1891807768358405702

```
>>> icon  
          __                         __           __ __  
  _   __ / /_ ____   _____    _____ / /_   ___   / // /  
 | | / // __// __ \ / ___/   / ___// __ \ / _ \ / // /   
 | |/ // /_ / /_/ // /      (__  )/ / / //  __// // /    
 |___/ \__/ \____//_/      /____//_/ /_/ \___//_//_/     

<<< return 0 (0x0); // elapsed 0 tick  
```


#### 软件架构
软件架构说明  
```
PS D:\elec\vtor_shell> tree /f  
│  .gitignore  
│  LICENSE                              lgpl开源协议文件  
│  README.en.md  
│  README.md                            本readme文件  
│
├─vtor_shell_core  
│      vtor_shell.c                     核心文件，实现用户交互  
│      vtor_shell.h  
│      vtor_string.c                    核心文件，实现输入输出  
│      vtor_string.h  
│  
├─vtor_shell_sim_vs  
│  │  vtor_shell_sim_vs-20250403.exe    vs工程的可执行文件  
│  │  vtor_shell_sim_vs.sln  
│  │  vtor_shell_sim_vs.vcxproj  
│  │  vtor_shell_sim_vs_main.c  
│  └─vtor_shell_app_sim_vs  
│          vtor_elec_module_config.h    vs工程的vtor_shell模块的配置文件  
│          vtor_shell_demo.c            vs工程的vtor_shell应用文件  
│          vtor_string_app.c            vs工程的vtor_string应用文件  
│  
└─vtor_shell_stm32f1_hal  
    ..........                          忽略其他文件  
    └─vtor_shell_app_stm32f1_hal  
            vtor_elec_module_config.h  stm32工程的vtor_shell模块配置文件  
            vtor_shell_demo.c          stm32工程的vtor_shell应用文件  
            vtor_string_app.c          stm32工程的vtor_string应用文件  
.......  
后续文件与文件夹不再介绍，因为属于具体的工程，而不是vtor_shell的内容  
```


#### 使用说明

1.  复制 vtor_shell_app vtor_shell_core 文件夹到你的工程目录下
2.  打开工程，在工程中添加 包含文件路径 ，添加 源文件到工程中
3.  执行 VtorShell_Init() 函数，初始化vtor_shell，为后续的命令执行做准备
4.  用户在恰当的时间执行 VtorShell_Scan 参数为一个字符串，举例说明：  
    VtorShell_Scan("dev");  打印设备信息（由用户实现）  
    VtorShell_Scan("list");  打印可用命令  
    VtorShell_Scan("help");  打印帮助  
    VtorShell_Scan("icon");  打印vtorshell图标  


#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)