From 5896b616b0f8f7583292925b19e131522858d9ab Mon Sep 17 00:00:00 2001 From: Martin Girard Date: Mon, 28 Sep 2026 10:55:59 +0200 Subject: [PATCH] Moved readme to root --- README.md | 45 ++++++++++++++++++++++++++++++++-- bench-data-connector/README.md | 43 -------------------------------- 2 files changed, 43 insertions(+), 45 deletions(-) delete mode 100644 bench-data-connector/README.md diff --git a/README.md b/README.md index 891c656..9d1eb11 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ -# Bench Data -This repository contains both the arduino firmware and python connector to feed RPM and Lambda to a dynalab-core software \ No newline at end of file +# 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 diff --git a/bench-data-connector/README.md b/bench-data-connector/README.md deleted file mode 100644 index 9d1eb11..0000000 --- a/bench-data-connector/README.md +++ /dev/null @@ -1,43 +0,0 @@ -# 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