mirror of
https://github.com/ruvnet/RuView.git
synced 2026-07-10 01:30:01 +00:00
04f205a05e
Some checks failed
Continuous Deployment / Pre-deployment Checks (push) Has been cancelled
Continuous Integration / Code Quality & Security (push) Has been cancelled
Continuous Integration / Rust Workspace Tests (push) Has been cancelled
Continuous Integration / Tests (push) Has been cancelled
Continuous Integration / Tests-1 (push) Has been cancelled
Continuous Integration / Tests-2 (push) Has been cancelled
Fix-Marker Regression Guard / Verify fix markers (push) Has been cancelled
Security Scanning / Static Application Security Testing (push) Has been cancelled
Security Scanning / Dependency Vulnerability Scan (push) Has been cancelled
Security Scanning / Container Security Scan (push) Has been cancelled
Security Scanning / Infrastructure Security Scan (push) Has been cancelled
Security Scanning / Secret Scanning (push) Has been cancelled
Security Scanning / License Compliance Scan (push) Has been cancelled
Security Scanning / Security Policy Compliance (push) Has been cancelled
Continuous Deployment / Rollback Deployment (push) Has been cancelled
Continuous Deployment / Deploy to Staging (push) Has been cancelled
Continuous Deployment / Deploy to Production (push) Has been cancelled
Continuous Deployment / Post-deployment Monitoring (push) Has been cancelled
Continuous Deployment / Notify Deployment Status (push) Has been cancelled
Continuous Integration / Performance Tests (push) Has been cancelled
Continuous Integration / Docker Build & Test (push) Has been cancelled
Continuous Integration / API Documentation (push) Has been cancelled
Security Scanning / Security Report (push) Has been cancelled
Continuous Integration / Notify (push) Has been cancelled
The Lit + Vite HOMECORE web UI is an example consumer of the sensing stack, not a top-level deliverable — relocate it under examples/ alongside the other sensor and dashboard demos. Add an entry to examples/README.md so it's discoverable. Co-Authored-By: claude-flow <ruv@ruv.net>
70 lines
2.6 KiB
Markdown
70 lines
2.6 KiB
Markdown
# Examples
|
||
|
||
Real-time sensing applications built on the RuView platform.
|
||
|
||
## Unified Dashboard (start here)
|
||
|
||
```bash
|
||
pip install pyserial numpy
|
||
python examples/ruview_live.py --csi COM7 --mmwave COM4
|
||
```
|
||
|
||
The live dashboard auto-detects available sensors and displays fused vitals, environment data, and events in real-time. Works with any combination of sensors.
|
||
|
||
## Individual Examples
|
||
|
||
| Example | Sensors | What It Does |
|
||
|---------|---------|-------------|
|
||
| [**ruview_live.py**](ruview_live.py) | CSI + mmWave + Light | Unified dashboard: HR, BR, BP, stress, presence, light, RSSI |
|
||
| [Medical: Blood Pressure](medical/) | mmWave | Contactless BP estimation from HRV |
|
||
| [Medical: Vitals Suite](medical/vitals_suite.py) | mmWave | 10-in-1: HR, BR, BP, HRV, sleep stages, apnea, cough, snoring, activity, meditation |
|
||
| [Sleep: Apnea Screener](sleep/) | mmWave | Detects breathing cessation events, computes AHI |
|
||
| [Stress: HRV Monitor](stress/) | mmWave | Real-time stress level from heart rate variability |
|
||
| [Environment: Room Monitor](environment/) | CSI + mmWave | Occupancy, light, RF fingerprint, activity events |
|
||
|
||
## Hardware
|
||
|
||
| Port | Device | Cost | What It Provides |
|
||
|------|--------|------|-----------------|
|
||
| COM7 | ESP32-S3 (WiFi CSI) | ~$9 | Presence, motion, breathing, heart rate (through walls) |
|
||
| COM4 | ESP32-C6 + Seeed MR60BHA2 | ~$15 | Precise HR/BR, presence, distance, ambient light |
|
||
|
||
Either sensor works alone. Both together enable fusion (mmWave 80% + CSI 20%).
|
||
|
||
## Quick Start
|
||
|
||
```bash
|
||
pip install pyserial numpy
|
||
|
||
# Unified dashboard (recommended)
|
||
python examples/ruview_live.py --csi COM7 --mmwave COM4
|
||
|
||
# Blood pressure estimation
|
||
python examples/medical/bp_estimator.py --port COM4
|
||
|
||
# Sleep apnea screening (run overnight)
|
||
python examples/sleep/apnea_screener.py --port COM4 --duration 28800
|
||
|
||
# Stress monitoring (workday session)
|
||
python examples/stress/hrv_stress_monitor.py --port COM4 --duration 3600
|
||
|
||
# Room environment monitor
|
||
python examples/environment/room_monitor.py --csi-port COM7 --mmwave-port COM4
|
||
|
||
# CSI only (no mmWave)
|
||
python examples/ruview_live.py --csi COM7 --mmwave none
|
||
```
|
||
|
||
## Web UI
|
||
|
||
| Example | Stack | What It Does |
|
||
|---------|-------|-------------|
|
||
| [**frontend/**](frontend/) | Lit 3 + TypeScript + Vite | HOMECORE web UI — Home Assistant–style dashboard for the sensing stack (ADR-131). Mirrors the cognitum-v0 appliance design system. |
|
||
|
||
```bash
|
||
cd examples/frontend
|
||
npm install
|
||
npm run dev # http://localhost:5173 — proxies /api → http://localhost:8123
|
||
```
|
||
|
||
See [examples/frontend/README.md](frontend/README.md) for the full layout and design tokens.
|