{"id":15532257,"url":"https://github.com/mindstorm38/debug-sensor","last_synced_at":"2025-03-28T22:26:40.808Z","repository":{"id":95733215,"uuid":"121943622","full_name":"mindstorm38/debug-sensor","owner":"mindstorm38","description":"A serial debugger originally made for sensors","archived":false,"fork":false,"pushed_at":"2018-03-10T10:09:47.000Z","size":857,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-03T08:51:06.665Z","etag":null,"topics":["communication","console","debug","debugger","electron","electron-app","javascript","less","nodejs","real-time-data","serial","serial-console","serialport"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mindstorm38.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-18T11:01:12.000Z","updated_at":"2018-10-23T17:57:14.000Z","dependencies_parsed_at":"2023-03-16T03:02:01.282Z","dependency_job_id":null,"html_url":"https://github.com/mindstorm38/debug-sensor","commit_stats":{"total_commits":40,"total_committers":1,"mean_commits":40.0,"dds":0.0,"last_synced_commit":"c68a446caf88b0475a04432e353540788fac2623"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindstorm38%2Fdebug-sensor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindstorm38%2Fdebug-sensor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindstorm38%2Fdebug-sensor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mindstorm38%2Fdebug-sensor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mindstorm38","download_url":"https://codeload.github.com/mindstorm38/debug-sensor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246108166,"owners_count":20724678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["communication","console","debug","debugger","electron","electron-app","javascript","less","nodejs","real-time-data","serial","serial-console","serialport"],"created_at":"2024-10-02T11:29:35.316Z","updated_at":"2025-03-28T22:26:40.776Z","avatar_url":"https://github.com/mindstorm38.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Debug Sensor\nDebug sensor is an electron application that use Node.js (server-based javascript).\n\n[![GitHub release](https://img.shields.io/github/release/mindstorm38/debug-sensor.svg)](https://github.com/mindstorm38/debug-sensor/releases)\n[![Github All Releases](https://img.shields.io/github/downloads/mindstorm38/debug-sensor/total.svg)](https://github.com/mindstorm38/debug-sensor/releases)\n[![GitHub Lastest Releases](https://img.shields.io/github/downloads/mindstorm38/debug-sensor/latest/total.svg)](https://github.com/mindstorm38/debug-sensor/releases)\n\n\n## Intro\nDebug sensor let you to communicate with a serial port and retrieve customisable packet and values.\n\n## Table of content\n* [Platform Support](#platform-support)\n* [Installation](#installation)\n* [Usage](#usage)\n  * [Packet configuration](#packet-configuration)\n  * [Connection](#connection)\n  * [Real-time graph](#real-time-graph)\n  * [Console](#console)\n* [Issues](#issues)\n* [Sensors codes examples](#sensors-codes-examples)\n* [Licenses](#licenses)\n\n---------\n\n### Platform Support\nDebug sensor is currently only supported by Windows.\nThis 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.\n\n---------\n\n### Installation\nIf you want to install this application there is two options :\n- Clone or download this repository, and install yourselves all dependencies and launch it with `start.bat` windows script or `npm start` command.\n- 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`.\n\n\u003e **Important note** : Linux and Mac platforms currently not supported (please refer to [Platform Support](#platform-support)).\n\n---------\n\n### Usage\nThe debug sensor's ergonomic interface makes it really easy to handle.\n\n#### Packet configuration\nThe 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.\n\n\u003e Note : Pattern changes are automatically saved.\n\nPackets 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.\n\n\u003e **Important note** :  Delimiters and escapes bytes are not currently configurable and their default values are : `sof` and `eof` is `0x7E` and `escape` is `0x7D`\n\nA packet is composed of segments, each segment has :\n* A type, it defines the size and the way the bytes will be read. List of current types :\n  * (*Unsigned*) Byte\n  * (*Unsigned*) Integer (16 bits)\n  * (*Unsigned*) Integer (32 bits)\n  * Floating Point Value (32 bits)\n  * Floating Point Value (64 bits)\n* An identifier to help you find it easily\n\nTo add a segment, just click on the `+` square, this will add a segment with a default type to `Unsigned Byte`.\nThen 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.\n\nThe number displayed at the bottom of the segment's square is the last value collected during the curernt session.\n\n\u003e Note : Currently, the segments are not movable.\n\n#### Connection\nTo 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.\n\u003e Note : Be careful to configure the pattern of your packet before connecting, otherwise you will not receive data, which is normal behavior.\n\n#### Real-time graph\nThe 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.\n\n#### Console\nA 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.\n\n\u003e Note : You must escape all bytes, even on bytes out of packets\n\n---------\n\n### Sensors codes examples\nRead `examples` folder's [README](https://github.com/mindstorm38/debug-sensor/blob/master/examples/README.md) for more explanations.\n\n\u003e Not yet example\n\n---------\n\n### Issues\nYou can repport issues here : [Github Issues](https://github.com/mindstorm38/debug-sensor/issues)\n\n---------\n\n### Licenses\nDebug sensor is Apache-2.0 licensed\n\nDependencies :\n- [plotly.js](https://github.com/plotly/plotly.js) : MIT License\n- [serialport](https://github.com/node-serialport/node-serialport) : MIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmindstorm38%2Fdebug-sensor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmindstorm38%2Fdebug-sensor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmindstorm38%2Fdebug-sensor/lists"}