Milestone
uniflow.plugin.milestone •
Category: Security & Video •
Version: v1.0.3
Milestone Plugin Reference Manual
1. Overview
Plugin Name: Milestone
Type: Security & Video
Identifier: uniflow.plugin.milestone
Description
Integration with Milestone XProtect via Web Endpoint API.
2. Configuration Parameters
The following configuration fields are available in the User Interface for this plugin:
| Configuration Setting | Description |
|---|---|
| Management Server Address | Specifies the management server address. |
| Username | Specifies the username. |
| Password | Specifies the password (secure). |
| Connect Timeout (ms) | Numeric value specifying the connect timeout (ms). |
| Reconnect Delay (ms) | Specifies the reconnect delay (ms). |
| Use SSL | Specifies the use ssl. |
| Ignore SSL Errors | Specifies the ignore ssl errors. |
| Poll Cameras | Specifies the poll cameras. |
| Poll Alarms | Specifies the poll alarms. |
| Poll System Config (Event Types & Priorities) | Specifies the poll system config (event types & priorities). |
| Use WebSockets for Real-time Events | Specifies the use websockets for real-time events. |
3. Exposed Routes & Data Types
The following routes are available in the Uniflow catalog for this plugin:
| Display Name | Route ID | Kind | Category | Access | Data Type |
|---|---|---|---|---|---|
| Milestone Trigger Event | milestone:event:trigger | Value | ? | Write | String |
| Milestone Trigger Alarm | milestone:action | Value | ? | Write | String |
| string.IsNullOrWhiteSpace(e.DisplayName) ? e.Name : e.DisplayName | e.Name | Event | ? | Listen | Event Object |
| string.IsNullOrWhiteSpace(e.DisplayName) ? e.Name : e.DisplayName | e.Name | Event | ? | Listen | Event Object |
| displayName | id | Value | Collections | Read | Json |
Route Parameters: Milestone Trigger Event
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|---|---|---|
Type | EventGuid | String | true |
Source | EventSourceGuid | String | false |
Datatype | DataType | String | false |
Tag | Tag | String | false |
Route Parameters: Milestone Trigger Alarm
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|---|---|---|
Name | Name | String | true |
Message | Message | String | true |
Source | Source | String | true |
Priority | Priority | String | false |
Category | Category | String | false |
State | State | String | false |
Tag | Tag | String | false |
4. Usage Examples
Scenario A: Reading/Monitoring Data
To monitor data from Milestone, add the corresponding Input Node in the Rule Editor and select the desired property from the catalog. Link its output to any logical comparison or directly to an Action Node.
Scenario B: Triggering Actions
If the plugin supports writable properties or actions, use an Action Node in the Rule Editor. Configure the Target property to point to the Milestone action, and supply any required parameters mapping from your rule's logic.