# Home Assistant

## 🏠 Overview
Home Assistant is an open-source home automation platform designed to control and monitor smart devices in a unified way.  
It allows you to integrate a wide range of hardware (lights, sensors, cameras, locks, etc.) and create automations based on events, schedules, or conditions.

## 🚀 What it does
- Centralizes smart home devices into a single interface
- Provides powerful automation capabilities (rules, triggers, conditions)
- Supports local-first operation (no cloud required)
- Offers integrations for hundreds of vendors and protocols
- Enables dashboards, notifications, and voice assistant integrations

## 🌐 Website
- https://www.home-assistant.io/

## ⚙️ Features
- Device integration (Wi-Fi, Zigbee, Z-Wave, Bluetooth, etc.)
- Automation engine (YAML or UI-based)
- Real-time monitoring and history
- Mobile app with push notifications
- Add-ons ecosystem (e.g. MQTT, Node-RED, Frigate)

## 📦 Kubernetes Deployment Notes
- Home Assistant typically requires:
  - Persistent storage (for config, database, and integrations)
  - Host networking **or** access to local network devices (mDNS, broadcasts)
- Common setup includes:
  - PVC for `/config`
  - Optional Ingress for web UI access
- Some integrations (e.g. device discovery, Zigbee bridges) may require:
  - `hostNetwork: true`
  - Additional privileges or device passthrough

## 🔌 Integrations (Examples)
- Cameras (e.g. Reolink, via RTSP/ONVIF)
- Smart locks (e.g. Nuki via Bridge API)
- MQTT (for IoT devices)
- Media systems (e.g. Apple HomeKit, HomePod)
- Presence detection, sensors, automation triggers

## 🎥 Camera & AI Integration
- Works well with:
  - **Frigate** for object detection (requires Coral or GPU for best performance)
- Typical setup:
  - Camera → RTSP → Frigate → MQTT → Home Assistant

## 🔐 Authentication
- Built-in user management
- Can be integrated with external SSO providers (e.g. Authentik, OAuth2 proxy)
- Supports long-lived access tokens for API access

## ⚠️ Things to know
- Best experience when running on a local network with low latency
- Some integrations rely on multicast or broadcast → may not work well in strict Kubernetes networking
- Backups are important (configuration stored in `/config`)
- Frequent updates — breaking changes can occur

## 🧠 Why use it
- Fully local control over smart home devices
- Highly customizable and extensible
- Large community and ecosystem
- Ideal central hub for a self-hosted smart home

## 🔧 Typical Stack in Undercloud
- Home Assistant → central controller
- Frigate → camera AI / detection
- MQTT (e.g. Mosquitto) → messaging backbone
- Zigbee/Z-Wave bridge → device connectivity
- Nuki Bridge → smart lock integration