https://github.com/mindstorm38/debug-sensor
A serial debugger originally made for sensors
https://github.com/mindstorm38/debug-sensor
communication console debug debugger electron electron-app javascript less nodejs real-time-data serial serial-console serialport
Last synced: 3 months ago
JSON representation
A serial debugger originally made for sensors
- Host: GitHub
- URL: https://github.com/mindstorm38/debug-sensor
- Owner: mindstorm38
- License: apache-2.0
- Created: 2018-02-18T11:01:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-10T10:09:47.000Z (over 7 years ago)
- Last Synced: 2025-02-03T08:51:06.665Z (5 months ago)
- Topics: communication, console, debug, debugger, electron, electron-app, javascript, less, nodejs, real-time-data, serial, serial-console, serialport
- Language: JavaScript
- Homepage:
- Size: 837 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Debug Sensor
Debug sensor is an electron application that use Node.js (server-based javascript).
[](https://github.com/mindstorm38/debug-sensor/releases)
[](https://github.com/mindstorm38/debug-sensor/releases)
[](https://github.com/mindstorm38/debug-sensor/releases)
## Intro
Debug sensor let you to communicate with a serial port and retrieve customisable packet and values.
## Table of content
* [Platform Support](#platform-support)
* [Installation](#installation)
* [Usage](#usage)
* [Packet configuration](#packet-configuration)
* [Connection](#connection)
* [Real-time graph](#real-time-graph)
* [Console](#console)
* [Issues](#issues)
* [Sensors codes examples](#sensors-codes-examples)
* [Licenses](#licenses)
---------
### Platform Support
Debug sensor is currently only supported by Windows.
This limitation is only due to the `serialport` dependency, the help would be welcome from other contributors to help me to port this application on others platforms.
---------
### Installation
If you want to install this application there is two options :
- Clone or download this repository, and install yourselves all dependencies and launch it with `start.bat` windows script or `npm start` command.
- 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`.
> **Important note** : Linux and Mac platforms currently not supported (please refer to [Platform Support](#platform-support)).
---------
### Usage
The debug sensor's ergonomic interface makes it really easy to handle.
#### Packet configuration
The first thing to do is to configure the packet pattern, that's the way the data is stored in the packet sent over the serial port.
> Note : Pattern changes are automatically saved.
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.
> **Important note** : Delimiters and escapes bytes are not currently configurable and their default values are : `sof` and `eof` is `0x7E` and `escape` is `0x7D`
A packet is composed of segments, each segment has :
* A type, it defines the size and the way the bytes will be read. List of current types :
* (*Unsigned*) Byte
* (*Unsigned*) Integer (16 bits)
* (*Unsigned*) Integer (32 bits)
* Floating Point Value (32 bits)
* Floating Point Value (64 bits)
* An identifier to help you find it easily
To add a segment, just click on the `+` square, this will add a segment with a default type to `Unsigned Byte`.
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.
The number displayed at the bottom of the segment's square is the last value collected during the curernt session.
> Note : Currently, the segments are not movable.
#### Connection
To connect to your serial port, you must already have it installed on your computer, and then select it from the drop-down menu on the left side of the application. You can at the same time define the baud rate used by your port.
> Note : Be careful to configure the pattern of your packet before connecting, otherwise you will not receive data, which is normal behavior.
#### Real-time graph
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.
#### Console
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.
> Note : You must escape all bytes, even on bytes out of packets
---------
### Sensors codes examples
Read `examples` folder's [README](https://github.com/mindstorm38/debug-sensor/blob/master/examples/README.md) for more explanations.
> Not yet example
---------
### Issues
You can repport issues here : [Github Issues](https://github.com/mindstorm38/debug-sensor/issues)
---------
### Licenses
Debug sensor is Apache-2.0 licensed
Dependencies :
- [plotly.js](https://github.com/plotly/plotly.js) : MIT License
- [serialport](https://github.com/node-serialport/node-serialport) : MIT License