mirror of
https://github.com/Serial-Studio/Serial-Studio.git
synced 2025-01-31 17:42:55 +08:00
136 lines
9.9 KiB
Markdown
136 lines
9.9 KiB
Markdown
<a href="#">
|
||
<img width="192px" height="192px" src="/doc/icon.svg" align="right" />
|
||
</a>
|
||
|
||
# Serial Studio
|
||
|
||
[](https://github.com/Serial-Studio/Serial-Studio/commits/master)
|
||
[](https://github.com/Serial-Studio/Serial-Studio/graphs/contributors)
|
||
[](https://github.com/Serial-Studio/Serial-Studio/pull/new)
|
||
[](https://github.com/Serial-Studio/Serial-Studio/releases/)
|
||
[](https://instagram.com/serialstudio.app)
|
||
[](https://www.paypal.com/donate?hosted_button_id=XN68J47QJKYDE)
|
||
|
||
Serial Studio — это многоплатформенный и универсальный инструмент для визуализации данных, разработанный для инженеров встраиваемых систем, студентов, хакеров и преподавателей. Он позволяет пользователям визуализировать, анализировать и отображать данные своих проектов и устройств без необходимости разработки специализированного ПО для каждого проекта. Serial Studio предлагает гибкое решение, которое адаптируется к широкому спектру случаев использования, что делает его идеальным как для образовательных, так и для профессиональных сред.
|
||
|
||
Этот инструмент был создан на основе моего опыта участия в нескольких соревнованиях CanSat, где мне часто приходилось разрабатывать новое ПО для наземной станции для каждого проекта. Со временем я понял, что было бы более эффективно и устойчиво поддерживать одну гибкую программу, которая позволяет пользователям определять, как обрабатывать и отображать входящие данные.
|
||
|
||
Сегодня Serial Studio — это мощный и адаптируемый инструмент, подходящий не только для соревнований CanSat, но и для любых проектов по сбору и визуализации данных. Он поддерживает получение данных из множества источников, включая последовательные порты, MQTT, Bluetooth Low Energy (BLE) и сетевые сокеты (TCP/UDP).
|
||
|
||
*Читать этот документ на других языках*: [Español](/doc/README_ES.md) [简体中文](/doc/README_ZH.md) [Deutsch](/doc/README_DE.md) [Русский](/doc/README_RU.md) [Français](/doc/README_FR.md)
|
||
|
||
|
||
|
||
## Особенности
|
||
|
||
- **Многоплатформенность:** Совместим с Windows, macOS и Linux.
|
||
- **Экспорт в CSV:** Легко сохраняет полученные данные в файлах CSV для последующего анализа или обработки.
|
||
- **Поддержка множества источников данных:** Поддерживает широкий спектр источников, включая последовательные порты, MQTT, Bluetooth Low Energy (BLE) и сетевые сокеты (TCP/UDP).
|
||
- **Настраиваемая визуализация:** Позволяет определять и визуализировать данные с помощью различных виджетов, которые можно настроить в редакторе проектов в соответствии с конкретными потребностями пользователя.
|
||
- **Настраиваемый анализ кадров:** Предоставляет возможность модифицировать функцию JavaScript для интерпретации входящих кадров данных, что упрощает предварительную обработку сырых данных с датчиков и работу с бинарными форматами.
|
||
- **Публикация и прием через MQTT:** Отправляет и принимает данные через Интернет, позволяя визуализировать данные в реальном времени из любой точки мира.
|
||
|
||
## Установка
|
||
|
||
Вы можете загрузить и установить последнюю версию Serial Studio для вашей предпочитаемой платформы [здесь](https://github.com/Serial-Studio/Serial-Studio/releases/latest).
|
||
|
||
### Установка на Linux
|
||
|
||
Для пользователей GNU/Linux существует несколько способов установить и запустить приложение:
|
||
|
||
#### 1. AppImage
|
||
|
||
Скачайте файл AppImage и убедитесь, что у него есть разрешения на выполнение перед запуском:
|
||
|
||
```
|
||
chmod +x SerialStudio-3.0.5-Linux-x86_64.AppImage
|
||
./SerialStudio-3.0.5-Linux-x86_64.AppImage
|
||
```
|
||
|
||
Примечание: Возможно, вам потребуется установить libfuse2, чтобы AppImage работал. В системах на основе Debian/Ubuntu вы можете установить его с помощью:
|
||
|
||
```
|
||
sudo apt update
|
||
sudo apt install libfuse2
|
||
```
|
||
|
||
Вы можете упростить интеграцию AppImage Serial Studio в вашу систему, используя [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher/).
|
||
|
||
#### 2. Пакеты DEB/RPM (экспериментально)
|
||
|
||
Вы также можете установить Serial Studio с помощью пакетов DEB или RPM, которые в настоящее время находятся на экспериментальной стадии. Пожалуйста, сообщайте о любых возникших проблемах.
|
||
|
||
Для дистрибутивов на основе Debian (например, Debian, Ubuntu, Linux Mint и др.):
|
||
|
||
```
|
||
sudo dpkg -i SerialStudio-3.0.5-Linux-x86_64.deb
|
||
```
|
||
|
||
Для дистрибутивов на основе RPM (например, Fedora, RHEL, OpenSUSE и др.):
|
||
|
||
```
|
||
sudo rpm -i SerialStudio-3.0.5-Linux-x86_64.rpm
|
||
```
|
||
|
||
## Разработка
|
||
|
||
### Требования
|
||
|
||
Для компиляции Serial Studio единственная необходимая зависимость — это [Qt](http://www.qt.io/download-open-source/). Десктопное приложение компилируется с **Qt 6.8.0**.
|
||
|
||
Если вы компилируете на GNU/Linux, вам также нужно установить `libgl1-mesa-dev`:
|
||
|
||
```bash
|
||
sudo apt install libgl1-mesa-dev
|
||
```
|
||
|
||
Вот список необходимых модулей Qt:
|
||
|
||
- Qt SVG
|
||
- Qt Quick
|
||
- Qt Widgets
|
||
- Qt Location
|
||
- Qt Bluetooth
|
||
- Qt Networking
|
||
- Qt Positioning
|
||
- Qt Serial Port
|
||
- Qt Print Support
|
||
- Qt Quick Widgets
|
||
- Qt Quick Controls 2
|
||
|
||
### Клонирование репозитория
|
||
|
||
Чтобы клонировать репозиторий с необходимыми подмодулями, выполните:
|
||
|
||
```bash
|
||
git clone https://github.com/Serial-Studio/Serial-Studio
|
||
cd Serial-Studio
|
||
```
|
||
|
||
### Компиляция приложения
|
||
|
||
После установки Qt вы можете скомпилировать проект, открыв файл **CMakeLists.txt** в своем предпочтительном IDE или используя командную строку:
|
||
|
||
```bash
|
||
mkdir build
|
||
cd build
|
||
cmake ../ -DCMAKE_BUILD_TYPE=Release
|
||
cmake --build . --config Release -j 10
|
||
```
|
||
|
||
## Архитектура ПО
|
||
|
||
Ниже приведена упрощенная диаграмма, иллюстрирующая, как взаимодействуют различные модули Serial Studio. Для получения более детальной информации ознакомьтесь с полной документацией DOXYGEN [здесь](https://serial-studio.github.io/hackers/).
|
||
|
||
|
||
|
||
## Лицензия
|
||
|
||
Этот проект лицензирован под лицензией MIT. Для получения более подробной информации см. файл [LICENSE](/LICENSE.md).
|
||
|
||
## Поддержка и пожертвования
|
||
|
||
Если вы находите Serial Studio полезным, рассмотрите возможность поддержки его разработки с помощью [пожертвования через PayPal](https://www.paypal.com/donate?hosted_button_id=XN68J47QJKYDE).
|
||
|
||
Или, если вы когда-нибудь окажетесь в [Канкуне, Мексика](https://ru.wikipedia.org/wiki/Канкун) и захотите пригласить меня на пиво лично, не стесняйтесь [отправить мне сообщение в Instagram](https://instagram.com/aspatru). Я буду рад познакомиться!
|