{"id":45304547,"url":"https://github.com/awayman/frigate-identity-ha","last_synced_at":"2026-04-08T06:01:20.142Z","repository":{"id":339127383,"uuid":"1160576255","full_name":"awayman/frigate-identity-ha","owner":"awayman","description":"Home Assistant custom component for person identification and tracking using Frigate Identity Service","archived":false,"fork":false,"pushed_at":"2026-04-03T03:34:38.000Z","size":291,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-03T12:33:23.715Z","etag":null,"topics":["frigate","hacs","home-assistant"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/awayman.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-18T05:31:35.000Z","updated_at":"2026-04-03T03:34:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/awayman/frigate-identity-ha","commit_stats":null,"previous_names":["awayman/frigate-identity-ha"],"tags_count":41,"template":false,"template_full_name":null,"purl":"pkg:github/awayman/frigate-identity-ha","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awayman%2Ffrigate-identity-ha","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awayman%2Ffrigate-identity-ha/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awayman%2Ffrigate-identity-ha/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awayman%2Ffrigate-identity-ha/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/awayman","download_url":"https://codeload.github.com/awayman/frigate-identity-ha/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awayman%2Ffrigate-identity-ha/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31542384,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"online","status_checked_at":"2026-04-08T02:00:06.127Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["frigate","hacs","home-assistant"],"created_at":"2026-02-21T06:15:49.028Z","updated_at":"2026-04-08T06:01:19.845Z","avatar_url":"https://github.com/awayman.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"﻿# Frigate Identity - Home Assistant Integration\r\n\r\nA Home Assistant custom component that integrates with the [Frigate Identity Service](https://github.com/awayman/frigate_identity_service) to provide person identification continuity and location tracking.\r\n\r\n## Table of Contents\r\n\r\n- [Features](#features)\r\n- [Quick Setup (5 steps)](#quick-setup-5-steps)\r\n- [What Gets Created](#what-gets-created)\r\n- [Blueprints](#blueprints)\r\n- [Dashboard](#dashboard)\r\n- [Configuration](#configuration)\r\n  - [Config Flow](#config-flow)\r\n  - [Person Profile Services](#person-profile-services)\r\n- [Services](#services)\r\n- [Snapshot Sources](#snapshot-sources)\r\n- [MQTT Topics](#mqtt-topics)\r\n- [Installation](#installation)\r\n  - [HACS (Recommended)](#hacs-recommended)\r\n  - [Manual Installation](#manual-installation)\r\n- [Troubleshooting](#troubleshooting)\r\n  - [Integration not showing sensors](#integration-not-showing-sensors)\r\n  - [Dashboard not appearing](#dashboard-not-appearing)\r\n  - [Debug Logging](#debug-logging)\r\n- [Support](#support)\r\n- [License](#license)\r\n\r\n## Features\r\n\r\n- **Real-time person identification** — Uses Frigate's facial recognition as primary source\r\n- **ReID continuity** — Maintains identity when faces are not visible\r\n- **Per-person tracking** — Track location, zones, and confidence for each person\r\n- **Live snapshots** — Per-person MQTT camera entities created automatically\r\n- **Auto-generated dashboard** — Dedicated Lovelace dashboard created and updated automatically\r\n- **Supervision tracking** — Binary sensors track if children are supervised by adults\r\n- **Blueprint automations** — Safety blueprints auto-deployed to HA on integration load\r\n- **Vehicle detection** — Safety alerts when vehicles detected with children outside\r\n- **Zone-aware** — Uses HA Areas for cross-camera zone grouping\r\n- **Config flow UI** — Full setup via Settings → Integrations (no YAML editing)\r\n- **Person profile services** — Mark children/adults and define per-child safe zones from HA services\r\n- **Debug controls** — Toggle Frigate Identity Service debug mode from Home Assistant\r\n- **HACS auto-update** — Install via HACS, get updates automatically\r\n\r\n## Quick Setup (5 steps)\r\n\r\n📘 **Full walkthrough**: [QUICK_START.md](QUICK_START.md)\r\n\r\n1. **Install Frigate Identity Service** and verify it is publishing person events to MQTT\r\n2. **Install via HACS**: Add `https://github.com/awayman/frigate-identity-ha` as a custom repository\r\n3. **Restart Home Assistant**\r\n4. **Settings → Integrations → Add → Frigate Identity** — configure MQTT prefix and snapshot/dashboard options\r\n5. **Done!** — sensors, cameras, dashboard, and blueprints are all created automatically\r\n\r\n## What Gets Created\r\n\r\nAfter adding the integration, the following entities are automatically created:\r\n\r\n| Entity | Description |\r\n|---|---|\r\n| `sensor.frigate_identity_last_person` | Last detected person name + attributes |\r\n| `sensor.frigate_identity_all_persons` | Count of all tracked persons + data dict |\r\n| `sensor.frigate_identity_\u003cname\u003e_location` | Per-person: state = camera, attrs = zones/confidence/source |\r\n| `camera.frigate_identity_\u003cname\u003e_snapshot` | Per-person MQTT camera with latest cropped snapshot |\r\n| `binary_sensor.frigate_identity_\u003cname\u003e_supervised` | Per-child: is a trusted adult nearby? |\r\n| `switch.frigate_identity_manual_supervision` | Manual supervision override for notification handlers |\r\n\r\nPersons are discovered from Home Assistant `person.*` entities on startup and from MQTT messages at runtime.\r\nNew persons detected via MQTT get entities created dynamically.\r\n\r\n## Blueprints\r\n\r\nBlueprints are **automatically deployed** to `/config/blueprints/automation/frigate_identity/` when the integration loads. Go to **Settings → Automations → Blueprints** to use them:\r\n\r\n| Blueprint | Purpose |\r\n|---|---|\r\n| Child Danger Zone Alert | Alert when child enters a dangerous zone without supervision |\r\n| Unknown Person Alert | Alert when an unrecognised person is detected |\r\n| Supervision Detection | Template binary sensor for child supervision tracking |\r\n| Vehicle with Children Outside | Alert when vehicle detected and children are outside |\r\n| Notification Action Handlers | Handle \"Adult Present\" and \"View Camera\" notification buttons |\r\n\r\n## Dashboard\r\n\r\nA dedicated Lovelace dashboard (`/lovelace/frigate-identity`) is auto-generated and updated. It includes:\r\n\r\n- Header with person tracker status\r\n- Person cards grouped by HA Area (or flat layout if no areas assigned)\r\n- Each person card shows: snapshot, location, zones, confidence, source, last seen\r\n- Children's cards include a supervised status row\r\n\r\nThe dashboard regenerates automatically when:\r\n- New persons are discovered\r\n- HA Area assignments change\r\n- Daily at a configurable time (default 03:00)\r\n\r\nTo manually refresh: call the `frigate_identity.regenerate_dashboard` service.\r\n\r\n## Configuration\r\n\r\n### Config Flow\r\n\r\nAll settings are configured via the UI:\r\n\r\n| Setting | Default | Description |\r\n|---|---|---|\r\n| MQTT topic prefix | `identity` | Prefix for MQTT topics (e.g., `identity/person/#`) |\r\n| Snapshot source | `mqtt` | `mqtt`, `frigate_api`, or `frigate_integration` |\r\n| Auto-generate dashboard | `true` | Automatically create/update the dedicated dashboard |\r\n| Dashboard refresh time | `03:00` | Daily dashboard refresh time (HH:MM) |\r\n| Dashboard name | `Kids` | Sidebar title used for the dedicated Lovelace dashboard |\r\n\r\nChange settings any time via **Settings → Integrations → Frigate Identity → Configure**.\r\n\r\n### Person Profile Services\r\n\r\nUse Home Assistant services to mark children and define safe zones directly from HA.\r\n\r\n#### `frigate_identity.update_person_profile`\r\n\r\nFields:\r\n- `person_name` (required): Person display name\r\n- `is_child` (optional): `true` for child, `false` for adult\r\n- `safe_zones` (optional): list of Frigate zone names where the child can be unsupervised\r\n\r\nExample service call:\r\n\r\n```yaml\r\nservice: frigate_identity.update_person_profile\r\ndata:\r\n  person_name: Alice\r\n  is_child: true\r\n  safe_zones:\r\n    - safe_play_area\r\n    - patio\r\n```\r\n\r\n#### `frigate_identity.update_child_safe_zones`\r\n\r\nBackward-compatible alias for updating safe zones only.\r\n\r\n```yaml\r\nservice: frigate_identity.update_child_safe_zones\r\ndata:\r\n  person_name: Alice\r\n  safe_zones:\r\n    - safe_play_area\r\n\r\n## Services\r\n\r\nThe integration registers these Home Assistant services:\r\n\r\n| Service | Purpose |\r\n|---|---|\r\n| `frigate_identity.regenerate_dashboard` | Force dashboard regeneration immediately |\r\n| `frigate_identity.get_registry_status` | Log current person registry state for troubleshooting |\r\n| `frigate_identity.set_debug_mode` | Publish debug on/off command to Frigate Identity Service |\r\n| `frigate_identity.clear_embeddings` | Request full embedding-store clear in Frigate Identity Service |\r\n| `frigate_identity.update_person_profile` | Set child/adult status and safe zones for a person |\r\n| `frigate_identity.update_child_safe_zones` | Backward-compatible alias for safe-zones-only updates |\r\n```\r\n\r\nExample service call from Developer Tools:\r\n\r\n```yaml\r\nservice: frigate_identity.clear_embeddings\r\ndata:\r\n  reason: manual reset from HA Developer Tools\r\n```\r\n\r\n## Snapshot Sources\r\n\r\n| Mode | Snapshot entity | Needs Frigate integration | Needs MQTT camera config |\r\n|---|---|---|---|\r\n| `mqtt` *(default)* | `camera.frigate_identity_\u003cname\u003e_snapshot` | No | Automatic |\r\n| `frigate_api` | `image.frigate_identity_\u003cname\u003e_snapshot_image` | No | No |\r\n| `frigate_integration` | `image.\u003cperson\u003e_person` | Yes | No |\r\n\r\n## MQTT Topics\r\n\r\nThe integration subscribes to these topics (prefix is configurable):\r\n\r\n| Topic | Purpose |\r\n|---|---|\r\n| `identity/person/#` | Person identification events (JSON) |\r\n| `identity/snapshots/{person}` | Cropped JPEG snapshots per person |\r\n\r\n**Message format:**\r\n```json\r\n{\r\n  \"person_id\": \"Alice\",\r\n  \"camera\": \"backyard\",\r\n  \"confidence\": 0.94,\r\n  \"source\": \"facial_recognition\",\r\n  \"frigate_zones\": [\"safe_play_area\"],\r\n  \"event_id\": \"1708286380-abc\",\r\n  \"timestamp\": 1708286400000,\r\n  \"snapshot_url\": \"http://frigate:5000/api/events/1708286380-abc/thumbnail.jpg?crop=1\"\r\n}\r\n```\r\n\r\n## Installation\r\n\r\n### HACS (Recommended)\r\n\r\n1. Open HACS → Integrations\r\n2. Click ⋮ menu → **Custom repositories**\r\n3. Add `https://github.com/awayman/frigate-identity-ha`, category **Integration**\r\n4. Click **Install** → **Restart Home Assistant**\r\n5. **Settings → Integrations → Add → Frigate Identity**\r\n\r\n### Manual Installation\r\n\r\nCopy the `custom_components/frigate_identity` folder to your HA config directory, restart HA, then add via Settings → Integrations.\r\n\r\n## Troubleshooting\r\n\r\n### Integration not showing sensors\r\n\r\n1. Verify MQTT is configured and the identity service is publishing\r\n2. Check the MQTT topic prefix matches (default: `identity`)\r\n3. Enable debug logging:\r\n   ```yaml\r\n   logger:\r\n     logs:\r\n       custom_components.frigate_identity: debug\r\n   ```\r\n\r\n### Dashboard not appearing\r\n\r\n1. Dashboard auto-generation requires Lovelace in storage mode (the default)\r\n2. Call `frigate_identity.regenerate_dashboard` service to force refresh\r\n3. Check HA logs for dashboard push errors\r\n\r\n### Debug Logging\r\n\r\n```yaml\r\nlogger:\r\n  logs:\r\n    homeassistant.components.mqtt: debug\r\n    custom_components.frigate_identity: debug\r\n```\r\n\r\n## Support\r\n\r\n- **Integration issues**: [GitHub Issues](https://github.com/awayman/frigate-identity-ha/issues)\r\n- **Service issues**: [frigate_identity_service](https://github.com/awayman/frigate_identity_service/issues)\r\n\r\n## License\r\n\r\nSee [LICENSE](LICENSE) file for details.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fawayman%2Ffrigate-identity-ha","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fawayman%2Ffrigate-identity-ha","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fawayman%2Ffrigate-identity-ha/lists"}