mirror of
https://github.com/hubaldv/bioz-host-rs.git
synced 2025-12-06 05:11:17 +00:00
Added code to create an executable/app, added some info in the readme.
This commit is contained in:
18
readme.md
Normal file
18
readme.md
Normal 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 device’s 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.
|
||||
Reference in New Issue
Block a user