UltraSighthoundVideo3 HSPI User’s Guide
A HomeSeer HS3 plug-in used to connect HomeSeer to Sighthound Video for surveillance
and security purposes.
Copyright © 2015
Revised 04/08/2015
This document contains proprietary and copyrighted information and may not be copied, reproduced, translated, or reduced to any electronic medium without prior consent, in writing, from [email protected].
2
Table of Contents Introduction .................................................................................................................................................. 4
Intended Audience .................................................................................................................................... 4
UltraSighthoundVideo3 HSPI Overview ........................................................................................................ 4
How It Works ............................................................................................................................................ 4
Features .................................................................................................................................................... 4
Requirements ............................................................................................................................................ 4
UltraSighthoundVideo3 HSPI Installation ..................................................................................................... 4
Downloading the HomeSeer Plug-in ......................................................................................................... 4
UltraSighthoundVideo3 HSPI Configuration ................................................................................................. 5
Web Page Layout ...................................................................................................................................... 5
Screenshot ............................................................................................................................................ 5
Options ...................................................................................................................................................... 5
Sighthound Server ................................................................................................................................. 5
Sighthound Credentials ......................................................................................................................... 5
Sighthound Options .............................................................................................................................. 6
E-mail Notification Options ................................................................................................................... 6
Web Page Access .................................................................................................................................. 6
Application Options .............................................................................................................................. 6
Screenshot ............................................................................................................................................ 6
UltraSighthoundVideo3 HomeSeer Devices ............................................................................................. 7
Sighthound Camera ............................................................................................................................... 7
Sighthound Camera Rule ...................................................................................................................... 7
Sighthound Camera Connection ........................................................................................................... 7
Sighthound Connection......................................................................................................................... 7
Sighthound Arming ............................................................................................................................... 7
Sighthound State ................................................................................................................................... 7
Screenshot ............................................................................................................................................ 8
UltraSighthoundVideo3 HSPI Cameras ......................................................................................................... 8
Screenshot ............................................................................................................................................ 8
3
UltraSighthoundVideo3 HSPI Triggers .......................................................................................................... 9
UltraSighthoundVideo3 Sighthound Video Motion Trigger .................................................................. 9
Screenshot ............................................................................................................................................ 9
UltraSighthoundVideo3 HSPI Trigger Actions ............................................................................................... 9
UltraSighthoundVideo3 Email Camera Snapshot ................................................................................. 9
Screenshot .......................................................................................................................................... 10
UltraSighthoundVideo3 HSPI Trigger Conditions ........................................................................................ 10
UltraSighthoundVideo3 HSPI API Reference .............................................................................................. 10
4
Introduction UltraSighthoundVideo3 is a HomeSeer HS3 plug-in used to arm the security cameras connect to a
Sighthound Video server. UltraSighthoundVideo3 also supports enabling Sighthound camera rules and
triggering HomeSeer events based on motion triggers you define within your Sighthound Video server.
Intended Audience This document is intended for the HomeSeer user that has chosen to install and configure the
UltraSighthoundVideo3 HomeSeer Plug-in.
UltraSighthoundVideo3 HSPI Overview
How It Works
UltraSighthoundVideo3 HSPI polls the Sighthound Video server to determine the camera names,
camera rules and the current arming status.
UltraSighthoundVideo3 HPSI automatically creates a HomeSeer device for each camera
connected to your Sighthound Video server.
The latest snapshot from each camera is saved to disk and can be used to display within
HSTouch.
Features
Automatically creates a HomeSeer device for each camera connected to Sighthound Video. Provides the ability to arm or disarm an individual camera or all cameras. Provides the ability to enable or disable Sighthound camera rules. Supports the ability to trigger a HomeSeer event based on rules defined within the Sighthound
Video software. Supports a HomeSeer Email Camera Snapshot event action. Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception.
Requirements Homeseer 3.0 or greater
Sighthound Video Software available at https://www.sighthound.com/.
UltraSighthoundVideo3 HSPI Installation
Downloading the HomeSeer Plug-in 1. From your HomeSeer web page, select PLUG-INS > Manage.
2. Click the + icon next to Additional Interfaces to expand the list of available HomSeer3 plug-ins.
5
3. Click the + icon next to the “Camera Support” category, then click the checkbox next to the
UltraSighthoundVideo3 (Sighthound Video) package to mark the plug-in for installation.
4. Under “Pending Updates/Installs”, click the Download and Install button.
5. Once the installer finishes, find the UltraSighthoundVideo3 plug-in under Installed Plug-Ins, then
enable it.
UltraSighthoundVideo3 HSPI Configuration
Web Page Layout The UltraSighthoundVideo3 plug-in has 6 web pages that provide access to the available features of the
plug-in.
Screenshot
The available web pages are as follows:
1. Status – Displays the plug-in and the network camera status.
2. Options – Displays and allows you to change the options associated with the plug-in.
3. Cameras – Provides the ability to display and refresh the latest snapshot from each camera.
Options All options are set from the Options web page. The following options are supported:
Sighthound Server
IP Address – The IP address of your Sighthound Video Server.
Port – The port number of your Sighthound Video Server.
Sighthound Credentials
Username – The user name used to log into your Sighhound Video Server.
Password – The password used to log into your Sighthound Video Server.
6
Sighthound Options
Refresh Interval – The number of seconds to wait between each polling interval.
E-mail Notification Options
Email To – The default email address used to send the email notification to.
Email From – The default email sender address used to send the email notifications. This email
address must be valid.
Email Subject – The default email subject used when you create a new Send Camera Snapshot
event action.
Email Body Template – The default email template used when you create a new Send Camera
Snapshot event action.
Web Page Access
Authorized User Roles – Specify the HomeSeer users authorized to access the
UltraSighthoundVideo3 web page.
Application Options
Logging Level – Select the level of application logging.
Note: This option may produce a lot of output and should only be used when debugging.
Screenshot
7
UltraSighthoundVideo3 HomeSeer Devices The UltraSighthoundVideo3 plug-in automatically creates a HomeSeer device for each camera you
define within your Sighthound Video Server.
Sighthound Camera
This device is automatically created for each camera connected to your Sighthound Video server. You
can arm or disarm each camera using the Sighthound Camera HomeSeer device.
Sighthound Camera Rule
This device is automatically created for each camera rule defined for each camera within the Sighthound
Video server. You can enable or disable each camera rule using the Sighthound Camera Rule HomeSeer
device.
Sighthound Camera Connection
This device allows you to view the current camera connection status. You can use this devices as a
trigger to notify you when a camera goes offline.
Sighthound Connection
This device allows you to view the current connection status. You can use this device as a trigger to
notify you when the Sighthound Video Server goes offline.
Sighthound Arming
This device allows you to arm or disarm all cameras.
Sighthound State
This device allows you to enable or disable the connection to the Sighthound Video Server without
having to disable the plug-in.
8
Screenshot
UltraSighthoundVideo3 HSPI Cameras The Cameras web page allows you to view the most resent snapshot from your network cameras. The
images will automatically be refreshed based on the Refresh Interval you select from the Options web
page.
Screenshot
9
UltraSighthoundVideo3 HSPI Triggers You can create HomeSeer events using any of the supported triggers below.
UltraSighthoundVideo3 Sighthound Video Motion Trigger
This trigger can be used to run a HomeSeer event whenever a motion rule triggers within your
Sighthound Video server. This may be useful if you want to send the latest snapshot from your camera
when motion is triggers or turns lights on or off depending on if you’re entering or leaving a room.
Screenshot
UltraSighthoundVideo3 HSPI Trigger Actions You can create HomeSeer events using any of the supported triggers below.
UltraSighthoundVideo3 Email Camera Snapshot
This trigger action can be used to send the latest camera snapshot and status for a camera. This may be
useful if you want to send the latest snapshot from your camera even though Sighthound didn’t detect
motion. The e-mail notification text also support all HomeSeer replacement variables in addition to the
following:
1. $camera_name – Replaced with the name of the camera.
2. $camera_id – Replaced with the UltraSighthoundVideo3 internal camera Id.
3. $camera_enabled – Replaced with either armed or disarmed.
4. $camera_status – Replaced with either online or the Sighthound Video failure status.
5. $camera_rules_summary – Replaced with a summary of the Sighthound Video camera rules.
6. $camera_rules_enabled – Replaced with the count of the enabled Sighthound Video camera
rules.
10
7. $camera_rules_count – Replaced with the total number of Sighthound Video camera rules.
Screenshot
UltraSighthoundVideo3 HSPI Trigger Conditions This plug-in does not have any HomeSeer trigger conditions defined.
UltraSighthoundVideo3 HSPI API Reference To be determined.
