Merge 90237c31a5 into f0d69f7856

rm obvious lpr comments
fix (expand) lpr doc link
2026-03-14 12:27:34 +03:00 · 2026-02-21 10:26:08 -06:00 · 2026-02-09 17:59:13 -01:00 · 2026-02-09 17:09:26 -01:00 · 2026-02-09 16:27:37 -01:00 · 2026-02-09 14:52:41 -01:00
1 changed files with 8 additions and 4 deletions
--- a/docs/docs/integrations/mqtt.md
+++ b/docs/docs/integrations/mqtt.md
@ -120,7 +120,7 @@ Message published for each changed tracked object. The first message is publishe

 ### `frigate/tracked_object_update`

-Message published for updates to tracked object metadata, for example:
+Message published for updates to tracked object metadata. All messages include an `id` field which is the tracked object's event ID, and can be used to look up the event via the API or match it to items in the UI.

 #### Generative AI Description Update

@ -134,12 +134,14 @@ Message published for updates to tracked object metadata, for example:

 #### Face Recognition Update

+Published after each recognition attempt, regardless of whether the score meets `recognition_threshold`. See the [Face Recognition](/configuration/face_recognition) documentation for details on how scoring works.
+
 ```json
 {
  "type": "face",
  "id": "1607123955.475377-mxklsc",
-  "name": "John",
-  "score": 0.95,
+  "name": "John", // best matching person, or null if no match
+  "score": 0.95, // running weighted average across all recognition attempts
  "camera": "front_door_cam",
  "timestamp": 1607123958.748393
 }
@ -147,11 +149,13 @@ Message published for updates to tracked object metadata, for example:

 #### License Plate Recognition Update

+Published when a license plate is recognized on a car object. See the [License Plate Recognition](/configuration/license_plate_recognition) documentation for details.
+
 ```json
 {
  "type": "lpr",
  "id": "1607123955.475377-mxklsc",
-  "name": "John's Car",
+  "name": "John's Car", // known name for the plate, or null
  "plate": "123ABC",
  "score": 0.95,
  "camera": "driveway_cam",
Author	SHA1	Message	Date
Kai Curry	c6f4671fd6	Merge `90237c31a5` into `f0d69f7856`	2026-02-21 10:26:08 -06:00
Kai Curry	90237c31a5	rm obvious lpr comments	2026-02-09 17:59:13 -01:00
Kai Curry	91ab990034	fix (expand) lpr doc link	2026-02-09 17:09:26 -01:00
Kai Curry	b6189a6a74	Simplify MQTT tracked_object_update docs with inline comments Move scoring logic details to face recognition docs and keep MQTT reference concise with inline field comments and links.	2026-02-09 16:27:37 -01:00
Kai Curry	565d7ba8b4	Clarify score is a running weighted average	2026-02-09 14:52:41 -01:00
Kai Curry	535fe7aaef	Fix score decimal in MQTT face recognition documentation `0.0` in JSON is just `0`.	2026-02-09 14:48:34 -01:00
Kai Curry	ecad939a62	Add detail to face recognition MQTT update docs Clarify that the weighted average favors larger faces and higher-confidence detections, that unknown attempts are excluded, and document when name/score will be null/0.0.	2026-02-09 14:36:35 -01:00