UltraNetCam3 HSPI User s Guide

Transcription

1 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 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 UltraNetCam3 HSPI Overview... 5 How It Works... 5 Features... 5 Requirements... 6 UltraNetCam3 HSPI Installation... 6 Downloading the HomeSeer Plug-in... 6 UltraNetCam3 HSPI Configuration... 6 Web Page Layout... 6 Screenshot... 6 Options... 7 NetCam Options Notification Options... 7 Archive Options... 7 FTP Archive Options... 7 Snapshot Event to Video Options... 8 Web Page Access... 8 Application Options... 8 NetCam Types... 8 Screenshot... 8 Adding a New NetCam Type... 9 Modifying an Existing NetCam Type... 9 Deleting an Existing NetCam Type... 9 NetCam Controls... 9 Screenshot Adding a New NetCam Control Modifying an Existing Control Deleting an Existing Control

3 Deleting All Controls for a NetCam Type NetCam Controls - Import Screenshot Importing Controls Importing File Format NetCam Controls - Export Screenshot Exporting Controls NetCam Devices Screenshot Adding a New NetCam Device Modifying an NetCam Device Deleting an Existing NetCam Device Testing an Existing NetCam Device UltraNetCam3 HomeSeer Devices UltraNetCam3 Device Types Screenshot Screenshot UltraNetCam3 HSPI Snapshots Viewing Snapshots Screenshot UltraNetCam3 HSPI Cameras Viewing the Last Camera Snapshot Screenshot UltraNetCam3 HSPI Triggers UltraNetCam3 Alarm Trigger UltraNetCam3 HSPI Trigger Actions UltraNetCam3 Event Snapshots Action Properties Screenshot UltraNetCam3 Take Snapshot Action Properties

4 Screenshot UltraNetCam3 CGI Action Properties Screenshot UltraNetCam3 Purge Snapshot Action Properties Screenshot UltraNetCam3 HSPI Trigger Conditions UltraNetCam3 HSPI API Reference

5 Introduction UltraNetCam3 is a HomeSeer HS3 plug-in used to capture snapshots from network cameras installed in your home for surveillance and security purposes. UltraNetCam3 supports taking simultaneous snapshots from your network cameras and provides the ability to archive the snapshots locally or 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 UltraNetCam3 HomeSeer Plug-in. UltraNetCam3 HSPI Overview How It Works UltraNetCam3 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 locally or to an FTP repository. Features Multiple threading allows UltraNetCam3 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 file system 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 (unless required by the network camera). 5

6 Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception. Requirements Homeseer 3.0 or greater One or more IP network cameras that support JPEG snapshots. UltraNetCam3 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. 3. Click the + icon next to the Camera Support category, then click the checkbox next to the UltraNetCam3 (Network Camera) 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 UltraNetCam3 plug-in under Installed Plug-Ins, then enable it. UltraNetCam3 HSPI Configuration Web Page Layout The UltraNetCam3 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. NetCam Types Provides the ability to define the types of network cameras you have installed in your home. 6

7 4. NetCam Controls Displays and allows you to add, modify and delete network camera controls. You can also import and export controls. 5. NetCam Devices Displays and allows you to add, modify, delete and test network camera devices installed in your home. 6. Event Snapshots Provides the ability view and delete snapshot events. The snapshots are arranged by camera and date. 7. Latest Snapshots 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: NetCam Options Maximum Snapshot Events per Camera The maximum number of snapshots to keep per camera. The default is 50. Snapshots Per Page The default number of snapshots to display on the Snapshots web page. Snapshot Max Width The maximum width of the snapshots to display on the Snapshots web page. Snapshot Refresh Interval Specify how often the plug-in should refresh the camera snapshots. The default is disabled. Notification Options Notification Enable sending Snapshot Event notifications using the plug-in. To The default notification recipient address. From The default notification sender address. Subject The default notification subject. Body Template The default notification message body. Archive Options Archive Events Enable archiving Snapshot Events to local archive. Archive Directory Limit - The maximum size of all archived snapshot events to be stored in the archive directory. Archive Files Specifies the types of files to archive. Archive Directory The absolute path to the archive directory (e.g. c:\localdir or \\HostnameOrIPAddress\SharedFolder). FTP Archive Options Archive Events Enable archiving Snapshot Events to FTP archive. Archive Limit - The maximum size of all archived snapshot events to be stored in the archive directory. Archive Files Specifies the types of files to archive. Archive Directory The directory on the FTP archive to store the snapshot events. FTP Server Name The fully qualified domain name or IP address of the FTP server. 7

8 FTP User Name The FTP user name. FTP Password The FTP user password. Snapshot Event to Video Options FFmpeg Status The status indicating if the FFmpeg 3 rd party program is installed. This program is required to convert snapshots to MP4 video. Convert Snapshot Event to Video Snapshots will automatically be converted to an MP4 video if the number of snapshots exceeds this value. Web Page Access Authorized User Roles Specify the HomeSeer users authorized to access the UltraNetCam3 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. 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. Screenshot 8

9 Adding a New NetCam Type 1. Click on the UltraNetCam3 > NetCam Types > New 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 reenter the snapshot path in this field or keep the default value. 6. To add the NetCam Type, simply click on Create button. 7. To cancel, simply click the X icon in the upper right corner. Modifying an Existing NetCam Type 1. Click on the UltraNetCam3 > NetCam Types tab. 2. Find the NetCam Type you want to edit, and then click the Edit link. 3. Edit the values as needed, then press the Update button. 4. To cancel the changes, simply click the X icon in the upper right corner. Deleting an Existing NetCam Type 1. Click on the UltraNetCam3 > NetCam Types tab. 2. Find the NetCam Type you want to delete, and then click the Delete link. 3. Confirm you want to delete the NetCam Type by clicking the Delete button. 4. To cancel, simply click the X icon in the upper right corner. 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 Screenshot Adding a New NetCam Control 1. Click on the UltraNetCam3 > NetCam Controls tab. 2. Select the Network Camera Type from the drop-down list. 3. Click the New button near the the upper left corner. 4. Enter the Control Name and Control URL into the text boxes provided, and then press the Create button. 5. To cancel, simply click the X icon in the upper right corner. Modifying an Existing Control 1. Click on the UltraNetCam3 > NetCam Controls tab. 2. Select the NetCam Type from the drop-down list. 3. Find the Control Name you want to edit, and then click the Edit link. 4. Edit the Control Name and/or the Control URL, then press the Update button. 5. To cancel the changes, simply click the X icon in the upper right corner. Deleting an Existing Control 1. Click on the UltraNetCam3 > NetCam Controls tab. 2. Select the NetCam Type from the drop-down list. 3. Find the Control Name you want to delete, and then click the Delete link. 4. Confirm you want to delete the control by clicking the Delete button. 5. To cancel, simply click the X icon in the upper right corner. Deleting All Controls for a NetCam Type 1. Click on the UltraNetCam3 > 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

11 Screenshot Importing Controls 1. Click on the UltraNetCam3 > 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 UltraNetCam3 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. Screenshot Exporting Controls 1. Click on the UltraNetCam3 > 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. 11

12 Screenshot Adding a New NetCam Device 1. Click on the UltraNetCam3 > NetCam Devices tab. 2. Click the New button near the upper left corner of the web page. 3. Enter the NetCam name (e.g. Basement, outside, etc.). 4. Enter the NetCam IP address (e.g ). 5. Enter the NetCam TCP port number (e.g. 80). 6. Select the NetCam type. If the type is not available, you need to add a new type using UltraNetCam3 > NetCam Types. 7. Enter the NetCam User Id and User Password in the fields provided. 8. To add the NetCam Device, simply click on the Create button. 9. To cancel, simply click the X icon in the upper right corner. Modifying an NetCam Device 1. Click on the UltraNetCam3 > NetCam Devices tab. 2. Find the NetCam Device you want to edit, and then click the Edit link. 3. Edit the values as needed, then click the Update button. 4. To cancel the changes, simply click the X icon in the upper right corner. Deleting an Existing NetCam Device 1. Click on the UltraNetCam3 > NetCam Devices tab. 2. Find the NetCam Device you want to delete, and then click the Delete link. 3. Confirm you want to delete the NetCam Device by clicking the Delete button. 4. To cancel, simply click the X icon in the upper right corner. 12

13 Testing an Existing NetCam Device 1. Click on the UltraNetCam3 > NetCam Devices tab. 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. UltraNetCam3 HomeSeer Devices The UltraNetCam3 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. UltraNetCam3 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. Screenshot You can also control your NetCam by selecting a Device Action, then selecting Device, then Device Action. See UltraNetCam3 > Controls for setting up custom controls for your NetCam type. 13

14 Screenshot UltraNetCam3 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 UltraNetCam3 > 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 Screenshot UltraNetCam3 HSPI Cameras The Latest Snapshots web page allows you to view the most resent snapshot from your network cameras. The refresh internal can be changed from UltraNetCam3 > Options web page. Viewing the Last Camera Snapshot 1. Click on the UltraNetCam3 > Latest Snapshots tab. 2. Scroll though the list of snapshots from each network camera. 15

16 Screenshot UltraNetCam3 HSPI Triggers You can create HomeSeer events using any of the supported triggers below. UltraNetCam3 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.). 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}/UltraNetCam3?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 UltraNetCam3 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 "UltraNetCam3 Alarm Trigger", and then select the Camera that will trigger the event. 16

17 UltraNetCam3 HSPI Trigger Actions UltraNetCam3 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 Upload Compressed File to FTP Server Archive Event Select this checkbox to have an notification sent at the completion of the event. Select this checkbox to have the snapshot events compressed. Select this checkbox to copy the compressed snapshot event to the selected FTP archive. See UltraNetCam3 > Options for FTP Archive options. This option will allow UltraNetCam3 to save the video or compressed snapshot event to an alternate location within your network. 17

18 Screenshot UltraNetCam3 Take Snapshot This action causes the plug-in to capture a single snapshot from your network camera. The snapshot can be viewed from UltraNetCam3 > Cameras or viewed from the camera s root snapshot folder. Action Properties Action Properly Name Select Action Select Network Camera Action Property Description Take Snapshot The network camera you want to capture the snapshot from. Screenshot 18

19 UltraNetCam3 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 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. Screenshot UltraNetCam3 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 UltraNetCam3 > Options > Maximum Snapshots Events per Camera. Action Properties Action Properly Name Select Action Select Network Camera Number of Snapshot Events to Keep 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. 19

20 Screenshot UltraNetCam3 HSPI Trigger Conditions This plug-in does not have any HomeSeer trigger conditions defined. UltraNetCam3 HSPI API Reference To be determined 20