Added code to create an executable/app, added some info in the readme.

This commit is contained in:
2025-12-04 17:15:14 +01:00
parent 1ca1c2c7b4
commit 2252771ac3
6 changed files with 73 additions and 1 deletions

18
readme.md Normal file
View File

@@ -0,0 +1,18 @@
# Bio-Impedance Amplifier | GUI
This repository contains Rust-based software for communicating with a custom-built bio-impedance amplifier. It provides several key features:
- Single-frequency and frequency-sweep measurements
- Real-time visualization of magnitude and phase
- Support for both 2-lead and 4-lead measurements
- Data logging to `.csv` files
- Day and night display modes
- Control via on-screen buttons or keyboard shortcuts
## How to Use This Software
1. Install the Rust toolchain and run the software using:
```bash
cargo run --bin main_gui --release
```
2. Alternatively, a precompiled executable can be used instead of building from source.
3. The software uses the `postcard-rpc` crate to communicate directly with the USB hardware devices endpoints. After connecting the hardware via USB, the device should automatically connect, and the indicator dot in the top-right corner will turn green.
4. Check the **Shortcuts** tab for useful information on available keyboard commands.