mirror of
https://github.com/Serial-Studio/Serial-Studio.git
synced 2025-01-31 17:42:55 +08:00
148 lines
5.5 KiB
Markdown
148 lines
5.5 KiB
Markdown
<a href="#">
|
|
<img width="192px" height="192px" src="doc/icon.png" align="right" />
|
|
</a>
|
|
|
|
# Serial Studio
|
|
|
|
[](https://travis-ci.org/Serial-Studio/Serial-Studio)
|
|
|
|
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.
|
|
|
|
Furthermore, this approach can be extended to almost any type of project that involves some kind of data acquisition & measurement.
|
|
|
|
|
|
|
|
## Communication Protocol
|
|
|
|
The communication protocol is implemented through a JSON document. For example, my CanSat team uses the following template:
|
|
|
|
```
|
|
{
|
|
"t":"CanSat 2020", /* Project title */
|
|
"g":[ /* Project data group array */
|
|
{
|
|
"t":"Mission Status", /* Group title */
|
|
"d":[ /* Group dataset array */
|
|
{
|
|
"t":"Mission Time", /* Dataset title */
|
|
"v":"%s" /* Dataset value */
|
|
},
|
|
{
|
|
"t":"Packet Count", /* Dataset title */
|
|
"v":"%s" /* Dataset value */
|
|
},
|
|
{
|
|
"t":"Software State", /* Dataset title */
|
|
"v":"%s" /* Dataset value */
|
|
},
|
|
{
|
|
"t":"Battery Voltage", /* Dataset title */
|
|
"v":"%s", /* Dataset value */
|
|
"g":true, /* Graph dataset */
|
|
"u":"mV" /* Dataset units */
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"t":"Sensor Readings", /* Group title */
|
|
"d":[ /* Group dataset array */
|
|
{
|
|
"t":"Altitude", /* Dataset title */
|
|
"v":"%s", /* Dataset value */
|
|
"u":"m" /* Dataset units */
|
|
},
|
|
{
|
|
"t":"Pressure", /* Dataset title */
|
|
"v":"%s", /* Dataset value */
|
|
"g":true, /* Graph dataset */
|
|
"u":"KPa" /* Dataset units */
|
|
},
|
|
{
|
|
"t":"Temperature", /* Dataset title */
|
|
"v":"%s", /* Dataset value */
|
|
"g":true, /* Graph dataset */
|
|
"u":"ºC" /* Dataset units */
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"t":"GPS", /* GPS Group title */
|
|
"d":[ /* Group dataset array */
|
|
{
|
|
"t":"UTC Time", /* Dataset title */
|
|
"v":"%s" /* Dataset value */
|
|
},
|
|
{
|
|
"t":"Longitude", /* Dataset title */
|
|
"v":"%s" /* Dataset value */
|
|
},
|
|
{
|
|
"t":"Latitude", /* Dataset title */
|
|
"v":"%s" /* Dataset value */
|
|
},
|
|
{
|
|
"t":"Altitude", /* Dataset title */
|
|
"v":"%s" /* Dataset value */
|
|
},
|
|
{
|
|
"t":"Num. Sats", /* Dataset title */
|
|
"v":"%s" /* Dataset value */
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
The `%s` values are replaced with real-time data from each sensor and subsystem. As you can see, the data frame contains the following information:
|
|
|
|
- Project title
|
|
- Groups
|
|
- Group title
|
|
- Group data
|
|
- Dataset title
|
|
- Dataset value
|
|
- Dataset unit
|
|
- Dataset graph (or not)
|
|
|
|
This information is processed by Serial Studio, which builds the user interface according to the information contained in each frame. This information is also used to generate a CSV file with all the readings received from the serial device, the CSV file can be used for analysis and data-processing within MATLAB.
|
|
|
|
## 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.
|
|
|
|
### Cloning this repository
|
|
|
|
This repository makes use of [`git submodule`](https://git-scm.com/docs/git-submodule). In order to clone it, you have two options:
|
|
|
|
One-liner:
|
|
|
|
git clone --recursive https://github.com/Serial-Studio/Serial-Studio
|
|
|
|
Normal procedure:
|
|
|
|
git clone https://github.com/Serial-Studio/Serial-Studio
|
|
cd Serial-Studio
|
|
git submodule init
|
|
git submodule update
|
|
|
|
###### 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.
|
|
|
|
|
|
|