2021-01-20 09:16:40 +08:00
< a href = "#" >
2021-09-28 17:05:16 -05:00
< img width = "192px" height = "192px" src = "/doc/icon.svg" align = "right" / >
2021-01-20 09:16:40 +08:00
< / a >
# Serial Studio
2022-05-01 19:31:53 -05:00
[![Github commits ](https://img.shields.io/github/last-commit/Serial-Studio/Serial-Studio )](https://github.com/Serial-Studio/Serial-Studio/commits/master)
[![GitHub contributors ](https://img.shields.io/github/contributors/Serial-Studio/Serial-Studio )](https://github.com/Serial-Studio/Serial-Studio/graphs/contributors)
[![PR's Welcome ](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat )](https://github.com/Serial-Studio/Serial-Studio/pull/new)
2021-01-21 20:39:55 -05:00
[![Codacy Badge ](https://app.codacy.com/project/badge/Grade/4b6f3ce14a684704980fea31d8c1632e )](https://www.codacy.com/gh/Serial-Studio/Serial-Studio/dashboard?utm_source=github.com& utm_medium=referral& utm_content=Serial-Studio/Serial-Studio& utm_campaign=Badge_Grade)
2021-01-20 09:16:40 +08:00
[![Github All Releases ](https://img.shields.io/github/downloads/Serial-Studio/Serial-Studio/total.svg )](https://github.com/Serial-Studio/Serial-Studio/releases/)
2021-01-19 23:34:47 -05:00
[![Contributor Covenant ](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg )](CODE_OF_CONDUCT.md)
2021-09-04 21:22:32 -05:00
[![Donate ](https://img.shields.io/badge/Donate-PayPal-green.svg )](https://www.paypal.com/donate?hosted_button_id=XN68J47QJKYDE)
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
Serial Studio 是一个跨平台、功能多样的数据可视化工具,专为嵌入式系统工程师、学生、黑客和教师设计。它允许用户可视化、分析和展示他们项目和设备中的数据,而无需为每个项目开发特定的可视化软件。**Serial Studio** 提供了一种灵活的解决方案,适应各种使用场景,非常适合教育和专业环境。
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
这个工具源于我在多个 CanSat 比赛中的经验,那时我经常需要为每个项目开发新的地面站软件。随着时间的推移,我意识到维护一个灵活的通用软件,让用户可以定义如何处理和显示传入的数据,会更加高效和可持续。
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
如今, Serial Studio 是一个强大且灵活的工具,不仅适用于 CanSat 竞赛, 也适用于任何数据采集和可视化项目。它支持从多种来源获取数据, 包括串行端口、MQTT、蓝牙低功耗 (BLE) 和网络套接字 (TCP/UDP)。
2021-01-20 09:16:40 +08:00
2024-09-21 02:04:49 -05:00
*阅读其他语言版本的文档*: [Español ](/doc/README_ES.md ) [简体中文 ](/doc/README_ZH.md ) [Deutsch ](/doc/README_DE.md ) [Русский ](/doc/README_RU.md )
2021-01-20 09:16:40 +08:00
2024-09-21 02:04:49 -05:00
![软件使用 ](/doc/screenshot.png )
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
## 功能
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
- **跨平台:** 兼容 Windows、macOS 和 Linux。
- **CSV 导出:** 轻松将接收到的数据保存为 CSV 文件,以便进一步分析或处理。
- **多数据源支持:** 支持多种来源, 包括串行端口、MQTT、蓝牙低功耗 (BLE) 和网络套接字 (TCP/UDP)。
- **可自定义可视化:** 通过项目编辑器定义和显示数据,使用各种可配置的小部件以满足用户的具体需求。
- **可自定义帧解析:** 提供修改 JavaScript 函数的选项,以解析传入的数据帧,方便处理原始传感器数据并支持复杂的二进制格式。
- **通过 MQTT 发布和接收:** 通过互联网发送和接收数据,支持从世界任何地方实时可视化数据。
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
## 安装
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
你可以从 [这里 ](https://github.com/Serial-Studio/Serial-Studio/releases/latest ) 下载并安装适用于你首选平台的最新版本 **Serial Studio** 。
2021-02-01 11:29:23 -05:00
2024-09-21 01:57:03 -05:00
### Linux 安装
2021-02-01 11:29:23 -05:00
2024-09-21 01:57:03 -05:00
对于 GNU/Linux 用户,在下载 AppImage 后,确保为其设置正确的可执行权限,然后运行应用程序:
```bash
chmod +x SerialStudio-2.1.0-Linux.AppImage
./SerialStudio-2.1.0-Linux.AppImage
```
或者,你可以使用 [AppImageLauncher ](https://github.com/TheAssassin/AppImageLauncher/ ) 将 **Serial Studio** 集成到你的系统中。
### 预编译的 Linux 软件包
对于 Arch Linux 用户,你可以通过 AUR 安装 **Serial Studio** :
```bash
aur fetch serial-studio-git
aur build
sudo pacman -S serial-studio-git
```
**注意:** AUR 软件包可能过时,请确保检查更新。
## 开发
### 要求
编译 Serial Studio 的唯一必要依赖项是 [Qt ](http://www.qt.io/download-open-source/ )。桌面应用程序使用 **Qt 6.7.1** 进行编译。
如果你在 GNU/Linux 上进行编译,你还需要安装 `libgl1-mesa-dev` :
```bash
sudo apt install libgl1-mesa-dev
```
以下是需要的 Qt 模块列表:
2021-02-01 11:29:23 -05:00
2021-12-07 03:31:35 -06:00
- Qt SVG
2021-02-01 11:29:23 -05:00
- Qt Quick
- Qt Widgets
2024-09-21 01:57:03 -05:00
- Qt Location
- Qt Bluetooth
2021-12-07 03:31:35 -06:00
- Qt Networking
2024-09-21 01:57:03 -05:00
- Qt Positioning
2021-02-01 11:29:23 -05:00
- Qt Serial Port
2021-12-07 03:31:35 -06:00
- Qt Print Support
- Qt Quick Widgets
2021-02-01 11:29:23 -05:00
- Qt Quick Controls 2
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
### 克隆仓库
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
要克隆包含必要子模块的仓库,请执行以下命令:
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
```bash
git clone https://github.com/Serial-Studio/Serial-Studio
cd Serial-Studio
```
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
### 编译应用程序
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
安装 Qt 后,你可以通过在你喜欢的 IDE 中打开 **CMakeLists.txt** 文件或使用命令行编译项目:
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
```bash
mkdir build
cd build
cmake ../ -DCMAKE_BUILD_TYPE=Release
cmake --build . --config Release -j 10
```
2021-01-20 09:16:40 +08:00
2022-05-01 19:17:33 -05:00
## 软件架构
2024-09-21 01:57:03 -05:00
下面是一个简化的示意图,展示了 Serial Studio 各个模块如何交互。有关更详细的信息,请查阅完整的 DOXYGEN 文档 [这里 ](https://serial-studio.github.io/hackers/ )。
2022-05-01 19:17:33 -05:00
2024-09-21 02:04:49 -05:00
![架构 ](/doc/architecture/architecture.png )
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
## 许可证
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
此项目根据 MIT 许可证授权。更多详细信息,请参阅 [LICENSE ](LICENSE.md ) 文件。
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
## 支持与捐赠
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
如果你觉得 Serial Studio 有用,欢迎通过 [PayPal 捐赠 ](https://www.paypal.com/donate?hosted_button_id=XN68J47QJKYDE ) 支持其开发。
2021-01-20 09:16:40 +08:00
2024-09-21 01:57:03 -05:00
或者,如果你有机会来到 [墨西哥坎昆 ](https://zh.wikipedia.org/wiki/坎昆 ),并想亲自请我喝一杯,随时可以通过 [Instagram 给我发消息 ](https://instagram.com/aspatru )。我很乐意认识你!