From 17f442e0bcd64c30b9a9d5c3f19883680f82ff1a Mon Sep 17 00:00:00 2001
From: tonym <anthonymoon61@gmail.com>
Date: Wed, 1 Oct 2025 23:22:17 -0500
Subject: [PATCH] Add readme.md

---
 readme.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..7ce7360
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,41 @@
+# ha-frigate
+
+Home Assistant and Frigate NVR configuration for intelligent doorbell person detection with debounced notifications.
+
+## Overview
+
+This repository contains configuration files for a doorbell camera setup using Frigate NVR for object detection and Home Assistant for smart notifications. The system detects people approaching the door and sends a single notification per approach, with thumbnails showing the exact moment of detection.
+
+## Hardware
+
+- **Camera:** Amcrest AD110 Video Doorbell
+- **Detection:** CPU-based (3 threads)
+- **Server:** Unraid with Docker
+- **MQTT:** Home Assistant MQTT broker
+
+## Features
+
+- 🎯 Person detection optimized for doorbell camera positioning
+- 📸 Event snapshots with accurate thumbnails in notifications
+- 🔕 Smart notification debouncing (max 1 per minute)
+- 💾 5-day motion-based recording retention
+- 🚀 Low CPU usage with optimized detection parameters
+
+## Files
+
+- `config.yml` - Frigate NVR configuration
+- `doorbell_notification.yaml` - Home Assistant automation
+
+## Frigate Configuration Highlights
+```yaml
+detectors:
+  cpu:
+    type: cpu
+    num_threads: 3
+
+objects:
+  filters:
+    person:
+      min_area: 2000
+      min_score: 0.6
+      threshold: 0.5  # 0.5s detection time before triggering
\ No newline at end of file