diff --git a/bench-data-connector/README.md b/bench-data-connector/README.md index e69de29..9d1eb11 100644 --- a/bench-data-connector/README.md +++ b/bench-data-connector/README.md @@ -0,0 +1,43 @@ +# Bench-Data + +> [!WARNING] +> This software was developped for linux, Windows compatibility is not guaranted + +This repository contains both the arduino firmware and python connector to feed RPM and Lambda to a dynalab-core software +## Requirements +To use the software you will need to install `uv` to manage the python project [docs.astral.sh](https://docs.astral.sh/uv/getting-started/installation/) +## Setup +First, clone the repository: +```bash +git clone https://git.h3cx.dev/Exergie/Bench-Data-Processing.git +``` +After that, you will need to go to the connector repository and sync the project: +```bash +cd Bench-data/bench-data-connector +uv sync +``` +Then to run the program you will just have to run the following command into your terminal: +```bash +uv run bench-data-connector +``` +## Usage +To use the program you will have to plug in the arduino into a port of your pc. Then when the program is executed you will have to select the port where the arduino is pluged in. +``` +27: /dev/ttyS5 n/a +28: /dev/ttyS3 n/a +29: /dev/ttyS2 n/a +30: /dev/ttyS1 n/a +31: /dev/ttyS0 n/a +32: /dev/ttyUSB0 USB Serial +Choose a port to connect: 32 +``` +Once the port is selected the arduino is going to operate a sync with the pc during 30 seconds, so no data will appear in the first 30 seconds. +``` +Waiting 5 seconds before synchronization... +``` +Once the sync is done the data should start to appear: +``` +sync ok +Offset:2626280123208.57 +Scale:1.006884777346364 +``` \ No newline at end of file