UltraNetCam HSPI User s Guide A HomeSeer HS2 plug-in used to capture snapshots from network cameras for surveillance and security purposes.

Size: px

Start display at page:

Download "UltraNetCam HSPI User s Guide A HomeSeer HS2 plug-in used to capture snapshots from network cameras for surveillance and security purposes."

Katrina McDonald
5 years ago
Views:

1 UltraNetCam HSPI User s Guide A HomeSeer HS2 plug-in used to capture snapshots from network cameras for surveillance and security purposes. Copyright 2013 ultrajones@hotmail.com Revised 02/03/2013 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 ultrajones@hotmail.com.

2 Table of Contents Introduction... 5 Intended Audience... 5 UltraNetCam HSPI Overview... 5 How It Works... 5 Features... 5 Requirements... 6 UltraNetCam HSPI Installation... 6 Downloading the HomeSeer Plug-in... 6 Installing the HomeSeer Plug-in... 6 UltraNetCam HSPI Configuration... 7 Web Page Layout Options... 7 NetCam Types Adding a New NetCam Type... 9 Modifying an Existing NetCam Type... 9 Deleting an Existing NetCam Type... 9 NetCam Controls Adding a New NetCam Control Modifying an Existing Control Deleting an Existing Control Deleting All Controls for a NetCam Type NetCam Controls - Import Importing Controls Importing File Format NetCam Controls - Export

3 Exporting Controls NetCam Devices Adding a New NetCam Device Modifying an NetCam Device Deleting an Existing NetCam Device Testing an Existing NetCam Device UltraNetCam HomeSeer Devices UltraNetCam Device Types UltraNetCam HSPI Snapshots Viewing Snapshots UltraNetCam HSPI Cameras Viewing the Last Camera Snapshot UltraNetCam HSPI Triggers UltraNetCam Alarm Trigger UltraNetCam HSPI Trigger Actions UltraNetCam Event Snapshots Action Properties UltraNetCam Take Snapshot Action Properties UltraNetCam CGI Action Properties UltraNetCam Purge Snapshot Action Properties

4 UltraNetCam HSPI Trigger Conditions UltraNetCam HSPI API Reference RefreshLatestSnapshots Subroutine Example

5 Introduction UltraNetCam is a HomeSeer HS2 plug-in used to capture snapshots from network cameras installed in your home for surveillance and security purposes. UltraNetCam supports taking simultaneous snapshots from your network cameras and provides the ability to archive the snapshots off site to an FTP repository or sending notifications containing the last snapshot, or a compressed attachment of the snapshots or an MP4 video of the snapshots. Intended Audience This document is intended for the HomeSeer user that has chosen to install and configure the UltraNetCam HomeSeer Plug-in. UltraNetCam HSPI Overview How It Works UltraNetCam HSPI connects to your network cameras using the HTTP protocol and captures a series of snapshots (still images) in response to an external trigger (motion sensor, door opening, etc.) to create a snapshot event. The snapshot event can be viewed using HomeSeer and can be sent by or archived to an FTP repository. Features Multiple threading allows UltraNetCam HSPI to take simultaneous snapshots from your network cameras without disrupting the performance of HomeSeer. Supports multiple network cameras (limited by your HomeSeer hardware). An Event Snapshot Action supports taking from 1 to n snapshots with x seconds between each snapshot. In addition, you can send an notification, compress event snapshots and upload the compressed file to a local or remote FTP server. A Take Snapshot Action allows you to refresh the last snapshot and thumbnail image. A CGI Command Action allows you to run a command supported by your network camera (e.g. go to preset n and wait x seconds for command to complete). Automatically convert a snapshot event to MP4 video if snapshot count exceeds a set threshold. A Purge Snapshots Action allows you to purge snapshots (or all but the last n events) for the selected network camera. Snapshot events are automatically purged from the FTP archive directory based on a predefined FTP archive threshold. Foscam motion alarm trigger supported by select Foscam network cameras. A network camera View webpage that displays the last snapshot for each network camera. A Snapshot webpage that displays the event snapshot by camera and event number. User ID and password are not sent as part of the URL query string. Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception. 5

Requirements Homeseer 2.2 or greater One or more IP network cameras that support JPEG snapshots. UltraNetCam HSPI Installation Downloading the HomeSeer Plug-in 1.

6 Requirements Homeseer 2.2 or greater One or more IP network cameras that support JPEG snapshots. UltraNetCam HSPI Installation Downloading the HomeSeer Plug-in 1. From your HomeSeer web page, select the Updater button. 2. Click the Next button until you find the entry for UltraNetCam, then click the checkbox to mark the plug-in for installation. 3. Click the Next button to begin downloading the UltraNetCam plug-in package. 4. Restart HomeSeer once you see the following message displayed: Installing the HomeSeer Plug-in 1. During startup, HomeSeer will automatically launch the plug-in installer. Simply step though the plug-in installer wizard to install and enable the HomeSeer plug-in. 6

7 2. Once the installer finishes, the UltraNetCam plug-in should be enabled and ready for use. UltraNetCam HSPI Configuration Web Page Layout The UltraNetCam plug-in has 6 web pages that provide access to the available features of the plug-in. 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. Types Provides the ability to define the types of network cameras you have installed in your home. 4. Controls Displays and allows you to add, modify and delete network camera controls. You can also import and export controls. 5. Devices Displays and allows you to add, modify, delete and test network camera devices installed in your home. 6. Snapshots Provides the ability view and delete snapshot events. The snapshots are arranged by camera and date. 7. Cameras Provides the ability to display and refresh the latest snapshot from each network camera. Options All options are set from the Options web page. The following options are supported: 7

8 1. Maximum Snapshot Events per Camera The maximum number of snapshots to keep per camera. The default is Snapshots Per Page The default number of snapshots to display on the Snapshots web page. 3. Snapshot Max Width The maximum width of the snapshots to display on the Snapshots web page. 4. Notification Enable sending Snapshot Event notifications using the plug-in. 5. To The default notification recipient address. 6. From The default notification sender address. 7. Subject The default notification subject. 8. Body Template The default notification message body. 9. Archive Directory Limit - The maximum size of all archived snapshot events to be stored in the archive directory. 10. Archive Directory The absolute path to the archive directory (e.g. c:\localdir or \\HostnameOrIPAddress\SharedFolder). 11. Archive Events Enable archiving Snapshot Events to FTP archive. 12. Archive Limit The maximum size of all archived snapshot events to be stored on the FTP server. 13. Archive Directory The directory on the FTP archive to store the snapshot events. 14. FTP Server The fully qualified domain name or IP address of the FTP server. 15. FTP User Name The FTP user name. 16. FTP Password The FTP user password. 17. FFmpeg Status The status indicating if the FFmpeg 3 rd party program is installed. This program is required to convert snapshots to MP4 video. 18. Convert Snapshot Event to Video Snapshots will automatically be converted to an MP4 video if the number of snapshots exceeds this value. 19. Authorized User Roles Specify the HomeSeer users authorized to access the UltraNetCam web page. 20. Register Link If set to Yes, the UltraNetCam button will be displayed on all web pages. 21. Debug Mode If set to Yes, the plug-in will write verbose logging to the HomeSeer log file. NetCam Types The NetCam Types web page allows you to add, modify and delete the types of network cameras you have installed in your home. A NetCam Type entry contains the vendor, model, snapshot path and video stream path. If your cameras do not have a video stream path, then simply reenter the snapshot path in this field. Before you begin to create the network camera devices, you ll need to review either the network camera user manual or obtain the application program interface (API) documentation from the network camera vendor. 8

Adding a New NetCam Type 1. Click on the UltraNetCam > Types button. 2. Enter the NetCam Vendor name. 3. Enter the NetCam Model or Type (e.g. JPEG, H.264 or FI9820W). 4.

9 Adding a New NetCam Type 1. Click on the UltraNetCam > Types button. 2. Enter the NetCam Vendor name. 3. Enter the NetCam Model or Type (e.g. JPEG, H.264 or FI9820W). 4. Enter the path to the snapshot path (e.g. /snapshot.cgi) 5. Enter the path to the video stream (e.g. /videostream.cgi). Note: If your camera does not have a video stream path, then simply reenter the snapshot path in this field. 6. To add the NetCam Type, simply click on the Add New icon Modifying an Existing NetCam Type 1. Click on the UltraNetCam > Types button. 2. Find the NetCam Type you want to edit, and then click the Edit icon 3. Edit the values as needed, then press the Save icon 4. To cancel the changes, simply press the Cancel icon Deleting an Existing NetCam Type 1. Click on the UltraNetCam > Types button. 2. Find the NetCam Type you want to delete, and then click the Delete icon 3. Confirm you want to delete the NetCam Type by clicking OK. NetCam Controls The NetCam Controls web page allows you to add, modify and delete controls associated with the selected NetCam Type. NetCam Controls allow you to control your NetCam using HomeSeer device actions. Before you begin to create the network camera controls, you ll need to review either the network camera user manual or obtain the application program interface (API) documentation from the network camera vendor. 9

10 Adding a New NetCam Control 1. Click on the UltraNetCam > Controls button. 2. Select the NetCam Type from the drop-down list, and then press the Update button. 3. Navigate to the bottom of the Controls web page. 4. Enter the Control Name and Control URL into the text boxes provided, and then press the Add New icon Modifying an Existing Control 1. Click on the UltraNetCam > Controls button. 2. Select the NetCam Type from the drop-down list, and then press the Update button. 3. Find the Control Name you want to edit, and then click the Edit icon 4. Edit the Control Name and/or the Control URL, then press the Save icon 5. To cancel the changes, simply press the Cancel icon Deleting an Existing Control 1. Click on the UltraNetCam > Controls button. 2. Select the NetCam Type from the drop-down list, and then press the Update button. 3. Find the Control Name you want to edit, and then click the Delete icon 4. Confirm you want to delete the control by pressing OK. Deleting All Controls for a NetCam Type 1. Click on the UltraNetCam > Controls button. 2. Select the NetCam Type from the drop-down list, and then click the Delete all NetCam Controls for the selected device. 3. Click the Update button to delete all the Controls for the selected device. NetCam Controls - Import The Import web page allows you to import NetCam controls exported by another user. 10

Importing Controls 1. Click on the UltraNetCam > Controls button. 2. Select the NetCam Type from the drop-down list, and then press the Update button. 3.

11 Importing Controls 1. Click on the UltraNetCam > Controls button. 2. Select the NetCam Type from the drop-down list, and then press the Update button. 3. Click the Browse button to find the file you want to import. 4. Click the Upload button to import the NetCam Controls. Importing File Format When importing Controls into UltraNetCam HSPI, please using the following file format: [Control Name] /path-to-action.extenstion?parm1=value1&parm2=value2 Example # Comment [Move Up - Start] /decoder_control.cgi?command=0 [Move Up - Stop] /decoder_control.cgi?command=1 [Move Down - Start] /decoder_control.cgi?command=2 [Move Down - Stop] /decoder_control.cgi?command=3 [Move Left - Start] /decoder_control.cgi?command=4 [Move Left - Stop] /decoder_control.cgi?command=5 [Move Right - Start] /decoder_control.cgi?command=6 [Move Right - Stop] /decoder_control.cgi?command=7 NetCam Controls - Export The Export web page allows you to export the controls for archive purposes. 11

Exporting Controls 1. Click on the UltraNetCam > Controls button. 2. Select the NetCam Type from the drop-down list, and then press the Export File button. 3. Save the file to your local hard drive.

A NetCam Device entry contains the network camera name, IP address, TCP port, camera type and the credentials needed to log into the cameras interface. Adding a New NetCam Device 1.

12 Exporting Controls 1. Click on the UltraNetCam > Controls button. 2. Select the NetCam Type from the drop-down list, and then press the Export File button. 3. Save the file to your local hard drive. NetCam Devices The NetCam Devices web page allows you to add, modify and delete the network cameras you have installed in your home. A NetCam Device entry contains the network camera name, IP address, TCP port, camera type and the credentials needed to log into the cameras interface. Adding a New NetCam Device 1. Click on the UltraNetCam > Types button. 2. Enter the NetCam name (e.g. Basement, outside, etc.). 3. Enter the NetCam IP address (e.g ). 4. Enter the NetCam TCP port number (e.g. 80). 5. Select the NetCam type. If the type is not available, you need to add a new type using UltraNetCam > Types. 6. Enter the NetCam User Id and User Password in the fields provided. 7. To add the NetCam Device, simply click on the Add New icon 12

Find the NetCam Device you want to delete, and then click the Delete icon 3. Confirm you want to delete the NetCam Device by clicking OK. Testing an Existing NetCam Device 1.

13 Modifying an NetCam Device 1. Click on the UltraNetCam > Types button. 2. Find the NetCam Device you want to edit, and then click the Edit icon 3. Edit the values as needed, then press the Save icon 4. To cancel the changes, simply press the Cancel icon Deleting an Existing NetCam Device 1. Click on the UltraNetCam > Types button. 2. Find the NetCam Device you want to delete, and then click the Delete icon 3. Confirm you want to delete the NetCam Device by clicking OK. Testing an Existing NetCam Device 1. Click on the UltraNetCam > Types button. 2. Find the NetCam Device you want to test, and then click the Snapshot Test icon Note: The Snapshot Test attempts to take a snapshot from your camera. Any errors are written to the HomeSeer log. UltraNetCam HomeSeer Devices The UltraNetCam plug-in automatically creates a HomeSeer device for each NetCam you define within the plug-in. The Controls are automatically updated for every NetCam associated with a particular NetCam Type. UltraNetCam Device Types This device is automatically created for each NetCam you define. To control your NetCam, simply selecting the HomeSeer Control dropdown and selecting an appropriate action. You can also control your NetCam by selecting a Device Action, then selecting Device, then Device Action. See UltraNetCam > Controls for setting up custom controls for your NetCam type. 13

Select the network camera from the list and optionally select the snapshot event you want to view. 3.

14 UltraNetCam HSPI Snapshots The Snapshots web page allows you to view the snapshot events by network camera and snapshot event. Viewing Snapshots 1. Click on the UltraNetCam > Snapshots button. 2. Select the network camera from the list and optionally select the snapshot event you want to view. 3. Select the desired page size and the navigational controls to find the desired snapshot. You can view the original size of any snapshot by clicking on the image. You can also view the other snapshot associated with the event by clicking the right or left side of the larger image. 14

15 UltraNetCam HSPI Cameras The Cameras web page allows you to view the most resent snapshot from your network cameras. You can also refresh the snapshot from all cameras by clicking the Refresh All Cameras button. Viewing the Last Camera Snapshot 1. Click on the UltraNetCam > Cameras button. 2. Scroll though the list of snapshots from each network camera. 3. To refresh the snapshots, clicking the Refresh All Cameras button UltraNetCam HSPI Triggers You can create HomeSeer events using any of the supported triggers below. UltraNetCam Alarm Trigger This trigger can be used to run a HomeSeer event whenever a Foscam camera detects motion. This may be useful if you do not have an external trigger to determine when you need to capture snapshots from your network cameras (e.g. External motion sensors, door sensors, etc.). 15

16 Enabling the Foscam Alarm Trigger Hidden Feature You can enable the alarm trigger on the Foscam JPEG camera as follows: IP address}:{port}/set_alarm.cgi?http=1&http_url= Address of HomeSeer}/hspi_ultranetcam/hspi_ultranetcam.aspx?trigger=alarm&user=admin&pwd=password Note: The user and pwd in the URL above is for the Foscam Camera and not HomeSeer. Once the command above had been sent, you can enable/disable the feature using the following commands: IP address}:{port}/set_alarm.cgi?http=1&user=admin&pwd=password IP address}:{port}/set_alarm.cgi?http=0&user=admin&pwd=password Note: You can use the UltraNetCam CGI HomeSeer event action to automate enabling and disabling the alarm notification trigger. To trigger a HomeSeer event when motion is detected by your network camera, select "UltraNetCam Alarm Trigger", and then select the Camera that will trigger the event. UltraNetCam HSPI Trigger Actions UltraNetCam Event Snapshots This action causes the plug-in to capture a series of snapshots from your network camera. Action Properties Action Properly Name Select Action Select Network Camera Number of Snapshots Delay between Snapshots Notification Recipient Notification Attachment Options Action Property Description Event Snapshots The network camera you want to capture snapshots from. A numeric value specifying the number of snapshots you want to capture as part of the snapshot event. The recommended maximum value is 60. A numeric value containing the number of seconds to pause between snapshots. The recommended value is between 0 and 1 second (e.g..25). An alternate address for the notification (if different than the default specified in the options web page). Select the type of attachment you want to attach to the notification. Valid options are: 1. Do not include an attachment 2. Attach the latest snapshot of the event 3. Attach the compressed file of the event 4. Attach the MP4 video of the event Send Notification Compress Event Snapshots Select this checkbox to have an notification sent at the completion of the event. Select this checkbox to have the snapshot events compressed. Upload Compressed File to Select this checkbox to copy the compressed snapshot event to the selected FTP archive. See UltraNetCam > 16

FTP Server Archive Event Notes Options for FTP Archive options. This option will allow UltraNetCam to save the video or compressed snapshot event to an alternate location within your network.

17 FTP Server Archive Event Notes Options for FTP Archive options. This option will allow UltraNetCam to save the video or compressed snapshot event to an alternate location within your network. Notes associated with the event. UltraNetCam Take Snapshot This action causes the plug-in to capture a single snapshot from your network camera. The snapshot can be viewed from UltraNetCam > Cameras or viewed from the camera s root snapshot folder. Action Properties Action Properly Name Select Action Select Network Camera Notes Action Property Description Take Snapshot The network camera you want to capture the snapshot from. Notes associated with the event. 17

18 UltraNetCam CGI This action provides additional control of your network cameras. As an example, if your camera provides pan and tilt features, you can move your camera to a certain presets prior to capturing snapshots from your camera. Action Properties Action Properly Name Select Action Select Network Camera Query String Wait for Command to Complete Notes Action Property Description NetCam CGI The network camera you want to send a command to. The URL for the command to run. The number of seconds to wait for the command to complete. As an example, if you configure this event to move your camera to preset 1, then you may need to wait several seconds for your camera to complete the request. Notes associated with the event. 18

19 UltraNetCam Purge Snapshot This action allows you to purge snapshot events for a specific camera. The plug-in also automatically purges snapshot events from all cameras based on the value you specify in UltraNetCam > Options > Maximum Snapshots Events per Camera. Action Properties Action Properly Name Select Action Select Network Camera Number of Snapshot Events to Keep Notes Action Property Description Purge Snapshot The network camera you want to capture the snapshot from. The number of snapshots to keep for the selected camera. Notes associated with the event. 19

20 UltraNetCam HSPI Trigger Conditions This plug-in does not have any HomeSeer trigger conditions defined. UltraNetCam HSPI API Reference RefreshLatestSnapshots Subroutine This function refreshes the latest snapshot from each network camera. Public Sub RefreshLatestSnapshots() Example Sub Main(ByVal parm As Object) ' ' Define our plug-in object ' Dim hspi As Object = hs.plugin("ultranetcam") ' ' Refresh the lastest snapshot from all cameras ' hspi.refreshlatestsnapshots() End Sub 20

UltraNetCam3 HSPI User s Guide

UltraNetCam3 HSPI User s Guide A HomeSeer HS3 plug-in used to capture snapshots from network cameras for surveillance and security purposes. Copyright 2014 ultrajones@hotmail.com Revised 12/21/2014 This