Overview

This node triggers an Analytics Event in Milestone XProtect based on events generated by previous nodes, or a custom trigger condition. This event can be configured in XProtect to trigger an alarm and take other actions.

The event_source property controls how this node is triggered:

built_in (Events from previous nodes): Sends a Milestone Analytics Event for each event generated by other nodes in the pipeline (such as annotate_line_counter, event, etc.). The event name from the previous node is used as the Analytics Event name. When integration_type is rest_api, the Analytics Event is created on the fly if it doesn't already exist.
custom (Custom Event): Sends a single Analytics Event named message when the trigger condition evaluates to true.

1661 — Event/Alarm triggered in Milestone XProtect using Lumeo generated Analytics Event

Inputs & Outputs

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

Properties

Property	Description	Type	Default	Required
`event_source`	Generate Milestone Analytics Events from events generated by other nodes or a Custom defined event. Options: Events from previous nodes (`built_in`); Custom Event (`custom`).	`enum`	`custom`	Yes
`trigger`	Send an event when this condition evaluates to true. Conditional on `event_source` being `custom`.	trigger-condition	`null`	Yes
`enabled`	Enabled	`bool`	`true`	No
`hostname`	Hostname or IP address of server in local network. Conditional on `enabled` being `true`.	`string`	—	Yes
`integration_type`	Select how Lumeo integrates with XProtect. Options: HTTP/XML (`http_xml`): Trigger Analytics events using HTTP/XML. Create Analytics events & setup Alarms in XProtect manually; REST API (`rest_api`): Create & trigger Analytics events using REST API. Setup Alarms in XProtect manually. Requires XProtect 2024 R2 or later. Conditional on `enabled` being `true`.	`enum`	`http_xml`	No
`port`	Analytics Event port as configured in Xprotect VMS. Conditional on `integration_type` being `http_xml`.	`number`	`9090`	No
`username`	XProtect user with the XProtect Administrators role. Can be a Xprotect Basic user or a Windows user. Conditional on `integration_type` being `rest_api`.	`string`	—	No
`password`	Password for the API user. Required if username is provided. Conditional on `integration_type` being `rest_api`.	`string`	—	No
`message`	Name of the Analytics Event that will be sent by Lumeo. Must be one of the Analytics Events as defined in XProtect. When Source is "Events from previous nodes", the event names from previous nodes are used instead. Conditional on `event_source` being `custom`.	`string`	—	Yes
`src`	Unique ID of the Camera from Milestone that this event is associated with. Leave blank if using the Milestone Open Network Bridge as the source to automatically set this. Conditional on `enabled` being `true`.	`string`	`null`	No
`description`	If specified, this will be visible in the Smart Client when managing alarms based on this event. Supports Templates.	`string`	—	No
`event_type`	Event type for the Lumeo-generated event. Supports Templates.	`string`	`null`	No
`include_snapshot`	Include snapshot of event?	`bool`	`true`	No
`interval`	Min. time between consecutive events. Unit: seconds.	`float`	`0`	Yes
`node_filter`	List of nodes that will be passed to event metadata.	`string`	`null`	No

Milestone XProtect Setup

Enable Analytics Events

Lumeo Milestone XProtect Integration uses Analytics Events to send Events to Milestone. To enable them:

Launch XProtect Management Client, and navigate to Tools -> Options menu, and open the Analytics Events tab.
Ensure Analytics Events are Enabled, and Events are allowed from All network addresses, or at least, the IP address of your Lumeo Gateway. Make a note of the Port - to be configured in this node within Lumeo.

Event Configuration

Create a new Analytics Event in XProtect Management Client under Rules and Events -> Analytics Events. Note the Name of this event - to be configured as the Event Name property in this node within Lumeo.

Rules Configuration

Navigate to Rules and Events -> Rules to create Rules (such as setting a Bookmark) that are executed when the Analytics Event is triggered. Note that the set of available Rules may vary depending on which XProtect version you are licensed for.

Alarm Configuration

Navigate to Alarms -> Alarm Definitions to create an Alarm that is triggered when the Analytics Event is triggered. Set:

Trigger: Triggering Event to Analytics Events and pick the Analytic Event you defined in "Event Configuration" section above.
Trigger: Sources to the cameras which you configure as the source in the Lumeo node properties.

To enable viewing all the metadata that Lumeo sends to Milestone, navigate to Alarms -> Alarm Data Settings -> Alarm List Configuration tab and add all options in "Available Columns" to "Selected Columns".

Camera / Source ID

This node allows you to set a Camera ID as the source of the event (in src property). You can obtain this from XProtect Management Client.

Note: If you setup the Milestone Open Network / ONVIF Bridge as a "camera" in Lumeo, and use one of it's streams as the pipeline source, Lumeo will automatically set the correct Camera ID for any alarms / events triggered in Milestone. See section below on how to setup the Bridge as a "camera".

Navigate to Recording Servers section and Ctrl-click on the Camera whose ID you wish to configure as the event source in this node. The properties pane will then show the ID (as highlighted in the image). Copy-paste this into this node's properties.

Configuring XProtect Client

Lumeo generated metadata is available via "Events" in the XProtect Client. Once you have enabled all columns in 'Alarm Data Settings' you will be able to right click the column headers under the Events section and add Rule and Object columns to the Events view. These will contain Lumeo Rule information as well as metadata about any detected objects, etc.

Setting up Milestone ONVIF Bridge in Lumeo

Milestone ONVIF Bridge can be setup as a "Camera" within Lumeo, to bulk import multiple streams and remove the requirement to configure a "Source ID" in the Milestone Node.

Lumeo does not discover the Milestone Bridge automatically. To set it up, use the Add Camera button from a Gateway that can access the Milestone Bridge, and specify the Bridge IP address along with the Port number. Milestone Bridge typically uses Port 580 for ONVIF, so you'd specify it as x.x.x.x:580

Once setup, the Bridge will show up as a Camera in Lumeo, and individual streams will show up under Streams in the Camera detail view.

Output Metadata

Node does not insert any output metadata; upstream metadata continues through the pipeline