Guide: Frigate 0.14 review notifications in HomeAssistant

[NickM-27]

As part of the new Frigate UI events are now intelligently organized into different categories and combined by times of activity. This means that a person delivering a package is one review item instead of having separate events for the person and the package. This behavior is often also desirable for notifications. In Frigate 0.14 there is a new /reviews MQTT topic that can be used for notifications as well.

Automation YAML

alias: Frigate Notifications
description: ""
# The trigger is mqtt and will fire when any camera has an alert
trigger:
  - alias: "topic published to /reviews"
    platform: mqtt
    topic: frigate/reviews
    id: frigate-event
    payload: alert  # this ensures notifications are only received for alerts
    value_template: "{{ value_json['after']['severity'] }}"
    variables:
      zones: "{{ trigger.payload_json['after']['data']['zones'] }}"
      camera: "{{ trigger.payload_json['after']['camera'] }}"
      id: "{{ trigger.payload_json['after']['id'] }}"
      before_objects: "{{ trigger.payload_json['before']['data']['objects'] }}"
      objects: "{{ trigger.payload_json['after']['data']['objects'] }}"
      sub_labels: "{{ trigger.payload_json['after']['data']['sub_labels'] }}"
      events: "{{ trigger.payload_json['after']['data']['detections'] }}"
      type: "{{ trigger.payload_json['type'] }}"
condition:
  - alias: Update has no new objects
    condition: template
    value_template: "{{ type != \"update\" or before_zones | length < after_zones | length }}"
action:
  - choose:
      - conditions:
          - condition: trigger
            id: frigate-event
        sequence:
          # this is a custom notification script, see an example of using the built in notification service below
          - service: script.send_dynamic_notification_to_all_devices
            data:
              id: "{{ id }}"
              title: >-
                {% set data = namespace(labels=[]) %} {% for obj in objects %}
                    {% if "-verified" in obj %}
                    {% else %}
                        {% set data.labels = data.labels + [obj] %}
                    {% endif %}
                {% endfor %} {% set data.labels = data.labels + sub_labels %} {{
                data.labels | unique | list | sort | join(", ") | title }}{{ '
                was' if type == "end" else '' }} detected in {{ zones | join(',
                ') | replace("_", " ") | title }}
              message: Detected on {{ camera | replace("_", " ") | title }}
              notifTag: "{{ id }}"
              notifIcon: >-
                {% if objects[0] == "cat" -%} mdi:cat {%- elif objects[0] ==
                "dog" -%} mdi:dog-service {%- elif objects[0] == "person" and
                type == "end" -%} mdi:account-outline {%- elif objects[0] ==
                "person" -%} mdi:account-clock-outline {%- elif objects[0] ==
                "person-verified" -%} mdi:account-check-outline {%- elif
                objects[0] == "package" -%} mdi:package-variant-closed-check {%-
                elif objects[0] == "amazon" -%} mdi:truck-delivery-outline {%-
                elif objects[0] == "fedex" -%} mdi:truck-delivery-outline {%-
                elif objects[0] == "ups" -%} mdi:truck-delivery-outline {%- elif
                objects[0] == "car" -%} mdi:car-outline {%- elif objects[0] ==
                "car-verified" -%} mdi:car-outline {%- else -%} mdi:cctv {%-
                endif %}
              group: frigate-notification-{{ camera }}
              channel: Frigate
              importance: "{{ \"max\" if type != \"end\" else \"default\" }}"
              label: "{{objects | join(', ')}}"
              camera: "{{camera}}"
              live: |-
                {% if type == "end" -%}
                  https://frigate.storagewhacker.com/review?id={{id}}
                {%- else -%}
                  https://frigate.storagewhacker.com/#{{camera}}
                {%- endif %}
              image: |-
                {% if type == "end" -%}
                  {{undefined}}
                {%- else -%}
                  https://ha.storagewhacker.com/api/frigate/notifications/{{events[0]}}/snapshot.jpg?bbox=1
                {%- endif %}
              video: |-
                {% if type == "end" -%}
                  https://ha.storagewhacker.com/api/frigate/notifications/{{id}}/review_preview.gif?format=ts
                {%- else -%}
                  {{undefined}}
                {%- endif %}
    default: []
mode: parallel
trace:
  stored_traces: 100
max: 10

Example Payload

Here is an example payload

  payload_json:
    type: end  #  new, update, or end
    before:
      id: 1716750796.680641-ao0d9x
      camera: front_doorbell_cam
      start_time: 1716750796.680641
      end_time: 1716750832.273281
      severity: alert  # detection or alert
      thumb_path: >-
        /media/frigate/clips/review/thumb-front_doorbell_cam-1716750796.680641-ao0d9x.webp
      data:
        detections:  # list of event IDs (can be used for getting a snapshot or clip of that object specifically)
          - 1716750795.092463-autt0m
        objects:  # list of object labels
          - person
        sub_labels: []  # list of sub labels
        zones:  # zones that have been entered
          - front_porch
        audio: []  # list of audio labels
    after:
      id: 1716750796.680641-ao0d9x
      camera: front_doorbell_cam
      start_time: 1716750796.680641
      end_time: 1716750832.273281
      severity: alert
      thumb_path: >-
        /media/frigate/clips/review/thumb-front_doorbell_cam-1716750796.680641-ao0d9x.webp
      data:
        detections:
          - 1716750795.092463-autt0m
        objects:
          - person
        sub_labels: []
        zones:
          - front_porch
        audio: []

Simple Notification Service

Reference the HomeAssistant notification docsfor how to customize these.

- service: notify.PHONE_SERVICE
  data:
    title: >-
      {{label | title}} was detected on {{
      trigger.payload_json["after"]["camera"] | replace("_", "
      ") | title }}
    message: >-
      {{label | title}} detected in the {{
      after_zones[0] }}
    data:
      url: >-
      HASS_URL_BASE/api/{{ id }}/{{camera}}/clip.mp4
      tag: '{{ id }}'
      group: frigate-notification-{{camera}}
      clickAction: >-
        HASS_URL_BASE/api/{{id}}/{{camera}}/clip.mp4
      image: >-
        /api/frigate/notifications/{{id}}/snapshot.jpg
      attachment:
        url: >-
          /api/frigate/notifications/{{id}}/snapshot.jpg

[superdong69]

Does this replace the need for SGTBattens blueprint in 0.14? I added the automation portion of your code to my automations.yaml, and created a script using the script portion, but I can't get it to do anything.

[NickM-27]

yes, this is doing the same thing

[fisch55]

@superdong69
does not work for me..... maybe you could show a full example...

[superdong69]

Also doesn't work for me. LOL But I'm having major issues with the update.

[Elder-HVAC-Man]

I need a set up guide for dummies 101.

[NickM-27]

this automation isn't meant to solve that need, for that most likely best to just wait for a blueprint to be offered

[Elder-HVAC-Man]

Thanks for the reply. Will wait on SGTBattens blueprint to be updated. His blueprint works for notifications, just no video stream on my watch.

[SgtBatten]

What's the -verified part doing Nik?

[NickM-27]

So -verified basically points to any object that has a sub label that is not in the labelmap. For example a person that has been tagged by doubletake. The issue in general is that we show this in the UI but there is no way to know just based off of a sub label if it is a person, car, etc. So instead the backend notates these as {label}-verified so we know to show a check mark next to the icon to designate it is a known object.

The logic in this automation is basically trying to filter those out and include the sub labels. It would be redundant for the notification to say person, person-verified, Nick detected in the front yard for example

[ofcedwards]

  id: "{{ trigger.payload_json['after']['id'] }}"

From what I can tell, this is no longer the proper way to reference an event id for the purpose of pulling a thumbnail, snapshot, or clip in a Home Assistant notification. I might be misunderstanding the new system with reviews, but this id seems to refer to the overall review item (which can include multiple objects) and not a singular detection like in 0.13.

To get a thumbnail in a notification like I would with the regular frigate/events topic, I need to set the variable to id: "{{ trigger.payload_json['after']['data']['detections'][0] }}" which you have under the "events" variable.

It would appear that what I'm familiar with as event id's are listed out under "detections" now as an array. This difference is likely why other users are unsuccessful in getting the template to produce a notification. I imagine (like myself), they used your template for the mqtt trigger and paired it with the provided "simple notification service" (which also uses a variable "label" instead of "objects").

These few tweaks seem to have my notifications working like before, but with customization of what causes a notification done through Frigate's alerts vs. detections instead of a bunch of conditions in Home Assistant. Really liking 0.14 so far and I hope this helps someone passing by!

[SgtBatten]

Hi Nick,

I cant seem to get the preview gif to load, even just as a url outside the notification.

[NickM-27]

this endpoint doesn't exist in the latest version of the integration (only in the dev branch) so you might need to edit the file in the custom_component to enable it

[SgtBatten]

ahh okay thanks. bit beyond me at this time of day. will look at it on the weekend. thank you

[NickM-27]

I will look at doing a beta update for that

[Mincka]

Since blakeblackshear/frigate-hass-integration#687 was merged two weeks ago, can we expect the release 5.3.0 of the integration in the coming days? It would be great to have the support of the GIF previews.

[NickM-27]

yes, should be soon

[Morphy99]

Is this info still valid? I get an error when trying to call the notify service:
Error: Error rendering data template: UndefinedError: 'after_zones' is undefined

- id: Camera Alert
  alias: Camera Alert
  mode: restart
  trace:
    stored_traces: 20
  trigger:
    platform: mqtt
    topic: frigate/reviews
    payload: alert
    id: frigate-event
    value_template: "{{ value_json['after']['severity'] }}"
    variables:
      zones: "{{ trigger.payload_json['after']['data']['zones'] }}"
      camera: "{{ trigger.payload_json['after']['camera'] }}"
      id: "{{ trigger.payload_json['after']['id'] }}"
      before_objects: "{{ trigger.payload_json['before']['data']['objects'] }}"
      objects: "{{ trigger.payload_json['after']['data']['objects'] }}"
      sub_labels: "{{ trigger.payload_json['after']['data']['sub_labels'] }}"
      events: "{{ trigger.payload_json['after']['data']['detections'] }}"
      type: "{{ trigger.payload_json['type'] }}"
  condition:
    - alias: Update has no new objects
      condition: template
      value_template: "{{ type != \"update\" or before_zones | length < after_zones | length }}"
    - condition: template
      value_template: "{{ (as_timestamp(now()) - as_timestamp(state_attr('automation.camera_alert', 'last_triggered') | default(0), 0) | int > 30)}}"
  action:
    - service: notify.mobile_app
      data:
        message: >-
          {{label | title}} detected in the {{
          after_zones[0] }}
        title: >-
          {{label | title}} was detected on {{
          trigger.payload_json["after"]["camera"] | replace("_", "
          ") | title }}
        data:
          channel: "Cameras Max"
          ttl: 0
          priority: high
          media_stream: alarm_stream_max
          image: >-
            /api/frigate/notifications/{{id}}/snapshot.jpg
          tag: '{{ id }}'
          url: >-
            https://url/api/{{ id }}/{{camera}}/clip.mp4
          actions:
            - action: URI
              title: Video
              uri: >-
                https://url/api/{{id}}/{{camera}}/clip.mp4
            - action: URI
              title: View Snapshot
              uri: >-
                https://url/api/{{id}}/{{camera}}/snapshot.jpg
            - action: "MUTE_FRONT"
              title: Mute
          clickAction: "/lovelace/cameras-live"

[Morphy99]

Thanks! You're right, half asleep today, frigate already has this filter in alerts.
I still need a condition for camera name edit This works. Thanks again!

    - condition:
        - "{{ 'front' in trigger.payload_json['after']['camera'] }}"

[ofcedwards]

edit This works

I know you fixed it, but the camera names don't appear to be a list, so you could use == for that if you want to. Of course, no reason to change since what you have works. The difference would be that == requires an exact match while in will match anything containing what you provide. So 'front' in cam_name would match cameras named 'front', 'front_door', 'frontyard', 'roadfront' and so on. Only relevant if you have any situations in which the word you provide is contained within the names of multiple cameras.

[Morphy99]

Ah ok, thanks for pointing that out. I'll change to == I'll get to grips with templates one day! 😄
If anyone else needs it, this is the recommended condition to filter by camera:

    - condition:
        - "{{ trigger.payload_json['after']['camera'] == 'front' }}"

[Morphy99]

@ofcedwards I've just noticed this in my HA logs:
Template variable error: 'this' is undefined when rendering '{{ 'on' if (value_json['type'] == 'new' and value_json['after']['severity'] == 'alert') or (value_json['before']['severity'] != value_json['after']['severity']) or (value_json['type'] == 'update' and value_json['after']['severity'] == 'alert' and (now() | as_timestamp - this.attributes.last_triggered | as_timestamp > 20)) else 'off' }}'

The automation seems to be running OK and was wondering if you've got the same or if there's something different about my set up?

[ofcedwards]

That is still my setup for the value_template block of my mqtt trigger. The part referencing this is only acting as a sort of cooldown, so you could delete that portion and still have functionality. If you want a cooldown, you could just add it as a condition instead.

[conorlap]

Is there any way to get the before_zone and after_zone into this?

I have notifications setup so that it only notifies me when something moves from one zone to another in a specific order - this way I don't get notifications for people leaving my house, or a parked car leaving my driveway. Instead I only get notifications for people and cars entering my driveway from an 'outside_driveway' zone etc.

[NickM-27]

Yes, that works the same with this topic as well

[lezruk]

Guys, please explain the logic of detection events in reviews, How can I determine which event in detections list is not removed and has a snapshot/video for end and update types (first|[0]/last/max/random)? Issue is once I get end/update event with alert severity some of the events in detection list (doesn;t matter before or after) are vanished (true for both before or after sections) and I cannot refer them in URL and getting empty snapshot in notification.

[Elder-HVAC-Man]

This is what I changed it to.  Don’t know if it is correct, but the error went away.     `value_template: >- {{ 'on' if (value_json['type'] == 'new' and value_json['after']['severity'] == 'alert') or (value_json['before']['severity'] != value_json['after']['severity']) or (value_json['type'] == 'update' and value_json['after']['severity'] == 'alert' and (now() | as_timestamp - state_attr('automation.frigate_recent_review', 'last_triggered') | as_timestamp > 20)) else 'off' }}` Sent from AT&T Yahoo Mail for iPad On Thursday, October 10, 2024, 2:29 AM, Morphy99 ***@***.***> wrote: @ofcedwards I've just noticed this in my HA logs: Template variable error: 'this' is undefined when rendering '{{ 'on' if (value_json['type'] == 'new' and value_json['after']['severity'] == 'alert') or (value_json['before']['severity'] != value_json['after']['severity']) or (value_json['type'] == 'update' and value_json['after']['severity'] == 'alert' and (now() | as_timestamp - this.attributes.last_triggered | as_timestamp > 20)) else 'off' }}' The automation seems to be running OK and was wondering if you've got the same or if there's something different about my set up? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>