Skip to content

A minimalistic Home Assistant Lovelace card that displays events from your Frigate NVR

License

Notifications You must be signed in to change notification settings

niklaskb/frigate-events-card

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

hacs_badge

Frigate Events Card

Frigate Events Card is a custom Home Assistant Lovelace card that displays events from your Frigate instance in a minimalistic format. This card allows you to easily monitor captured events, including clips, snapshots, and other relevant details.

Features

  • Displays a list of Frigate events (including custom events) with timestamps and confidence scores.
  • Supports filtering based on confidence thresholds.
  • Shows snapshots and clips when available.

Installation

Option 1: Install via HACS (Recommended)

  1. Ensure HACS is Installed

  2. Add the Repository

    • In HACS, navigate to Frontend > Explore & Download Repositories.
    • Search for Frigate Events Card or manually add the repository:
      1. Go to HACS > Settings.
      2. Under "Custom repositories," paste the repository URL (e.g., https://github.com/niklaskb/frigate-events-card) and select Lovelace as the category.
      3. Click Add.
  3. Install the Card

    • Find Frigate Events Card in the HACS Frontend section.
    • Click Download to install.
  4. Add to Resources

    • HACS usually handles resources automatically. Verify the card is added under Settings > Dashboards > Resources:
      url: /hacsfiles/frigate-events-card.js
      type: module
  5. Restart Home Assistant

    • Restart Home Assistant to apply changes.

Option 2: Manual Installation

  1. Download the Card

    • Save the JavaScript file (frigate-events-card.js) to your Home Assistant www directory (e.g., /config/www/).
  2. Add to Resources

    • In Home Assistant, go to Settings > Dashboards > Resources.
    • Add the following resource:
      url: /local/frigate-events-card.js
      type: module
  3. Restart Home Assistant

    • Restart Home Assistant to ensure the card is loaded properly.

Configuration

Add the card to your Lovelace dashboard using the YAML editor or visual editor.

Example Configuration

type: custom:frigate-events-card
timezone: "Europe/Stockholm"
date_locale: "sv-SE"
hour_12: false
label_display_names:
  person: "Person"
  car: "Car"
  ir: "Movement (IR)"
  unknown: "Unknown"
confidence_thresholds:
  camera_driveway: 0.8
  camera_backyard: 0.9
hours_to_show: 48
rows: 7

Configuration Options

Option Type Default Description
instance_id string frigate The Frigate instance ID.
timezone string Required The timezone for displaying timestamps.
date_locale string en-US The locale used for formatting timestamps.
hour_12 boolean true Whether to use a 12-hour or 24-hour clock for timestamps.
hours_to_show number 24 The number of hours of events to display.
max_num_events number 100 The maximum number of events to retrieve.
confidence_thresholds object {} Per-camera confidence thresholds for filtering events.
show_non_confident boolean false Whether to display non-confident events.
label_display_names object {} Custom display names for event labels.
height_percent number 50 The height of the card as a percentage of the viewport.
rows number 5 The number of rows to allocate in grid layouts.

Screenshot

Screenshot

Contributing

Feel free to submit bug reports or feature requests via GitHub Issues. Contributions are welcome!

License

This project is licensed under the MIT License.

About

A minimalistic Home Assistant Lovelace card that displays events from your Frigate NVR

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published