Skip to content

Commit 7ae4c0b

Browse files
committed
Docs: Add Dependencies/Consumers sections and anonymize IPs
1 parent da5464e commit 7ae4c0b

2 files changed

Lines changed: 19 additions & 3 deletions

File tree

docs/smart-home/integrations/ai_reporter.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,3 +374,12 @@ services:
374374
restart: unless-stopped
375375
network_mode: host
376376
```
377+
378+
## 🧩 Consumers
379+
380+
The following Home Assistant packages rely on this integration:
381+
382+
| Package | Description |
383+
| :--- | :--- |
384+
| **[AI Summary](../packages/ai_summary.md)** | Controls the scheduling (7:00 AM) of this reporter and exposes the results as a Sensor. |
385+

docs/smart-home/packages/ai_summary.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,21 @@ This system runs automatically every morning at 7:00 AM.
2828
4. **Notification:** You receive a notification on your phone (and a persistent message in the dashboard) summarizing the health of your smart home.
2929
<!-- END_DETAILED -->
3030

31+
## Integration Dependencies
32+
<!-- START_DEPENDENCIES -->
33+
* **[AI Log Reporter](../integrations/ai_reporter.md)**: Required for log analysis and report generation.
34+
* *Type:* Remote Docker Container
35+
* *Role:* Backend Logic
36+
<!-- END_DEPENDENCIES -->
37+
3138
## Dashboard Connections
3239
<!-- START_DASHBOARD -->
3340
*No linked dashboard views found (Automatic Scan).*
3441
<!-- END_DASHBOARD -->
3542

3643
## Architecture Diagram
3744
<!-- START_MERMAID_DESC -->
38-
The sequence diagram below details the interaction between the local Home Assistant instance and the remote **AI Log Reporter**. The process is initiated by a time-based trigger (7:00 AM) or a manual script invocation. Home Assistant opens a secure SSH tunnel to the remote host (`10.0.0.23`) and executes a Docker command (`docker exec`). The `ai-log-reporter` container processes the logs and, upon completion, fires an asynchronous event (`update_ai_summary`) back to the Home Assistant API. This event payload is captured by a Template Trigger, which updates the permanent `sensor.daily_system_summary`.
45+
The sequence diagram below details the interaction between the local Home Assistant instance and the remote **AI Log Reporter**. The process is initiated by a time-based trigger (7:00 AM) or a manual script invocation. Home Assistant opens a secure SSH tunnel to the remote host (`<REMOTE_HOST_IP>`) and executes a Docker command (`docker exec`). The `ai-log-reporter` container processes the logs and, upon completion, fires an asynchronous event (`update_ai_summary`) back to the Home Assistant API. This event payload is captured by a Template Trigger, which updates the permanent `sensor.daily_system_summary`.
3946
<!-- END_MERMAID_DESC -->
4047

4148
<!-- START_MERMAID -->
@@ -49,7 +56,7 @@ sequenceDiagram
4956
participant Sensor as 🧠 Sensor: daily_system_summary
5057
5158
Sched->>Script: Trigger 7:00 AM
52-
Script->>SSH: ssh root@10.0.0.23 (Exec Reporter)
59+
Script->>SSH: ssh root@<REMOTE_HOST_IP> (Exec Reporter)
5360
activate SSH
5461
SSH->>Remote: docker exec python /app/reporter.py
5562
activate Remote
@@ -86,7 +93,7 @@ shell_command:
8693
ssh -i /config/.ssh/id_rsa_new
8794
-o StrictHostKeyChecking=no
8895
-o UserKnownHostsFile=/dev/null
89-
root@10.0.0.23
96+
root@<REMOTE_HOST_IP>
9097
'docker exec ai-log-reporter python /app/reporter.py'
9198
9299
script:

0 commit comments

Comments
 (0)