Raytec Milestone Plug-in User Guide © Raytec Ltd 2013 Raytec Global (excluding Americas) - Tel: +44 (0) 1670520055 sales@rayteccctv.com Raytec Americas - Tel: +1 613 270 9990 Toll Free: +1 888 505 8335 ussales@rayteccctv.com www.rayteccctv.
1 1 Contents 2 Introduction 3 System Requirements 4 Raytec Milestone Plug-in Installation Instructions 5 Using the Raytec Discovery Tool 6 Configuring Illuminators in the XProtect Management Application 7 Lighting Operation in the Smart Client 8 Example Configurations 9 Troubleshooting Guide Raytec Global (excluding Americas) - Tel: +44 (0) 1670520055 sales@rayteccctv.com Raytec Americas - Tel: +1 613 270 9990 Toll Free: +1 888 505 8335 ussales@rayteccctv.com www.rayteccctv.
2 2 Introduction This guide will help you install, configure and operate your VARIO IP illuminators within your Milestone Video Management System. Once configured you will be able to control and activate your illuminators in response to pre-configured system events, and in accordance with specific illumination settings. These events can be triggered via milestone alarms (e.g. camera, detector, illuminator photocell etc), which in turn can activate/deactivate your illuminator.
3 Alarms from the illuminator (e.g. photocell), are also able to control other network devices available in the Milestone system. Each VARIO IP illuminator can report the status of its photocell and external input to the Milestone system. These can be accessed in the alarm section of the management application where you can trigger events that can be used with other devices on your system. 2.
4 3 System Requirements 3.1 Pre- Requisites Milestone XProtect Client or Server installed .net framework 4 and 4.5 Version 1.1.0 Vario IP firmware or above The Raytec Milestone plug-in has been tested with and is compatible with the latest supported versions of the Milestone XProtect VMS product range which support the Milestone Integration Platform (MIP) architecture. At the time of testing this was: XProtect Corporate 5.0 XProtect Enterprise 8.1 XProtect Professional 8.1 XProtect Express 1.
5 4 Raytec Milestone Plug-in Installation Instructions Note: You must be logged on as an administrator to install this program. Close any open Milestone applications such as the XProtect Management Application or the Smart Client and run the Raytec Milestone Plug-in Installer by double clicking on it. Click the next button. Click “I agree to the terms and conditions” and click next. Raytec Global (excluding Americas) - Tel: +44 (0) 1670520055 sales@rayteccctv.
6 The installation should detect your Milestone installation folder, if it does not ensure that Milestone XProtect is installed on the machine. Click finish and the installation of the Raytec Milestone Plug-in will proceed, once the installation is complete you will be ready to configure your Milestone XProtect system.
7 5 Using the Raytec Discovery Tool When purchasing the VARIO IP illuminators you will have been supplied with a software package called the Discovery Tool. This application allows you to configure and check the illuminators on your network. A full instruction manual comes with the Discovery Tool and you should refer to this for detailed information on configuring illuminators with it. This section will detail the steps that allow you to add lamps to the Milestone XProtect system.
8 Select an illuminator you wish to configure from the list; this will highlight it. Click the Network button and the following windows will be displayed. You can choose to enable DCHP here should you wish. This will make the illuminator request an IP address from the DHCP server on your network, however this method does not guarantee that the IP address of the device will remain the same throughout its lifetime on the network. The recommended approach is to enter your IP address and subnet mask manually.
9 The following window will appear. Click the edit icon ( ) and you will now be able to change the name of your illuminator. Once you have changed it click the save icon ( ) to save your changes and click OK to return to the Discovery Tool window. Raytec Global (excluding Americas) - Tel: +44 (0) 1670520055 sales@rayteccctv.com Raytec Americas - Tel: +1 613 270 9990 Toll Free: +1 888 505 8335 ussales@rayteccctv.com www.rayteccctv.
10 Click the discover button and the changes to the illuminator name should appear. Note that any illuminators you wish to control through your VMS system should be configured for VMS control. This can be done through the VARIO IP web interface in the settings/groups page by deselecting the “Local (No VMS server)” option. Double click on the individual illuminators within the discovery application to access the VARIO IP web interface.
11 6 Configuring Illuminators in the XProtect Management Application This section will give you a quick introduction to configuring your VARIO IP illuminators in the XProtect Management Application. You should refer to the documentation provided with your Milestone XProtect system for further information about configuring events, alarms etc. After first discovering your illuminators on the network using the Raytec Discovery application, you must then discover them in the Milestone system.
12 Expand Advanced Configuration->MIP Plug-ins->Raytec Vario IP->Groups and right click on the Groups node and select “Create New”, the following screen will be displayed. This is the new group configuration screen. It will allow you to create a group and configure how it responds to events from the XProtect system. Group Name - Required The name of the group, which will be seen in the management application and in the smart client.
13 6.2 Adding Illuminators to a Group 6.2.1 Using the Discovery Page within Milestone VMS Open the XProtect Management Application Expand and click the Advanced Configuration->MIP Plug-ins->Raytec Vario IP node. The VARIO IP illuminator Discovery pane will be in the main window. Click the Discover button. You will be presented with a list of IP illuminators that are on the network as follows. You can select an illuminator by checking the box next to its name.
14 This screen provides information about the VARIO IP illuminators available on your network, key details such as the IP address, firmware and model information is displayed here to facilitate the configuration of your groups. The Raytec Milestone Plug-In utilises functionality available in newer versions of the IP illuminator firmware version 1.1.0 and up. If there is an illuminator that has an older incompatible version then you will be notified of this.
15 Group or Lamp on Trigger 1 or 2 Lamp power will be 20% The lamp will remain on until another trigger changes its state Group or Lamp Deter Trigger The deterrent will remain on until another trigger changes its state The pattern it uses will be wave The speed it uses will be slow The following screen shows the defaults described above.
16 6.4.1 Group or Lamp Trigger 1 and 2 Group or Lamp Trigger 1 and Trigger 2 are configured in the same way. You can select an event that will cause the trigger to activate by selecting the ‘select event’ button, this can be cleared by clicking the respective x button. Power This is the power that you wish the illuminator to activate at. This is set by using the sliding bar.
17 Speed This determines the speed at which the deterrent mode will run at, selectable speeds are slow, medium or fast. 6.4.3 Group/Lamp Off Trigger When associated with an event this switches the illuminators off. 6.4.4 Group/Lamp Boost Trigger When associated with an event this puts the illuminators into boost mode. Boost mode is a special mode where the power is increased to 120% for 10 seconds.
18 6.5.2 Configuring alarms from your illuminator It is possible to configure your Milestone system to respond to events created by your illuminators, these alarms are standard Milestone alarms and are covered in the Milestone configuration guide. Open the XProtect Management application On the left hand side select the Alarms section Right click on alarm definitions and select create new To raise an alarm from your illuminator, select VARIO IP Lamp from the ‘Triggering Event’ drop down menu.
19 6.5.2.1 External Input Active or Inactive Each illuminator has an external input that can be connected to any compatible device such as a PIR or switch. When the device connected to the lamp changes the state of its output the illuminator will detect this and will send the alarm to the XProtect system, an example of this would be a PIR detecting movement.
20 7 Lighting Operation in the Smart Client Your operators will be using the XProtect Smart Client for their day to day operation of the system. The VARIO IP illuminator integration will allow them to control the configured illuminators from this application. Note that at this stage, no user intervention is required in terms of set up, when the system is correctly configured to use events (see section 5.3); though they can still control the lights by group or individually should they need to. 7.
21 You may now control the illuminators in this group using the buttons provided. The buttons on the left will activate each illuminator at the brightness indicated. This action is timed for 5 minutes. On completion it will revert back to the illuminators’ previous state. The deterrent button will activate deterrent mode as Hi-Lo at fast speed for 30 seconds and once complete it will revert back to the illuminators’ previous state. 7.
22 The On and Off indicators show the current status of the illuminator. You may select either On or Off to change this status. When the illuminator is on you may move the power bar to change the power intensity of the selected illuminator. Any change to the illuminator on status or power level will remain valid for 5 minutes. The deterrent button will activate deterrent mode as Hi-Lo at fast speed for 30 seconds and once complete it will revert back to the illuminator’s previous state.
23 8 Example Configurations To provide an indication of the capability of the Raytec Milestone Plug-in and to assist in configuration of the system there are some example configurations discussed here. These propose some options you have when configuring your Milestone system and may provide solutions to help you to achieve your goals. These examples assume you have already configured the other parts of your Milestone system such as events raised from camera motion detects, PIR, audio alarms etc.
24 8.1 Configuration 1 Daytime the lamps in a group are always off At dusk the photocells on the lamps detect it is dark, the lamps should come on at 20% At dawn the photocells on the lamp detect it is light, the lamps should switch off If a motion detect is detected on camera 1 the lamps should go into deterrent mode for 60 seconds, SOS fast Camera 1 raises a hardware event when motion is detected, this event is called Cam1MotionDetect.
25 Event: Group1OffTrigger We achieve the desired results for our requirement by switching the lamps in our group on when the photocells say it is dark, and off when they say it is light. We ensure the lamp only goes into deterrent mode during the night by only allowing the deterrent trigger event to be raised during the period after the photocell has indicated it is dark but before the photocell has indicated it is light.
26 8.2 Configuration 2 Daytime the lamps are always off When it gets dark the lamps come on at 50% for 4 hours then switch off If a motion detect is detected on camera 1 the lamps should go into deterrent mode for 60 seconds, SOS fast Camera 1 raises a hardware event when motion is detected, this event is called Cam1MotionDetect.
27 We ensure the lamp only goes into deterrent mode during the night by only allowing the deterrent trigger event to be raised during the period after the photocell has indicated it is dark but before the photocell has indicated it is light. By setting the deterrent trigger to be revert back to previous level it means the lamps go back to their previous state, so within the first 4 hours they will go back to 50% after that 4 hour period and before it is light again they will switch off.
28 8.3 Configuration 3 Daytime the lamps in a group are always off If a motion detect is detected on camera 1 the lamps should go into deterrent mode for 60 seconds, SOS fast Camera 1 raises a hardware event when motion is detected, this event is called Cam1MotionDetect. Create the following manual events: Group1DarkTrigger Group1DeterTrigger Group1LightTrigger Create an alarm called Group1PhotocellDay, select the triggering event as Vario IP Lamp and Photocell Day.
29 9 Troubleshooting Guide Before trouble shooting for more complex issues encountered during installation or use of the Raytec Milestone plugin, the following check list should be used to ensure the target system is in a supported state. Important, please read the troubleshooting guide for the Raytec IP Illuminator to ensure the illuminator is working and set up correctly. 9.1 Vario IP Firmware version 1.1.0 or above “Local (No VMS server)” option is deselected 9.
30 9.4 Installation Issues 9.4.1 Installation Fails with ‘access is denied’ message Symptoms The installation stops and indicates that the installation failed with an error message that access was denied to folder “C:\Program Files\Milestone”. Note: the name of the program files folder may also contain the phrase “(x86)”. Cause Any application wanting to make changes in the “program files” or “program files (x86)” folder must have administrator privileges.
31 9.4.2 Installation Upgrade fails with ‘access is denied’ message Symptoms During an upgrade the installation stops and indicates that the installation failed with an error message that access was denied to “filename”.dll where file name could be: “Log4Net.dll” “ObjectListView.dll” “RaytecAPI.dll” “RaytecCommon.dll” “RaytecPlugin.dll” “VideoOS.Platform.
32 IMPORTANT NOTE When stopping the above service you will essentially disable the Milestone system, it will not be able to respond to events raised, and other parts of the system will not respond as normal until the service is restarted. Before performing this action you should make sure the user is aware of what this action will do, even though this is a temporary action. When the service is restarted the system should return to normal operation.
33 9.5.3 Illuminators not responding to the Milestone system After an installation of the Raytec Milestone Plug-in, you may find that some or all of the illuminators fail to operate when attempting to switch them on/off via the management application or the smart client. Should this be the case, you need to restart the management application, the smart client and the event server.
