+ readme

README.md

@@ -0,0 +1,44 @@
+# 9-analyzer
+
+## Introduction
+
+This is a quick Node.js project developped to demonstrate how to parse communications logs extracted from the Ninebot electric scooters internal serial communication bus.
+
+## Install
+
+```bash
+git clone https://github.com/rascafr/9-analyzer.git
+
+cd 9-analyzer
+
+npm i
+```
+
+## Run
+
+Either production or development (code monitoring, `nodemon` required)
+
+```bash
+# prod
+npm start
+
+# dev
+npm run dev
+```
+
+## Getting new logs
+
+Use a serial-USB adapter, and use the following settings:
+
+- 115200 bd/s
+- 8 data bits
+- 1 stop bit
+- no parity
+
+Incoming data will be sent by the scooter on the yellow wire connected to the dashboard. 
+
+Ground (OV) is the black wire. Connect both files to your serial-USB adapter on *RX* and *GND*.
+
+## Arduino
+
+Some Arduino code is present insinde of this repos, can be used to parse on the fly some of the serial commands in "realtime".