Skip to content

Commit 62814a9

Browse files
mich-wMich
authored andcommitted
setup Git Pages
1 parent 0066d85 commit 62814a9

File tree

5 files changed

+41
-10
lines changed

5 files changed

+41
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
# QtSerialMonitor
2-
Universal serial / network terminal with data plotting capabilities, based on [Qt](https://www.qt.io/).
2+
Universal serial monitor with data plotting capabilities, based on [Qt](https://www.qt.io/). Designed with all sorts of [Arduino](https://www.arduino.cc/) projects in mind, as a handy tool for debugging and experimentation :)
33

4-
![mainwindow](/screenshots/mainwindow.png?raw=true "mainwindow")
4+
![mainwindow](/docs/_screenshots/mainwindow.png)
55

66
Features:
77
- In/out serial data terminal with command history,
88
- UDP network protocol support,
9-
- Advanced data plotter with multible graphs support and basic data filtering - uses [QCustomPlot](https://www.qcustomplot.com/),
9+
- Advanced data plotter with multiple graphs support and basic data filtering - uses [QCustomPlot](https://www.qcustomplot.com/),
1010
- Printer support, ability to save graph as image,
11-
- Read/write .txt data logs,
11+
- Read/write ".txt" data logs,
1212
- many more...
1313

14-
<a href="https://github.com/mich-w/QtSerialMonitor/releases/download/v1.0/QtSerialMonitor_1.0_win_x64.zip" download>Download QtSerialMonitor_v1.0_win_x64</a>
14+
Enjoy !
1515

16-
The app uses a custom-written parser, which searches the incoming message for plottable data in form of label-value set. At the moment all labels and values **must be seperated with a whitespace** for the process to work properly. Its possible to use seperators like "=", ":" and "," - parser will be replace them with whitespace before processing. If no label is found, a generic name will be used i.e. "Graph 0".
16+
<a href="https://github.com/mich-w/QtSerialMonitor/releases/download/v1.0/QtSerialMonitor_1.0_win_x64.zip" download>Download QtSerialMonitor_v1.0_win_x64</a>
1717

18-
Examples of supported formats:
18+
*Notes:*
1919

20-
- "label_1 = 1.23 label_2 = 4.56"
21-
- "label_1 1.23 (tabulator) label_2 4.56"
22-
- "1.23 4.56" (Graph_0 and Graph_1)
2320

21+
*The app uses a custom-written parser, which searches the incoming message for plottable data in form of label-value set. At the moment, all labels and values **must be separated with a whitespace** in order to be recognized. Its possible to use separators like "=", ":" and "," - parser will be replace them with whitespace before processing. If no label is found, a generic name will be used i.e. "Graph 0".*
2422

23+
*Examples of supported formats:*
24+
25+
- *"Roll = 1.23 Pitch = 45.6"*
26+
- *"Voltage: 1.23 (tabulator) Output: 4.56"*
27+
- *"1.23 4.56" (Graph_0 and Graph_1)*

docs/_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman

docs/_screenshots/mainwindow.jpg

299 KB
Loading
File renamed without changes.

docs/index.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# QtSerialMonitor
2+
Universal serial monitor with data plotting capabilities, based on [Qt](https://www.qt.io/). Designed with all sorts of [Arduino](https://www.arduino.cc/) projects in mind, as a handy tool for debugging and experimentation :)
3+
4+
<img src="https://raw.githubusercontent.com/mich-w/QtSerialMonitor/master/docs/_screenshots/mainwindow.jpg">
5+
6+
Features:
7+
- In/out serial data terminal with command history,
8+
- UDP network protocol support,
9+
- Advanced data plotter with multiple graphs support and basic data filtering - uses [QCustomPlot](https://www.qcustomplot.com/),
10+
- Printer support, ability to save graph as image,
11+
- Read/write ".txt" data logs,
12+
- many more...
13+
14+
Enjoy !
15+
16+
<a href="https://github.com/mich-w/QtSerialMonitor/releases/download/v1.0/QtSerialMonitor_1.0_win_x64.zip" download>Download QtSerialMonitor_v1.0_win_x64</a>
17+
18+
*Notes:*
19+
20+
21+
*The app uses a custom-written parser, which searches the incoming message for plottable data in form of label-value set. At the moment, all labels and values **must be separated with a whitespace** in order to be recognized. Its possible to use separators like "=", ":" and "," - parser will be replace them with whitespace before processing. If no label is found, a generic name will be used i.e. "Graph 0".*
22+
23+
*Examples of supported formats:*
24+
25+
- *"Roll = 1.23 Pitch = 45.6"*
26+
- *"Voltage: 1.23 (tabulator) Output: 4.56"*
27+
- *"1.23 4.56" (Graph_0 and Graph_1)*

0 commit comments

Comments
 (0)