You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/mindstorm38/debug-sensor/releases)
@@ -19,7 +19,7 @@ Debug sensor let you to communicate with a serial port and retrieve customisable
@@ -34,7 +34,7 @@ If you want to install this application there is two options :
34
34
- Clone or download this repository, and install yourselves all dependencies and launch it with `start.bat` windows script or `npm start` command.
35
35
- Download pre-packaged releases zip file for your platform, extract the zip in a folder named, for example "debug-sensor" and then run the executable file `debug-sensor.exe`.
36
36
37
-
> Important note : Linux and Mac platforms currently not supported (please refer to [Platform Support](#platform-support)).
37
+
> **Important note** : Linux and Mac platforms currently not supported (please refer to [Platform Support](#platform-support)).
38
38
39
39
---------
40
40
@@ -48,7 +48,7 @@ The first thing to do is to configure the packet pattern, that's the way the dat
48
48
49
49
Packets are delimited by `sof` (start-of-frame), `eof` (end-of-frame) and an `escape` byte, the software only recognise packets with valid delimiters en escape.
50
50
51
-
> Important note : Delimiters and escapes bytes are not currently configurable and their default values are : `sof` and `eof` is `0x7E` and `escape` is `0x7D`
51
+
> **Important note** : Delimiters and escapes bytes are not currently configurable and their default values are : `sof` and `eof` is `0x7E` and `escape` is `0x7D`
52
52
53
53
A packet is composed of segments, each segment has :
54
54
* A type, it defines the size and the way the bytes will be read. List of current types :
@@ -60,7 +60,7 @@ A packet is composed of segments, each segment has :
60
60
* An identifier to help you find it easily
61
61
62
62
To add a segment, just click on the `+` square, this will add a segment with a default type to `Unsigned Byte`.
63
-
Then a segment configuration panel open with multiple fields and buttons : the first text field is its identifier, the second drop-down menu is for selecting its type, "Remove" button to remove the segment and the last "x" button to close the segment configuration panel.
63
+
Then a segment configuration panel open with multiple fields and buttons : the first text field is its identifier, the second drop-down menu is for selecting its type, `Remove` button to remove the segment and the last `x` button to close the segment configuration panel.
64
64
65
65
The number displayed at the bottom of the segment's square is the last value collected during the curernt session.
66
66
@@ -71,7 +71,7 @@ To connect to your serial port, you must already have it installed on your compu
71
71
> Note : Be careful to configure the pattern of your packet before connecting, otherwise you will not receive data, which is normal behavior.
72
72
73
73
#### Real-time graph
74
-
The real-time graph is displayed in another window and can be accessed by clicking the "Show graph" button on the left side.
74
+
The real-time graph is displayed in another window and can be accessed by clicking the "Show graph" button on the left side. I'm using the [Plotly](https://plot.ly/javascript) javascript library.
75
75
76
76
#### Console
77
77
A console is available at the bottom of the right side, it can be useful if you want to collect text data from your sensor, or to send text commands.
@@ -92,5 +92,9 @@ You can repport issues here : [Github Issues](https://github.com/mindstorm38/deb
92
92
93
93
---------
94
94
95
-
### License
95
+
### Licenses
96
96
Debug sensor is Apache-2.0 licensed
97
+
98
+
Dependencies :
99
+
-[plotly.js](https://github.com/plotly/plotly.js) : MIT License
100
+
-[serialport](https://github.com/node-serialport/node-serialport) : MIT License
0 commit comments