From 2403bb9c175d2b3bfee91bf573763d56a86e2766 Mon Sep 17 00:00:00 2001 From: Sam Rolfe Date: Sun, 6 Sep 2026 18:34:17 +1000 Subject: [PATCH] readme: add mermaid system map + link to interactive map on maps.lab --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 489cb89..d74108a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,26 @@ A fully-local, private voice assistant. Say **"Hey Jervis"** and make a request; controls your house, manages your shopping list, and speaks back through your speakers β€” driven by a single LLM "brain" that calls tools. +## System map + +![Interactive map](https://maps.lab.audasmedia.com.au/homeassistant/docs/voice-assistant-map.html) + +```mermaid +flowchart LR + ESP32[ESP32-S3
wake word] -->|audio| WHISPER[Whisper STT] + WHISPER -->|text| AGENT[Jervis Agent
:8501] + AGENT --> HA[Home Assistant
control Β· todo Β· timers] + AGENT --> OMNI[OmniRoute
LLM gateway] + AGENT --> MOPIDY[Mopidy / Spotify
music] + AGENT --> APPRISE[Apprise
notifications] + AGENT --> TTS[Piper TTS] + TTS --> SNAP[Snapcast
multi-room] + SNAP --> SPK[House Speakers] + style AGENT fill:#bbf,stroke:#333,stroke-width:2px +``` + +> πŸ—ΊοΈ **Interactive version** (pan/zoom/search, dark/light, export): [voice-assistant-map.html](https://maps.lab.audasmedia.com.au/homeassistant/docs/voice-assistant-map.html) β€” hosted on `maps.lab.audasmedia.com.au`. Mermaid source: [`docs/voice-assistant.mmd`](docs/voice-assistant.mmd). + ## Docs - **[`docs/overview.md`](docs/overview.md)** β€” the whole architecture in one page (diagram, hosts/IPs/ports, component map). @@ -26,4 +46,4 @@ curl -X POST http://192.168.20.13:8501/voice \ - `sam/speech_piper` β€” TTS β†’ Snapcast - `sam/voice-assistant` β€” **this** overview + API + clients -> Secrets live in `.env` (gitignored) β€” never commit them. \ No newline at end of file +> Secrets live in `.env` (gitignored) β€” never commit them.