Avigilon
uniflow.plugin.avigilon •
Category: Security & Video •
Version: v1.0.7
Avigilon Plugin Reference Manual
1. Overview
Plugin Name: Avigilon
Type: Security & Video
Identifier: uniflow.plugin.avigilon
Description
Integration with Avigilon Control Center via Web Endpoint API.
2. Configuration Parameters
The following configuration fields are available in the User Interface for this plugin:
| Configuration Setting | Description |
|---|---|
| Base URL | Specifies the base url. |
| Username | Specifies the username. |
| Password | Specifies the password (secure). |
| Client Name | Specifies the client name. |
| Site Name Filter | Specifies the site name filter. |
| User Nonce | Specifies the user nonce. |
| User Key | Specifies the user key. |
| Connect Timeout (ms) | Numeric value specifying the connect timeout (ms). |
| Reconnect Interval (ms) | Numeric value specifying the reconnect interval (ms). |
| Reconnect Delay (ms) | Specifies the reconnect delay (ms). |
| Webhook URL | Specifies the webhook url. |
| Local Webhook Server Port | Numeric value specifying the local webhook server port. |
| PFX Certificate Path | Specifies the pfx certificate path. |
| Certificate Password | Specifies the certificate password (secure). |
| Poll Sites | Specifies the poll sites. |
| Poll Servers | Specifies the poll servers. |
| Poll Cameras | Specifies the poll cameras. |
| Poll Alarms | Specifies the poll alarms. |
| Poll Events | Specifies the poll events. |
| Enable Event Monitoring | Toggle to enable or disable enable event monitoring. |
| Auto Reconnect | Specifies the auto reconnect. |
| Enable SSL (HTTPS) | Toggle to enable or disable enable ssl (https). |
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 |
|---|---|---|---|---|---|
| Alarms | AlarmWriteItemId | Value | Actions | Write | Json |
| camera.Name ?? camera.Id | parentId | Object | Camera | None | Variant |
| alarm.Name ?? alarm.Id | parentId | Object | Alarm | None | Variant |
| Alarm: {alarm.Name ?? alarm.Id} | {parentId}:command | Command | Command | Execute | String |
| displayName | id | Value | Avigilon | Read | valueType |
| displayName | id | Value | Collections | Read | Json |
| displayName | id | Value | Avigilon | Read | valueType |
Route Parameters: Alarms
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
Route Parameters: $Alarm: {alarm.Name ?? alarm.Id}
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|
4. Usage Examples
Scenario A: Reading/Monitoring Data
To monitor data from Avigilon, 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 Avigilon action, and supply any required parameters mapping from your rule's logic.