Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 2.53 KB

README.md

File metadata and controls

77 lines (59 loc) · 2.53 KB
Raw

Clips

demo

Clips is a thumbnail generation tool. It will receive a Frigate event once it is finished and turn it into a short 5 second video clip. After generation, it publishes an event to frigate/clips topic which allows for automation (sending a notification of the recording).

Container Images Tags: 0.0.1

Running Clips

Dependencies

  • MQTT
  • Frigate

Setup

  1. Copy docker-compose.yml to the server running Frigate in Docker
  2. Using the config.yml as a template, create a config file and place in a location accessible to Docker
  3. Run docker compose up -d to run the project

Home Assistant

Recommended Flow

  1. Frigate publishes new event of a detection to MQTT
  2. Home Assistant triggers a new push notification to a device using the after.id property as a tag key from the trigger.payload_json.
  3. Clips receives the MQTT new event message from the frigate/events topic and generates a clip if the event is an end (detection is complete).
  4. Clips publishes a complete event on the frigate/clips MQTT topic
  5. Home assistant triggers a new push notification to update the existing notification using the after.id property as a tag key
  6. User can see looping clip on mobile device

Setup

  • Create or edit an existing Frigate notification automation
  • Add a trigger of MQTT event trigging by event on topic frigate/clips
  • Using the notify service, publish a notification using the below block as a template: 
    - service: notify.notify
  data:
    message: A {{ trigger.payload_json['after']['label'] }} was detected on the {{ trigger.payload_json['after']['camera'] }} camera.
    data:
      tag: "{{ trigger.payload_json['after']['id'] }}"
      group: frigate
      video: "https://<my_clips_endpoint>{{ trigger.payload_json['clip_url'] }}"
      push:
        sound: none

Notes

You can simplify the setup by using variables in your automation:

variables:
  payload: "{{ trigger.payload_json }}"
  after: "{{ payload.after }}"
  label: "{{ after.label }}"
  camera: "{{ after.camera }}"
  clipPath: "{{ payload.clip_uri }}"

Notify

- service: notify.notify
  data:
    message: A {{ label }} was detected on the {{ camera }} camera.
    data:
      tag: "{{ id }}"
      group: frigate
      video: "https://<my_clips_endpoint>{{ clipPath }}"
      push:
        sound: none