Avigilon Control Center

The Avigilon Control Center Integrated System allows Rutnime to communicate with the Avigilon Control Center server to interact with cameras, inputs, and outputs.

Definitions

Avigilon Control Center (ACC) — The Avigilon Video Management System.

Setup

See the Data Servers page for information on configuring driver communication.

Note: Asset Multi-Select is not available for this integrated system.

WebEndpoint Configuration

The Avigilon WebEndpoint must be installed and configured for your Avigilon setup.

Note: Please reference the Avigilon documentation for installing the WebEndpoint.

The WebEndpoint configuration must be adjusted within the below file on the ACC server.

C:\ProgramData\Avigilon\WebEndpoint Config\WebEndpoint.config.yaml

To enable communication, use these settings:


                    publicRestInterface:
                    port: 8080
                    secure: false

Compatibility

The Avigilon Control Center integrated system is compatible with ACC software version 7.X. IPFusion has been tested with Avigilon versions:

  • 7.10.2.8
  • 7.14.0.14

Prerequisites

Software Minimum Version
IPFusion — Avigilon Control Center 1.5
.NET Framework 4.7.2

When completing your setup, be sure to have the Avigilon Control Center documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.

Purpose Default Value Configurable
Communication Settings 8443 Yes
Dataserver 9612 Yes
Debug Tools 9613 No

Communication Configuration

In the integrated system configuration panel, you will find the Communication Settings. The below information is required:

Servers

Priority The priority of the Avigilon server.
IP Address The IP Address of the Avigilon Control Center server.
Port The Port of the Avigilon Control Center server.
Note: The Avigilon driver can connect to the server using an HTTPS connection. However, video can only be streamed from cameras when using an HTTP connection.

Authentication

Username The Username of the user within the Avigilon system to log in as. This is typically an account created specifically for the Runtime connection.
Password The Password of the user to log in as.

Advanced

Connection retries before failover The number of connection attempts Runtime will make to the Avigilon server before failing over to the next prioritized one in the list.
Connection Retry Delay The number of seconds to wait between connection attempts.
API general timeout (s) The duration for general API calls in seconds. This value can be between 1-60.
API heartbeat timeout (s) The call duration for heartbeat API calls in seconds. This value can be between 1-60.
Note: Red X indicates an invalid or out of range value given for field.
Note: Avigilon requires 30 seconds to elapse before failover attempts begin.

Assets

System Asset

The system asset is a representation of the connection state of the Avigilon Control Center system.

View all properties

Supported States

Normal The asset is online and in its default state.
Masked The asset has been masked over its true state.
Fault An issue has been detected in a connected asset.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Camera Asset

The Camera asset is a representation of a camera in the Avigilon Control Center.

Required Property Grid Fields

Logical Id The Logical Id as configured in the Avigilon system.

View all properties

Supported States

Normal The asset is online and in its default state.
Recording The device is currently recording video.
Motion Detected The device has detected movement.
Masked The asset has been masked over its true state.
Fault An issue has been detected in a connected asset.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands
Important: On startup, Runtime determines whether the camera is online or not. It will not initially receive the proper status to see if the camera is in a recording state or not during startup.
Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
Add Bookmark Adds a bookmark for the camera. This is a clip of video starting and ending at a specific date and time.
  • Start Time Offset — The number of seconds prior to the command to start the bookmark.
  • End Time Offset — The number of seconds after the command to end the bookmark.
Table 1. For PTZ Capable Cameras Only
Pan/Tilt Moves the camera.
  • Horizontal Speed — The speed to move the camera on the horizontal plane (pan).
  • Vertical Speed — The speed move the camera on the vertical plane (tilt).
Zoom Zooms the camera in or out.
  • Zoom Amount — The amount to zoom the camera. A positive value is in, negative is out.
PTZ Preset Moves the camera to a predefined PTZ preset configured in the Avigilon system.
  • Preset Number — The ID of the preset PTZ command.
Stop PTZ Stops all PTZ movement.

See the Command Tables page for more information on configuring command tables.

Input Asset

Required Property Grid Fields
Avigilon ID The identifier of the input within the Avigilon system.

View all properties

Supported States
On The asset is currently on.
Off The asset is currently off.
Unknown The state for the asset could not be determined at this time.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Note: When the input asset is initialized, it will be in an unknown state. This will remain unknown until either an activate or deactivate command is sent to the asset.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands
Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Output Asset

Required Property Grid Fields
Avigilon ID The identifier of the output within the Avigilon system.

View all properties

Supported States
Normal The asset is online and in its default state.
Acknowledged An asset alarm has been acknowledged.
Masked The asset has been masked over its true state.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands
Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
Trigger Output Activates the output.
Toggle Output Flips the state of the output.

See the Command Tables page for more information on configuring command tables.

Workflow Integration

System Commands

System commands are commands executed through Workflows at the system level. For more information about Workflows see the Workflows section.

Bookmark Command

The Bookmark command is used to tag a timeline of recorded video on a specific camera.

Table 2. Parameters
Camera ID The Avigilon ID for the camera to bookmark their feed.
Start Date The Date/Time to start the bookmark at.
End Date The Date/Time to end the bookmark at.
Name The Name for the bookmarked timeline.
Description A description for the timeline.
Is Protected Whether or not the bookmark is protected.

Trigger Camera Preset

Table 3. Parameters
Preset ID The ID of the preset command.
Note: This command only accepts integer values. If a string value is required, please use the camera asset PTZ preset command instead.
Asset ID The ID of the camera asset to execute the PTZ command on.

Toggle Output Command

The Toggle Output command toggles a digital output device connected to the camera.

Table 4. Parameters
Avigilon ID The Avigilon ID of the entity.

Trigger Output Command

The Trigger Output command will trigger (activate) a digital output connected to a camera.

Table 5. Parameters
Avigilon ID The Avigilon ID of the output entity.

Trigger Alarm

Triggers an event by the name of an alarm in the Avigilon system.

Table 6. Parameters
Name The name of the alarm to trigger.
Note: This field is case-sensitive. The Avigilon system may also contain multiple alarms by the same name. In this case, the first alarm which matches the defined name will be triggered.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.

Camera Callup Displays ACC Unavailable

If a camera callup to VideoFusion from Avigilon displays ACC Unavailable, the camera feed will only come back when another callup request is made and the server is back online. If this message is not being displayed, the camera feed will return on its own.