Skip to content

Commit 648276a

Browse files
committed
Update Navi
1 parent c5337df commit 648276a

3 files changed

Lines changed: 32 additions & 8 deletions

File tree

docs/index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,23 @@ Welcome to the EvisHomeLab documentation.
1414
* **Tools:** Home Assistant OS, Antigravity IDE, Git, MkDocs Material
1515

1616
[📖 **Read the full System Setup & Maintenance Manual**](system_manual/setup_guide.md)
17+
18+
## High Level Architecture
19+
20+
The system integrates various smart home technologies into a cohesive platform.
21+
22+
### Core System
23+
- **Hub:** Home Assistant OS
24+
- **Zigbee:** 2x Zigbee2MQTT networks (Main & Secondary)
25+
- **Voice:** Home Assistant Assist (Wake Words & Pipelines)
26+
- **Logic:** HACS Pyscript + Node-RED
27+
28+
### Key Integrations
29+
| Domain | Technologies / Brands |
30+
| :--- | :--- |
31+
| **Climate & Air** | Philips Air Purifier, Airthings Wave (BLE), Aqara W500 |
32+
| **Appliances** | LG Dishwasher (ThinQ), Shelly 3EM (Energy) |
33+
| **Automotive** | Mercedes GLC (Mercedes Me), Garmin, Car Sensors |
34+
| **Multimedia** | DNA TV Hub, Office PC (IoT Link) |
35+
| **Logic & Data** | Nordpool Energy Prices, Home Time Modes, Scenes |
36+
| **System** | Smart Notifications (Router), Room Automation (MQTT Dynamic), Fingerprint Mgmt |

docs/smart-home/structure.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ An overview of the key directories and files in the Home Assistant root folder.
1515
| **`docs_site/`** | This documentation repository and MkDocs site structure. |
1616
| **`esphome/`** | ESPHome configuration YAML files and compilation artifacts (binaries). |
1717
| **`include/`** | Split configuration files referenced from `configuration.yaml` to keep it clean. |
18+
| **`model_cache/`** | Cache for local AI models (Wake words, assist pipelines). |
1819
| **`node-red/`** | Storage for Node-RED flows and settings (if the add-on is used). |
1920
| **`packages/`** | Configuration split into logical "packages" (bundling automations, scripts, configuration by feature). |
2021
| **`pyscript/`** | Python scripts and apps for the `pyscript` integration. |
2122
| **`themes/`** | Frontend themes definition files. |
2223
| **`tts/`** | Text-to-speech cache or configuration. |
2324
| **`www/`** | Publicly accessible folder mapped to `/local/` for hosting custom cards, images, and resources. |
2425
| **`zigbee2mqtt/`** | Zigbee2MQTT data directory containing configuration and database. |
26+
| **`zigbee2mqtt-2/`** | Secondary Zigbee2MQTT instance data directory. |
2527
| **`automations.yaml`** | The main file for storing automations, commonly managed via the UI. |
2628
| **`configuration.yaml`** | The main configuration file for Home Assistant. |
2729
| **`scenes.yaml`** | Configuration file for defining scenes. |

docs/system_manual/setup_guide.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,21 +88,23 @@ Run these commands in order to keep everything synced.
8888

8989
**Task: Standardize Package Headers**
9090
> "Scan `packages/`. Check headers. If missing/legacy, prepend:
91-
> ```yaml
92-
> # ------------------------------------------------------------------------------
93-
> # Package: [Filename]
94-
> # Version: 1.0.0
95-
> # Description: [Summary]
96-
> # Dependencies: [Entities used]
97-
> # ------------------------------------------------------------------------------
98-
> ```"
91+
>
92+
> ```yaml
93+
> # ------------------------------------------------------------------------------
94+
> # Package: [Filename]
95+
> # Version: 1.0.0
96+
> # Description: [Summary]
97+
> # Dependencies: [Entities used]
98+
> # ------------------------------------------------------------------------------
99+
> ```"
99100
100101
**Task: Update Single Package (Focus Mode)**
101102
> "Run `python ag_update_package.py [package_name]`."
102103
> *(Fallback: "Update `[package].md` reading from `[package].yaml`. Check `auto_update` lock.")*
103104
104105
**Task: Update Architecture (Structure & Overview)**
105106
> "Update `docs_site/docs/smart-home/structure.md` AND `docs_site/docs/index.md`.
107+
>
106108
> 1. **Structure:** Re-scan root. Update file tree.
107109
> 2. **Overview:** Update 'High Level Architecture' with new integrations."
108110

0 commit comments

Comments
 (0)