Serial-Studio/README.md

43 lines
2.2 KiB
Markdown
Raw Normal View History

2020-10-18 06:50:26 -05:00
<a href="#">
<img width="192px" height="192px" src="doc/icon.png" align="right" />
</a>
# Serial Studio
2021-01-09 21:04:58 -05:00
[![Build Status](https://github.com/Serial-Studio/Serial-Studio/workflows/Build/badge.svg)](#)
[![Github All Releases](https://img.shields.io/github/downloads/Serial-Studio/Serial-Studio/total.svg)](#)
2020-10-18 06:50:26 -05:00
Serial Studio is a multi-platform, multi-purpose serial data visualization program. The goal of this project is to allow embedded developers & makers to easily visualize, present & analyze the data generated by their projects and devices, without the need of writing specialized computer software for each project.
The need for this project arose during the development of the Ground Station Software for several CanSat-based competitions in which I participate. It's simply not sustainable to develop and maintain different GSS programs for each competition & project. The smart solution is to have one common Ground Station software and let each CanSat define how the data is presented to the end user by using an extensible communication protocol.
2020-12-30 01:39:17 -06:00
Furthermore, this approach can be extended to almost any type of project that involves some kind of data acquisition & measurement. If you want a more in-depth explanation of why this project exists, and what its all about, check [this blog post](https://www.alex-spataru.com/blog/introducing-serial-studio).
2020-10-18 06:50:26 -05:00
2020-12-24 22:06:31 -06:00
**NOTE:** Information regarding the communication protocol is provided in the [wiki](https://github.com/Serial-Studio/Serial-Studio/wiki/Communication-Protocol).
2020-12-24 19:53:01 -06:00
*Read this in other languages*: [Español](README_ES.md)
2020-12-27 23:42:23 -06:00
![Software usage](doc/app-usage.gif)
2020-10-18 06:50:26 -05:00
## Build instructions
##### Requirements
The only requirement to compile the application is to have [Qt](http://www.qt.io/download-open-source/) installed in your system. The desktop application will compile with Qt 5.15 or greater.
###### Compiling the application
Once you have Qt installed, open *Serial-Studio.pro* in Qt Creator and click the "Run" button.
Alternatively, you can also use the following commands:
qmake
make -j4
## Licence
This project is released under the MIT license, for more information, check the [LICENSE](LICENSE.md) file.