Publish to Lumeo Dashboard

Publish metrics to Lumeo Dashboard for charting and visualization.

Overview

This node is publishes pipeline metadata to Lumeo Dashboards periodically or when a trigger condition is met. You can use it for reporting and dashboards.

How to Use

This node can publish 3 types of metadata to the Lumeo Dashboard.

Metadata TypeDescriptionWhen to Use
Node MetadataThis includes Node-specific metadata such as Line Counter Node's line crossing metadata or Occupancy Monitor node's occupancy metadata. Refer to Node's documentation for information on what metadata is published to the Dashboard.Use it to publish Node-specific stats such as line crossings, or occupancy numbers.
Object Attributes MetadataThis includes object types and object attributes that are added to an object by AI Model Node or specific Recognition nodes.Use it to capture and display attributes (such as license plate numbers, vehicle types, barcode values, colors, etc.) \n \nNote that if you are just trying to count object attributes you are better served by using the Node Metadata instead of publishing Object Attributes.
Event MetadataThis publishes an event to the Dashboard every time specific Trigger Conditions are met.Use it to publish counts of custom events that are not already being published by Node metadata -- such as a car making an illegal left turn.

Dashboard Setup

After deploying a Pipeline with this node, create a Lumeo Dashboards and add a Data widget to it to visualize the data.

Inputs & Outputs

  • Inputs : 1, Media Format : Raw Video
  • Outputs : 1, Media Format: Raw Video
  • Output Metadata : None

Properties

PropertyDescriptionTypeDefaultRequired
nodes_to_publishControls which node metadata to publish. Options:
- none: Disable publishing
- all: Publish all supported nodes
- specific: Publish only specified nodes
enumallNo
node_ids_to_publishPublish metadata for the specified Node ID, when nodes_to_publish is set to specific.
Ex. annotate_line_counter1, annotate_queue1
nodenullYes
triggerPublish node metadata when this condition evaluates to true. Uses default triggers if not specified. Example: nodes.annotate_line_counter1.lines.line1.dir1_objects_crossed_delta > 0trigger-conditionnullNo
objects_to_publishControls which object metadata to publish. Options:
- none: Disable publishing
- node_related: Publish objects related to specified node
- pattern_matched_objects: Publish objects matching metadata pattern
- type_matched_objects: Publish objects of specific types
enumnoneNo
object_match_patternsMetadata patterns to match objects to publish. Only used when objects_to_publish is set to pattern_matched_objects. Example: nodes.*.*.*.cur_dir1_objectsmetadata-listnullNo
object_typesObject types to publish (blank means process all). Only used when objects_to_publish is set to type_matched_objects. Example: car,person,car.redmodel-labelnullNo
event_typeMetrics event type to publish. Used to filter or count specific events in dashboard. Example: car_stop_and_gostringnullNo
event_triggerPublish metrics event when this condition evaluates to true. Example: nodes.annotate_line_counter1.lines.line1.dir1_objects_crossed_delta > 0trigger-conditionnullNo
metrics_tagTag to apply to published metrics for filtering/grouping in dashboard. Example: mymetricstringnullNo
objects_only_new_updatedIf true, only publish objects when first seen. If false, publish both new and updated objectsbooltrueNo
object_track_lifespanNumber of frames to track objects to prevent duplicate reporting when new/updated option is setnumber600No
intervalMinimum time in seconds between consecutive publish actionsfloat5No
use_stream_clockIf true, report timestamps from stream for correct timing when processing filesboolfalseNo
use_camera_as_sourceIf true, report linked camera as source for camera streams and Universal bridge clipsboolfalseNo

Metadata

This node does not add any new metadata to the frame.

Metadata PropertyDescription
NoneNone