Skip to content

Commit c68a446

Browse files
committed
2 parents 039bfdd + cd96b39 commit c68a446

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Debug sensor
2-
Debug sensor is an electron application that use NodeJS (server-based javascript).
1+
# Debug Sensor
2+
Debug sensor is an electron application that use Node.js (server-based javascript).
33

44
[![GitHub release](https://img.shields.io/github/release/mindstorm38/debug-sensor.svg)](https://github.com/mindstorm38/debug-sensor/releases)
55
[![Github All Releases](https://img.shields.io/github/downloads/mindstorm38/debug-sensor/total.svg)](https://github.com/mindstorm38/debug-sensor/releases)
@@ -19,7 +19,7 @@ Debug sensor let you to communicate with a serial port and retrieve customisable
1919
* [Console](#console)
2020
* [Issues](#issues)
2121
* [Sensors codes examples](#sensors-codes-examples)
22-
* [License](#license)
22+
* [Licenses](#licenses)
2323

2424
---------
2525

@@ -34,7 +34,7 @@ If you want to install this application there is two options :
3434
- Clone or download this repository, and install yourselves all dependencies and launch it with `start.bat` windows script or `npm start` command.
3535
- 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`.
3636

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)).
3838
3939
---------
4040

@@ -48,7 +48,7 @@ The first thing to do is to configure the packet pattern, that's the way the dat
4848
4949
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.
5050

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`
5252
5353
A packet is composed of segments, each segment has :
5454
* 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 :
6060
* An identifier to help you find it easily
6161

6262
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.
6464

6565
The number displayed at the bottom of the segment's square is the last value collected during the curernt session.
6666

@@ -71,7 +71,7 @@ To connect to your serial port, you must already have it installed on your compu
7171
> Note : Be careful to configure the pattern of your packet before connecting, otherwise you will not receive data, which is normal behavior.
7272
7373
#### 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.
7575

7676
#### Console
7777
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
9292

9393
---------
9494

95-
### License
95+
### Licenses
9696
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

Comments
 (0)