Pelco Calipsa Integration Guide – Digital Watchdog

Calipsa® Digital Watchdog Integration

User Guide

Document number:C6736M

Publication date:03/23

C6736M | 03/23 1

Calipsa® Digital Watchdog Integration User Guide

Table of Contents

Introduction 3

Digital Watchdog Plugin 3

Digital Watchdog Plugin Integration for Windows 3

System Overview 3

Running the Installers 3

The Calipsa Agent Service 3

Network Access 4

Creating a Calipsa Authentication Token 4

Connecting Cameras to Calipsa 5
Configuring Analytics Events generated by DW 6
Configuring Analytics Events detected by a third-part software 7
Completing an HTTPRequest 8

Enabling Desktop Notification 8

Troubleshooting Questions 10

Adding your Monitoring Station SMTP Details 12

Accessing Calipsa Account Settings 12
Editing Global Configuration 12
Inputting Your Credentials 13

C6736M | 03/23 2

Calipsa® Digital Watchdog Integration User Guide

Introduction

This guide covers the steps required to integrate your Digital Watchdog cameras with the Calipsa
platform. Other common integration steps, such as configuring your system to send alarms to your gmail
account are also covered.

Digital Watchdog Plugin

Digital Watchdog Plugin Integration for Windows

This guide walks you through the process of installing and setting up the Calipsa Digital Watchdog Plugin
Integration on your Windows-based machine.

System Overview

Running the Installers

After downloading the fourinstallers, ensure that they are not blocked by Windows or any antivirus
software.

Note: VC_redist.exe install must be run first or the installation will not be successful.

1. Runthe installer VC_redist.exe.

2. Runthe installer Win64OpenSSL-1_1_1m.msi.

3. Run the installer for the Plugin: DWPluginSetup.msi and grant admin access when prompted.

4. Run the Installer for the Agent: DWAgentInstaller.msi and grant admin access when prompted.

Note: Running the plugin installer will invoke a MediaServer and Spectrum restart. Ensure that this is not
a problem before the installation.

The Calipsa Agent Service

l

The agent installer will install a Windows service running in the background that is essential for
alarm processing.

C6736M | 03/23 3

Calipsa® Digital Watchdog Integration User Guide

l

When running this installer, please specify an appropriate name for this service and a TCP port
that is vacant on the machine (the defaults areCalipsaDWAgentServiceInstanceand60000,
respectively).

l

The installation can be verified by looking for both respective entries from the Windows Services
application.

Network Access

l

Please make sure that theport numberchosen on the agent installation (60000 by default) is
accessible by the plugin running in the Media Server and not blocked by any firewall rules.

l

Please ensure that theagent servicehas access to the internet such that it can communicate
over HTTPs withdw.calipsa.ioon the remoteport 443.

l

Please ensure that the plugin running within the Media Server has access to the internet such that
it can communicate over HTTPs withdw.calipsa.ioon the remoteport 443.

l

Please ensure that the plugin running within the Media Server can occupyTCP port55000on the
machine. 55000 thus has to be vacant and firewall rules, etc. have to allow this occupation.

Creating a Calipsa Authentication Token

1. Log into the Calipsa Dashboard.

2. Click Settings.

3. Next to Integration, click ...

4. Click Calipsa API.

5. Click Create New Token, and copy it.

6. In Spectrum, go to System Administration > Plugins > Calipsa False Alarm Filtration.

7. Paste the Token into the Calipsa authentication token text field.

Note: If you have not created a client or a site for this instance of Digital Watchdog in the Calipsa
Dashboard yet, do that now.

8. Under Calipsa Host, enter dw.calipsa.io.

9. Under Calipsa's remote port, enter 443

10. Under Calipsa Client name, enter the client name exactly as it appears in Calipsa.

11. Under Calipsa Site Name, enter the site name exactly as it appears in Calipsa.

12. To forward true alarms from Calipsa to Immix, select the Send alarm emails check box.

13. Enter the Immix Server Address for either IP or FQDN.

14. Enter the Immix Server Port number.

15. If access to the servers requires a username and password, enter the necessary credentials.

16. Click Apply.

C6736M | 03/23 4

Calipsa® Digital Watchdog Integration User Guide

Connecting Cameras to Calipsa

Next we can select which cameras Calipsa is supposed to work on. To do this, the plugin needs to be
enabled for the cameras we want

1. Right-click on the camera.

2. Under Camera Settings, select Plugins.

3. Select the toggle to enable the plugin.

4. Ensure that the Camera stream selected in the drop-down list is set to Secondary.

5. Click Apply. Wait a few seconds for the Connection section to become visible.

6. When it’s visible, check theCheck this to register this camera with Calipsa and the Process
motion events checkboxes.

7. Specify a Motion Throttle value in number of seconds.

Note: TheMotion Throttle value specifies the number of seconds Calipsa waits after a motion event has
occurred before considering a subsequent motion event. This will reduce the number of motion events
sent to calipsa for analysis and will reduce the chance of getting duplicate motion events. Use with
caution and in accordance with the camera sensitivity. Too big of a value can mean missing legitimate
motion events.

C6736M | 03/23 5

Calipsa® Digital Watchdog Integration User Guide

8. Enter the completeCamera-specific Immix S Address if you would like true alarm events to be
forwarded to Immix for example, [e-mail].

9. Click Apply. The camera will be automatically added to the Calipsa dashboard.

Configuring Analytics Events generated by DW

By configuring analytics events, you can determine what kinds of events trigger a response.

1. Navigateto System Administration> General>Event Rules.

2. Click + Addnear the top-right.

3. Formotion eventsgenerated by Digital Watchdog, choose the followingEvent Type: Motion
Received - Calipsa.

4. Under Action, select Do HTTP requestto send an HTTP request to the agent service installed
earlier.

The following screenshot is an example of how Calipsa would listen for a Motion Received - Calipsa
event against 3 cameras, assuming the port set was 60000.

C6736M | 03/23 6

Calipsa® Digital Watchdog Integration User Guide

Configuring Analytics Events detected by a third-part software

For all the otheranalytics events generated by devices, other third-party software etc, create the
following event rule

1. Navigate toSystem Administration > General > Event Rules.

2. Click + Add near the top right.

3. Formotion events, choose the Event type.

4. Under Action, select Do HTTP requestto send an HTTP request to the agent service installed
earlier.

The following screenshot is an example of how Calipsa would listen for a Line Crossing anaytics event
against 4 cameras, assuming the port set was 60000.

C6736M | 03/23 7

Calipsa® Digital Watchdog Integration User Guide

Tip: the Process Motion Events checkbox found in the Camera Settings menu should remain unchecked
for cameras not working with motion. This will improve plugin performance.

Completing an HTTPRequest

The following values may be used when completing an HTTPRequest.

HTTP URL:http://127.0.0.1:60000/signal-event

The 127.0.0.1:60000 is the relative address:port of the agent service from Spectrum. 127.0.0.1 means
they’re on the same machine. Hence, if the mediaserver and Spectrum are running on different
machines, perhaps in the same VPN, then this should be replaced with the relative IP and relative port.

HTTP Content:

l

{
"cameraId": "{event.cameraId}",
"cameraName": "{event.cameraName}",
"eventType": "{event.eventType}",
"eventCaption": "{event.caption}",
"eventDescription": "{event.description}",
"eventName": "{event.eventName}"
}

Content type:application/json

Authentication type:auto

Request type:POST

Interval of action:Instant (unchecked)

In theWhenfield, specifying the event category. This must always beAnalytics Event. If this restriction
becomes problematic and the requires event type does not fall under Analytics Events, please contact
Calipsa.

The agent service, on getting an HTTP request from Digital Watchdog, will invoke Calipsa and begin
processing the event that triggered it.

Enabling Desktop Notification

Ensure that true events in Calipsa generate a desktop notification and are shown in spectrum in real­time. The event rule shown in the screenshot below ensures that a desktop notification will be generated
immediately when a Calipsa True Alarm Event happens, that is, when Calipsa detects a true alarm.

C6736M | 03/23 8

Calipsa® Digital Watchdog Integration User Guide

If the plugin encounters an error, it will generate a plugin diagnostic event which contains information as
to what went wrong. Ensure that this diagnostic event is also shown immediately as a desktop
notification. The event rule shown in the screenshot below ensures that a desktop notification will be
generated if the plugin encounters an error.

The screenshot below is an example of a Calipsa True Alarm Event as a desktop notification inside
Spectrum. The event's caption and description will contain information regarding which event was
responsible for this true alarm being detected in the first place.

C6736M | 03/23 9

Calipsa® Digital Watchdog Integration User Guide

The screenshot below is an example of objects generated by Calipsa against a true event.

Troubleshooting Questions

Potential Plugin Diagnostic Messages:

l

Camera event-ed multiple times in the same processing window

l

Error on sending frames to Calipsa

l

All tries failed when sending frames to Calipsa

l

Non-2xx status code received

l

Took over 12 seconds to process

C6736M | 03/23 10

Calipsa® Digital Watchdog Integration User Guide

Error processing HTTP response: check that the internet connection on both the agent machine and the
Spectrum machine is reliable. The plugin sends images out to Calipsa's servers in the cloud for analysis,
thus the internet speed has to be adequate for fast alarm processing.

Please refresh your authentication token: check that the user against whom the token was generated
has not been blocked or deleted from Calipsa.

Delay Passed, could not gather enough images: A problem with the plugin unable to read images from
the camera stream. Check that the camera connection is reliable. Try changing the stream type from
camera settings plugins tab. Primary stream would mean the plugin is reading bigger, higher-resolution
images which will put more load on the server and consume more bandwidth.

Contact Calipsa in case a plugin diagnostic event happens. Include screenshots of the diagnostic event
and the message it displays on Spectrum.

C6736M | 03/23 11

Calipsa® Digital Watchdog Integration User Guide

Adding your Monitoring Station SMTP Details

This guide is for manually configuring Calipsa to forward true alarms to your monitoring station software
via email.

NOTE: Please ensure our Calipsa IP addresses are whitelisted on your monitoring station software
before completing this setup. Otherwise the true alarms sent to you may get blocked. See the Calipsa
Email Alarm Notifications Manual for instructions on Whitelisting Calipsa's IP addresses.

Accessing Calipsa Account Settings

1. Log into your Calipsa account.

2. In the bottom left-side panel, select Settings.

Editing Global Configuration

1. Under Account Settings, navigate to Global configuration.

2. Next to Global configuration, click Edit.

C6736M | 03/23 12

Calipsa® Digital Watchdog Integration User Guide

Inputting Your Credentials

Under Global configuration, input the credentials of your monitoring station software. The credentials
include the server information you would have had the cameras/NVRs alarming to before incorporating
Calipsa into your process.

1. Under Host/IP Address, enter the IP address/DNS of your server

2. Under HTTP port, enter the HTTP port number. If unsure, try entering 25.

3. Under Username and Password, enter the login credentials for your server. If you are using
Immix, leave this section blank.

4. Under Test Email, use the example email address belonging to that sever. For example,
[e-mail] for an Immix server.

5. Test the connection.

6. If connected, click Save.

NOTE: These settings will automatically apply to all new sites added. To direct a specific site to a
different location, you will need to change the monitoring station SMTP details on the site level.

Troubleshooting Questions

Q: The Test email said successful however I cannot see a test email received in Calipsa.

A: If the test fails please follow the steps below in order.

1. Check that you whitelisted our relevant IP addresses within your monitoring station sever.

2. Check that you entered the correct credentials. Even the test email needs to be an email address
that exists within your server.

3. Try enabling "Use proper Helo". this is a different method of connection to fit with the additional
security requirements of some systems.

4. Reach out to the Calipsa support team by submitting a request or emailing: [e-mail]

Q: Can I send alarms to an email address instead?

A: Yes you can send to an email server as long as the specified email server allows it within their security
settings. Please see the Calipsa Email Alarm Notifications Manual for an example.

C6736M | 03/23 13

Calipsa® Digital Watchdog Integration User Guide

Pelco, Inc.

625 W. Alluvial Ave., Fresno, California 93711 United States

[phone] Tel
[phone] Fax
[phone] International Tel
[phone] International Fax

www.pelco.com

Pelco, the Pelco logo, and other trademarks associated with Pelco products referred to in this publication are trademarks of Pelco,
Inc. or its affiliates. ONVIF and the ONVIF logo are trademarks of ONVIF Inc. All other product names and services are the property of
their respective companies. Product specifications and availability are subject to change without notice.

© Copyright 2023, Pelco, Inc. All rights reserved.