[home] added initial diagram explaining voice assistant

gruberdev · Feb 2, 2024 · 4877033 · 4877033
1 parent 1ccf80e
commit 4877033
Showing 1 changed file with 45 additions and 2 deletions.
diff --git a/apps/home/README.md b/apps/home/README.md
@@ -1,10 +1,53 @@
 ## Smart home resources
 
-### AI-Related resources
+### Diagram of home-related resources
+
+```mermaid
+%%{init: {"flowchart": {"htmlLabels": false}} }%%
+
+flowchart TD
+ subgraph k8s["Kubernetes"]
+        Satellite["Satellite"]
+        openwakeword["openwakeword"]
+        External-mic["External-mic"]
+        HomeAssistant(["Home Assistant"])
+        LocalAI["LocalAI"]
+        Piper["Piper"]
+        Whisper["Whisper"]
+  end
+    click HomeAssistant "https://github.com/gruberdev/homelab/tree/main/apps/home/ha" "Github app path"
+    click HomeAssistant "https://github.com/gruberdev/homelab/tree/main/apps/home/ha" "Github app path"
+    click External-mic "https://github.com/gruberdev/homelab/tree/main/apps/home/external-mic" "Github app path"
+    click openwakeword "https://github.com/gruberdev/homelab/tree/main/apps/home/openwakeword" "Github app path"
+    click Piper "https://github.com/gruberdev/homelab/tree/main/apps/home/piper" "Github app path"
+    click Whisper "https://github.com/gruberdev/homelab/tree/main/apps/home/whisper" "Github app path"
+    click Satellite "https://github.com/gruberdev/homelab/tree/main/apps/home/satellite" "Github app path"
+    click LocalAI "https://github.com/gruberdev/homelab/tree/main/apps/services/mlops/local-ai" "Github app path"
+    Host_Computer{{"Host Node"}} -- Sending microphone audio --> External-mic
+    External-mic --> Satellite
+    Satellite --> HomeAssistant & openwakeword
+    openwakeword --> HomeAssistant
+    LocalAI <--> HomeAssistant
+    HomeAssistant --> Piper
+    Whisper <--> HomeAssistant
+    Piper -- Transmitting generated assistant voice --> Host_Computer
+   
+    style Satellite fill:#ddf,stroke:#333,stroke-width:2px,stroke-dasharray: 0
+    style openwakeword fill:#fdfd96,stroke:#333,stroke-width:2px
+    style External-mic fill:#ddf,stroke:#333,stroke-width:2px
+    style HomeAssistant fill:#616161,stroke:#333,stroke-width:4px,stroke-dasharray: 0
+    style LocalAI fill:#fdd,stroke:#333,stroke-width:2px
+    style Piper fill:#fd9,stroke:#333,stroke-width:2px
+    style Whisper fill:#bbf,stroke:#333,stroke-width:2px
+    style Host_Computer  fill:#f9f,stroke:#333,stroke-width:2px
+```
 
-- [Training a custom word to activate my smart home voice module (with *openWakeWord*)][oww-train-uri]
 
 
+### AI-Related resources
+
+- [Training a custom word to activate *openWakeWord*][oww-train-uri]
+
 ### General personal resources
 
 - [My Samsung TV update page][samsung-update-tv]