frank/ruvnet--RuView
1
0
Fork 0
mirror of https://github.com/ruvnet/RuView synced 2026-08-04 19:31:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(adr-115): P5 — HA + Matter user guide + semantic primitives metrics + README

Browse Source 
Two new files under docs/integrations/:

- `home-assistant.md` (~340 lines) — operator guide for both protocols:
  * Quick start (Docker + cargo)
  * Entity reference (11 raw + 10 semantic, Matter device-type mapping)
  * Complete CLI matrix (every --mqtt-*, --matter-*, --semantic-* flag)
  * Zone-tag YAML format + threshold-override format
  * Privacy mode contract (HR/BR/pose stripped; semantic primitives preserved)
  * Three starter HA Blueprints per §9.4 maintainer ACK:
      1. Notify on possible distress
      2. Dim hallway when someone sleeping
      3. Wake-up routine on bed exit
  * Lovelace dashboard examples (single-room + multi-node grid)
  * Advanced brokers (EMQX, VerneMQ, HiveMQ Edge)
  * Troubleshooting recipe matrix

- `semantic-primitives-metrics.md` (~120 lines) — per-primitive
  precision/recall reference + methodology for reproducing numbers
  + failure-mode catalogue (v1 → v2 deltas) + threshold-tuning notes.
  Numbers grounded in the 1,077-sample ADR-079 paired-capture held-out
  subset. Open-set caveats explicitly listed.

README.md Documentation section gets two new rows pointing at the
guides plus a "Works with Home Assistant" + "Works with Matter"
positioning line — matches the ambient-intelligence-platform pitch
[[project-ruview-positioning]].

User guide untouched in this commit; will be updated in P6 once the
release lands with concrete version numbers.

Refs #776.

Co-Authored-By: claude-flow <ruv@ruv.net>
This commit is contained in:
ruv
2026-05-23 14:10:42 -04:00
parent b2a692369e
commit 15755fd8a4
3 changed files with 488 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2
View File
@@ -562,6 +562,8 @@ Verify the plugin structure: `bash plugins/ruview/scripts/smoke.sh`. Full detail
|----------|-------------|
| [User Guide](docs/user-guide.md) | Step-by-step guide: installation, first run, API usage, hardware setup, training |
| [Build Guide](docs/build-guide.md) | Building from source (Rust and Python) |
| [**Home Assistant + Matter Integration**](docs/integrations/home-assistant.md) | **Works with Home Assistant** via MQTT auto-discovery + **Works with Matter** (Apple Home / Google Home / Alexa / SmartThings) — full entity catalog, 3 starter blueprints, Lovelace dashboards, privacy mode, threshold tuning ([ADR-115](docs/adr/ADR-115-home-assistant-integration.md)). |
| [Semantic Primitives — Precision/Recall](docs/integrations/semantic-primitives-metrics.md) | Per-primitive F1 on the held-out paired-capture set: someone-sleeping, possible-distress, room-active, elderly-inactivity-anomaly, meeting, bathroom, fall-risk, bed-exit, no-movement, multi-room. |
| [Claude Code / Codex Plugin](plugins/ruview/README.md) | The `ruview` plugin + marketplace — skills, `/ruview-*` commands, agents, and the Codex prompt mirror |
| [Architecture Decisions](docs/adr/README.md) | 96 ADRs — why each technical choice was made, organized by domain (hardware, signal processing, ML, platform, infrastructure) |
| [Domain Models](docs/ddd/README.md) | 8 DDD models (RuvSense, Signal Processing, Training Pipeline, Hardware Platform, Sensing Server, WiFi-Mat, CHCI, rvCSI) — bounded contexts, aggregates, domain events, and ubiquitous language |