sam/voice-assistant
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme: add mermaid system map + link to interactive map on maps.lab

Browse Source
This commit is contained in:
Sam Rolfe
2026-09-06 18:34:17 +10:00
parent e323dd0fe0
commit 2403bb9c17
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -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 — controls your house, manages your shopping list, and speaks back through your speakers —
driven by a single LLM "brain" that calls tools. 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<br/>wake word] -->|audio| WHISPER[Whisper STT]
WHISPER -->|text| AGENT[Jervis Agent<br/>:8501]
AGENT --> HA[Home Assistant<br/>control · todo · timers]
AGENT --> OMNI[OmniRoute<br/>LLM gateway]
AGENT --> MOPIDY[Mopidy / Spotify<br/>music]
AGENT --> APPRISE[Apprise<br/>notifications]
AGENT --> TTS[Piper TTS]
TTS --> SNAP[Snapcast<br/>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
- **[`docs/overview.md`](docs/overview.md)** — the whole architecture in one page (diagram, hosts/IPs/ports, component map). - **[`docs/overview.md`](docs/overview.md)** — the whole architecture in one page (diagram, hosts/IPs/ports, component map).