software/x-tools
1
0
Fork 0
mirror of https://github.com/x-tools-author/x-tools.git synced 2025-09-15 15:28:40 +08:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
wuuhii 2020-04-27 19:26:31 +08:00
parent 6a3e304843
commit d9b05b6d22
2 changed files with 19 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -1,41 +1,26 @@
# "Swiss Army Knife"
# Swiss Army Knife
The goal of this project is to create an easy-to-use, multi-function, multi-language and cross-platform debugging tool set.
[中文](./doc/zh_CN/README.md)
***************
QSAK (Qt Swiss Army Knife) is a multi-functional, cross-platform debugging tool based on Qt open source framework.It integrates debugging functions such as serial port debugging, network port debugging, bluetooth debugging, USB debugging, HID debugging, CAN bus debugging, and MODBUS debugging. It has the ability to interpret and debug MAVLink, MODBUS, MQTT and other communication protocols. It can run on Windows, Linux, macOS, ios, Android, Raspberry Pi and other devices.**The goal of the project is to create a software version of the Swiss army knife.**
[中文](./doc/zh_CN/README.md)
## Development Environment
Qt 5.15.x，other versions may be available, but the project authors do not fix problems encountered during the development of other versions.
## Debug Tools
| Debuging Tools | Windows x86 | Linux x86 | MacOS | Raspberry Pi3/4 | Andrroid | Andrroid x86 |
| -------------- | ----------- | ------------ | ------------ | --------------- | ------------ | ------------ |
| SerialPorrt | √ | √ | √ | × | × | × |
| TcpClient | √ | √ | √ | √ | x | × |
| TcpServer | √ | √ | √ | √ | x | × |
| UDP | √ | √ | √ | √ | x | × |
| HID | x | x | x | x | x | × |
| USB | x | x | x | x | x | × |
| Bluetooth | x(Win 10) | x | x | x | x | × |
## Build Tools
| Build Tools | Windows x86 | Linux x86 | MacOS | Raspberry Pi3/4 | Andrroid | Andrroid x86 |
| -------------- | ----------- | ------------ | ------------ | --------------- | ------------ | ------------ |
| Qt Version | 5.12 32bit | 5.12 | Qt 5.12 | Qt 5.7 | 5.12 | 5.12 |
| Compiler(api) | MSVC 2017 | GCC 7.3 | CLANG 9 | GCC 4.9 | api level 28 | api level 28 |
## Ui-Main Window
## Main Window
![MainWindow.png](MainWindow.png)
## About Project
## About the Project
+ Author : wuuhii
+ E-mail : wuuhii@outlook.com
+ Blog : <http://wuhai.pro/>
+ QQ Grroup: 952218522 (Tencent QQ Group)
+ Platforrm: Windows、Linux、MacOS、Android and so on
+ Copyright: (I do not know what is it yet)
* Author：wuuhii
* E-mail：wuuhii@outlook.com
* Offical：<https://www.qsak.pro/>
* User Communication: 952218522 (QQ Group)
* Qt Technology Communication：723516989 (QQ Group)
***************
```txt
_ _

50
doc/zh_CN/README.md
View File

@ -2,53 +2,11 @@
[English](../../README.md)
***************
QSAK（Qt Swiss Army Knife）是一款基于Qt开源框架打造的多功能、跨平台调试工具。它集串口调试、网口调试、蓝牙调试、USB调试、HID调试、CAN总线调试、MODBUS总线调试等调试功能于一身，具备解析MAVLink、MODBUS、MQTT等协议的能力，能够运行在Windows、Linux、macOS、ios、Android及Raspberry Pi等设备上。**项目的目标是打造软件版“瑞士军刀”。**
QSAK（Qt Swiss Army Knife）是一款基于Qt开源框架打造的多功能、跨平台调试工具。它集串口调试、网口调试、蓝牙调试、USB调试、HID调试、CAN总线调试、MODBUS总线调试等调试功能于一身，具备MAVLink、MODBUS、MQTT等通信协议的解释调试能力，能够运行在Windows、Linux、macOS、ios、Android及Raspberry Pi等设备上。**项目的目标是打造软件版“瑞士军刀”。**
## 调试功能
## 开发环境
| F \\ P | Windows x86 | Linux x86 | MacOS | Raspberry Pi | Android v7 | Android v8 | Android x86 |
| -------------- | ----------- | ------------ | ------------ | --------------- | ------------ | ------------ | ------------ |
| SerialPorrt | Y | Y | Y | N | N | N | N |
| TcpClient | Y | Y | Y | Y | N | N | N |
| TcpServer | Y | Y | Y | Y | N | N | N |
| UDP | Y | Y | Y | Y | N | N | N |
| HID | N | N | N | N | N | N | N |
| USB | N | N | N | N | N | N | N |
| Bluetooth | N | N | N | N | N | N | N |
| CAN | N | N | N | N | N | N | N |
| MODBUS | N | N | N | N | N | N | N |
| HTTP | N | N | N | N | N | N | N |
| HTTPS | N | N | N | N | N | N | N |
注：**F：功能 P：开发平台**
## 协议解释
* MAVLink（V1及V2）
* MODBUS
* CAN
* REST
* CoAP
* MQTT
* DDS
* AMQP
* XMPP
* JMS
* HTTP
* HTTPS
## 构建环境
| E \\ T | Windows x86 | Linux x86 | MacOS | ios | Raspberry pi5 | Android |
| -------------- | ----------- | ------------ | ------------ | ------------ | --------------- |--------------- |
| Qt Version | 5.15 | 5.15 | Qt 5.15 | Qt 15 | 5.15 | 5.15 |
| Compiler | msvc 2017 | g++ 7.3 | clang 9 | clang 9 | g++ 8.3 | g++ 4.9 |
| JDK | / | / | / | / | / | 1.8.0 |
| NDK | / | / | / | / | / | r20 |
| SDK | / | / | / | / | / | r24 |
| Xcode | / | / | 10 | 10 | / | / |
注：**E：开发环境 T：目标平台**
Qt 5.15.x，其他版本也可能适用，但项目作者不会对其他版本开发时遇到的问题进行修复。
## 主界面预览
@ -58,7 +16,7 @@ QSAK（Qt Swiss Army Knife）是一款基于Qt开源框架打造的多功能、
* 作者：wuuhii
* 邮箱：wuuhii@outlook.com
* 官网：<http://www.qsak.pro/>
* 官网：<https://www.qsak.pro/>
* 交流：952218522 （用户交流群）
* 交流：723516989 （Qt技术交流群）