Mirrors/blakeblackshear.frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2024-11-21 19:07:46 +01:00
Code Issues Projects Releases Wiki Activity

docs updates for notification changes

Browse Source
This commit is contained in:
Blake Blackshear 2021-01-16 11:38:19 -06:00
parent eb0a5e1c55
commit d84b75168c
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -790,7 +790,7 @@ automation:
data_template: data_template:
message: 'A {{trigger.payload_json["after"]["label"]}} was detected.' message: 'A {{trigger.payload_json["after"]["label"]}} was detected.'
data: data:
image: 'https://your.public.hass.address.com/api/frigate/notifications/{{trigger.payload_json["after"]["id"]}}.jpg?format=android' image: 'https://your.public.hass.address.com/api/frigate/notifications/{{trigger.payload_json["after"]["id"]}}/thumbnail.jpg?format=android'
tag: '{{trigger.payload_json["after"]["id"]}}' tag: '{{trigger.payload_json["after"]["id"]}}'
``` ```
Note that the image url has `?format=android`. This adjusts the aspect ratio to be idea for android notifications. For iOS optimized snapshots, no format parameter needs to be passed. Note that the image url has `?format=android`. This adjusts the aspect ratio to be idea for android notifications. For iOS optimized snapshots, no format parameter needs to be passed.
@ -941,8 +941,8 @@ Returns summary data for events in the database. Used by the HomeAssistant integ
### `/api/events/<id>` ### `/api/events/<id>`
Returns data for a single event. Returns data for a single event.
### `/api/events/<id>/snapshot.jpg` ### `/api/events/<id>/thumbnail.jpg`
Returns a snapshot for the event id optimized for notifications. Works while the event is in progress and after completion. Passing `?format=android` will convert the thumbnail to 2:1 aspect ratio. Returns a thumbnail for the event id optimized for notifications. Works while the event is in progress and after completion. Passing `?format=android` will convert the thumbnail to 2:1 aspect ratio.
### `/clips/<camera>-<id>.mp4` ### `/clips/<camera>-<id>.mp4`
Video clip for the given camera and event id. Video clip for the given camera and event id.

6
docs/notification-examples.md
View File

@ -32,7 +32,7 @@ automation:
data_template: data_template:
message: "A {{trigger.payload_json['after']['label']}} has left the yard." message: "A {{trigger.payload_json['after']['label']}} has left the yard."
data: data:
image: "https://url.com/api/frigate/notifications/{{trigger.payload_json['after']['id']}}.jpg" image: "https://url.com/api/frigate/notifications/{{trigger.payload_json['after']['id']}}/thumbnail.jpg"
tag: "{{trigger.payload_json['after']['id']}}" tag: "{{trigger.payload_json['after']['id']}}"
- alias: Notify for dogs in the front with a high top score - alias: Notify for dogs in the front with a high top score
@ -48,7 +48,7 @@ automation:
data_template: data_template:
message: 'High confidence dog detection.' message: 'High confidence dog detection.'
data: data:
image: "https://url.com/api/frigate/notifications/{{trigger.payload_json['after']['id']}}.jpg" image: "https://url.com/api/frigate/notifications/{{trigger.payload_json['after']['id']}}/thumbnail.jpg"
tag: "{{trigger.payload_json['after']['id']}}" tag: "{{trigger.payload_json['after']['id']}}"
``` ```
@ -66,6 +66,6 @@ automation:
data: data:
photo: photo:
# this url should work for addon users # this url should work for addon users
- url: 'http://ccab4aaf-frigate:5000/events/{{trigger.payload_json["after"]["id"]}}/snapshot.jpg' - url: 'http://ccab4aaf-frigate:5000/api/events/{{trigger.payload_json["after"]["id"]}}/thumbnail.jpg'
caption : 'A {{trigger.payload_json["after"]["label"]}} was detected on {{ trigger.payload_json["after"]["camera"] }} camera' caption : 'A {{trigger.payload_json["after"]["label"]}} was detected on {{ trigger.payload_json["after"]["camera"] }} camera'
``` ```