improved

Node Metadata Updates - Sept 2021

Metadata format for the LPR, Line Counter, Presence Counter and Queue nodes has been updated to reduce duplicate information, and introduce a uniform structure with new properties that can be used to trigger snapshots, video clip capture, webhooks, etc.

Summary

Metadata format for the following nodes has been updated to reduce duplicate information, and introduce a uniform structure with new properties that can be used to trigger snapshots, video clip capture, webhooks, etc. :

These updates take effect when you create new deployments or update existing ones. Starting and stopping existing deployments will not be impacted.

If you are expecting the old(er) format metadata, you can turn on legacy metadata option in the node property to keep the older format while you transition to the new format.

What's changed

Metadata format updates

With this update, these nodes insert their metadata inside the root field nodes, while previously those nodes used top-level fields like lpr, lines, presence, queue. The contents of those fields have now been moved into nodes.<node_id> as per below:

  • lpr -> nodes.<node_id>.license_plates
  • lines -> nodes.<node_id>.lines
  • presence -> nodes.<node_id>.rois
  • queue -> nodes.<node_id>.rois

To provide for backward compatibility during this transition, the Line Counter Node and License Plate Detection Node have the option to turn ON the legacy metadata format in node properties. Enabling that option will revert the metadata for those deployments to the older format.

New metadata properties

These nodes now add new metadata to make it easier to trigger webhooks, snapshots, etc. based on the difference in counts between previous and current frame. This makes it easier to trigger when a new car is detected, or when a new object crosses a line, etc.

License Plate Recognition

nodes.annotate_lpr1.license_plates_entered_delta
nodes.annotate_lpr1.license_plates_exited_delta
nodes.annotate_lpr1.license_plates_count

Line Counter

nodes.annotate_line_counter1.lines.<line_label>.total_objects_crossed_delta
nodes.annotate_line_counter1.lines.<line_label>.dir1_objects_crossed_delta
nodes.annotate_line_counter1.lines.<line_label>.dir2_objects_crossed_delta

Presence Counter

nodes.annotate_presence1.rois.<roi_label>.objects_entered_delta
nodes.annotate_presence1.rois.<roi_label>.objects_exited_delta
nodes.annotate_presence1.rois.<roi_label>.objects_above_max_time_threshold_count

Queue Length Counter

nodes.annotate_queue1.rois.<roi_label>.objects_entered_delta
nodes.annotate_queue1.rois.<roi_label>.objects_exited_delta
nodes.annotate_queue1.rois.<roi_label>.objects_above_max_waiting_time_count

For specifics of the new format, see node documentation.

What you need to do

  • If you have code that parses Lumeo metadata, either in a Custom Function, or sent to you via webhooks, or from a saved clip, you will need to update it to account for the format changes.
  • If you are using the Publish to Google Sheets node, you will need to update the Metadata to Publish property to look for metadata in the new format. Here's an example of the new property value:
video*,nodes.*.dir1_objects_crossed,nodes.*.dir2_objects_crossed,nodes.*.total_objects_crossed,nodes.*.diff_objects_crossed
  • While you make those changes, you can turn on "Legacy Metadata" format from node properties to retain the old format.