Pelco Camera Integration Guide
Pelco Camera Integration Guide
Guide
May 2011
Legal Notice
DISCLAIMER
Schneider Electric (Australia) Pty. Ltd. makes no representations or warranties with respect to this manual and, to
the maximum extent permitted by law, expressly limits its liability for breach of any warranty that may be
implied to the replacement of this manual with another. Further, Schneider Electric (Australia) Pty. Ltd. reserves
the right to revise this publication at any time without incurring an obligation to notify any person of the revision.
COPYRIGHT
© Copyright 2011 Schneider Electric (Australia) Pty. Ltd. All rights reserved.
TRADEMARKS
Schneider Electric (Australia) Pty. Ltd. has made every effort to supply trademark information about company
names, products and services mentioned in this manual.
Citect, CitectHMI, CitectFacilities, PELCO, Vijeo Citect, Vijeo Citectlite and CitectSCADA are registered trademarks
of Schneider Electric (Australia) Pty. Ltd.
IBM, IBM PC and IBM PC AT are registered trademarks of International Business Machines Corporation.
MS-DOS, Windows, Windows NT, Windows Vista, Windows 7, Microsoft, and Excel are either registered trade-
marks or trademarks of Microsoft Corporation in the United States and/or other countries.
All other brands and products referenced in this document are acknowledged to be the trademarks or registered
trademarks of their respective holders.
GENERAL NOTICE
Some product names used in this manual are used for identification purposes only and may be trademarks of
their respective companies.
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. No
responsibility is assumed by Schneider Electric (Australia) Pty. Ltd. for any consequences arising out of the use of
this material. © 2011 Schneider Electric (Australia) Pty. Ltd.. All Rights Reserved.
Validity Note
The present documentation is intended for qualified technical personnel responsible for the implementation, oper-
ation and maintenance of the products described. It contains information necessary for the proper use of the prod-
ucts. However, those who wish to make a more "advanced" use of our products may find it necessary to consult
our nearest distributor in order to obtain additional information.
The contents of this documentation are not contractual and in no way constitute an extension to, or restriction
of, the contractual warranty clauses.
Legal Notice 2
Contents 3
Introduction 7
Safety Information 9
3
Contents
Reference 37
Chapter 8: Troubleshooting 55
Devices and tools 55
Implementation checklist 56
Debugging procedure 56
Enabling event logs 57
Troubleshooting guide 57
4
Contents
Glossary 63
Index 65
5
Contents
6
Part: 1
Introduction
Safety Information
7
8
Safety Information
Hazard categories and special symbols
The following symbols and special messages may appear in this manual or on the prod-
uct to warn of potential hazards or to call attention to information that clarifies or sim-
plifies a procedure.
A lightning bolt or ANSI man symbol in a "Danger" or "Warning" safety label on the
product indicates an electrical hazard which, as indicated below, can or will result in
personal injury if the instructions are not followed.
The exclamation point symbol in a safety message in a manual indicates potential per-
sonal injury hazards. Obey all safety messages introduced by this symbol to avoid pos-
sible injury or death.
Symbol Name
Lightning Bolt
ANSI man
Exclamation Point
DANGER indicates an imminently hazardous situation which, if not avoided, will result in
death or serious injury.
WARNING indicates a potentially hazardous situation which, if not avoided, can result in
death or serious injury.
9
Safety Information
CAUTION indicates a potentially hazardous situation which, if not avoided, can result in
minor or moderate injury.
CAUTION
CAUTION used without the safety alert symbol indicates a potentially hazardous situation
which, if not avoided, can result in property damage.
Please Note
Electrical equipment should be installed, operated, serviced, and maintained only by
qualified personnel. No responsibility is assumed by Schneider Electric (Australia) Pty.
Ltd. for any consequences arising out of the use of this material.
Do not use SCADA software as a replacement for PLC-based control programs. SCADA soft-
ware is not designed for direct, high-speed system control.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
10
Safety Information
LOSS OF CONTROL
l The designer of any control scheme must consider the potential failure modes of control
paths and, for certain critical control functions, provide a means to achieve a safe state
during and after a path failure. Examples of critical control functions are emergency
stop and overtravel stop.
l Separate or redundant control paths must be provided for critical control functions.
l System control paths may include communication links. Consideration must be given to
the implications of unanticipated transmission delays or failures of the link.*
l Each implementation of a control system created using SCADA must be individually and
thoroughly tested for proper operation before being placed into service.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
Integration of PELCO camera streaming with SCADA is provided as an aid and is not intended
to replace a complete security monitoring system.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
* For additional information, refer to NEMA ICS 1.1 (latest edition), "Safety Guidelines
for the Application, Installation, and Maintenance of Solid State Control".
11
Safety Information
12
Chapter 1: PELCO Viewer Usage
The PELCO Viewer ActiveX Control is designed for the PELCO Camera Video Streaming
interface in CitectSCADA, CitectFacilities and Vijeo Citect.
The PELCO Viewer ActiveX Control provides the ability to stream video through a
SCADA runtime page and control the camera.
Camera Model
Sarix IXE20C
Sarix IX10DN
Sarix IXS0DN
13
Chapter 1: PELCO Viewer Usage
14
Chapter 2: Installing the PELCO ActiveX Control
Minimum hardware and software requirements for PELCO Viewer ActiveX Controls for
Microsoft Windows XP, Microsoft Windows Vista and Microsoft Windows 7 must be
met in order to install and run the PELCO Viewer ActiveX Control.
SYSTEM STABILITY
The Pelco Viewer ActiveX Control must be installed on a SCADA display client to avoid addi-
tional CPU and memory overhead on the SCADA server.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
Installation requirements
This section describes the requirements for hardware, operating system software and sys-
tem configuration prior to installing the PELCO Viewer ActiveX Control.
System software
The following system software is required on any computer onto which you want to
install the PELCO Viewer ActiveX Control.
Other software
l SCADA 7.00 or later
l Microsoft .NET Framework 3.5 SP1
l Microsoft Visual C++ 2008 Redistributable SP1
15
Chapter 2: Installing the PELCO ActiveX Control
l A Local Area Network (LAN) if you want to have the client access a remote server.
l Microsoft DirectX 9.0 on Windows XP and 10 on Windows Vista or later
l Sentinel key protection
If you experience problems installing Microsoft .NET framework, download the full .NET
3.5 SP1 installation from the Microsoft site and manually install it, then run the PELCO
installation. Alternatively install SCADA 7.20 (which includes .NET 3.5 SP1) first.
If you are prompted by the PELCO installer to install the .NET Framework 3.5 Sp1 you
will be redirected to the Microsoft download site to install it. If you are directed to
another version of the .NET Framework, please choose the .NET Framework 3.5 Service
Pack 1 from the web page to ensure successful installation and function of the PELCO
Viewer. Alternatively install SCADA 7.20 (which includes .NET 3.5 SP1) before installing
PELCO.
System hardware
The PELCO Viewer is a resource intensive component and as such, hardware that meets
the recommended requirements should be selected for a SCADA client.
The ActiveX control requires DirectX 3D Acceleration enabled hardware, where video
stream rendering is handled by an external processor and RAM configuration on the
graphics card.
The following hardware is recommended for a computer that is used as a client running
PELCO camera video stream. The display adapters listed below have been tested. Some
graphics cards may provide poor quality video and, in some circumstances, loss of
colour and pixelation. See Video Streaming Performance for more information on the
impact of concurrent video streams on graphics card performance.
The following tables indicate the computer hardware requirements for the SCADA
PELCO ActiveX installation.
16
Chapter 2: Installing the PELCO ActiveX Control
RAM 1 GB
RAM 4 GB
Note: It is recommended that you run the PELCO interface on dedicated clients and
not on any of the other I/O, Alarm or Report Servers.
17
Chapter 2: Installing the PELCO ActiveX Control
POOR PERFORMANCE
l The PELCO Viewer requires a graphics adapter with sufficient video memory as indi-
cated in the table below.
l Ensure that no more than four concurrent video sessions are streamed on a single
SCADA graphics page.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
Depending on your computer’s dedicated video memory you should experience rea-
sonable video stream quality, performance, and responsiveness providing that number
of concurrent video streaming controls on the same page does not exceed the number in
the table below.
256 MB 1-2
512 MB 2-4
Documentation
After a successful installation, the documentation is available from the Windows Start
menu (Start > Programs > Schneider Electric > PELCO > PELCO User Guide).
18
Chapter 2: Installing the PELCO ActiveX Control
Ensure that cameras are configured to overlay the time-stamp & camera information on the
video stream to assist operators in correctly identifying the camera and the time at which the
image was relayed.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
If using RTP mode to connect to the camera, please ensure you enter valid values for:
l Camera IP address
l Camera Port (default is 49152 - check camera manual)
l ServiceID set to 1 (default camera number)
Optionally enter valid values for:
l Local IP address
l Local Port (default is 9102)
l Select the unicast check box
If using RTSP mode to connect to a Sarix camera, the connection can be established
using the following RTSP URL:
RTSP://<IP Address>/stream1
Press the Connect button. The PELCO Diagnostic Player window should display live
video streamed from your camera.
If the viewer is not showing live video image from your camera, that is the player shows
the default PELCO screen, then the camera is not connected. Please make sure that all
required software is installed on your computer and that the correct IP addresses and
ports are used. If the lack of connection persists, see Troubleshooting which contains
information on testing the camera using the PELCO software.
Note: Check that the ports are not blocked by the network administrator and that the
IP addresses are accessible.
19
Chapter 2: Installing the PELCO ActiveX Control
20
Chapter 2: Installing the PELCO ActiveX Control
21
Chapter 2: Installing the PELCO ActiveX Control
22
Chapter 3: Connecting to a PELCO Camera from a
Project
There are three ways to connect to a PELCO camera from within a SCADA project:
l Configuring during design time
l Using tag association
l Using Cicode
In SCADA v7.10 or earlier, the PELCO Viewer can be inserted by clicking on the Insert
ActiveX Control button in the Graphics Builder toolbar.
The PELCO Viewer will be added to your graphics page.
23
Chapter 3: Connecting to a PELCO Camera from a Project
24
Chapter 3: Connecting to a PELCO Camera from a Project
Ensure that continuous port numbers are not used for multiple cameras on the same page
when using unicast stream.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
When working with two or more cameras on a single page, unicast stream port values
should not be continuous because the next immediate port numbers are reserved for PTZ
operations. For example, if you have configured the unicast stream port value as 9001
for one camera and 9002 is used for the next camera then both cameras will display the
same image.
Once the configuration is updated, click the Apply button.
For a full list of camera properties see PELCO Viewer ActiveX Control Interface Prop-
erties.
2. Add a PELCO Viewer ActiveX control to your page (see Adding the PELCO ActiveX
Control).
3. Map tags to properties.
25
Chapter 3: Connecting to a PELCO Camera from a Project
Open the PELCO Viewer Properties window. On the Access tab and the Identification
subtab, set the Object Name to "PELCOCam". Make sure the “Persist ActiveX data
between page transitions” checkbox is checked.
Then on the Appearance tab and Tag Association sub-tab, map the variable tags
created above to the camera's properties.
4. Create buttons and objects to control the camera (see Controlling the camera).
5. Compile and run the project (see Compiling and running the project).
_ObjectCallMethod(ObjectByName("PELCOCam"), "Connect");
Similarly, create a new button with the label "Disconnect". Add the following action to
the Up command:
26
Chapter 3: Connecting to a PELCO Camera from a Project
_ObjectCallMethod(ObjectByName("PELCOCam"), "Disconnect");
A pan, tilt and zoom toolbar and popup menu are provided to control the PELCO PTZ
cameras. Right-click the viewer window and choose to show the toolbar. The PELCO
PTZ camera can also be controlled by using the mouse. Click and hold the left mouse
button, and move the mouse to control the camera. See PELCO Viewer Mouse Controls
for more information.
It is now possible to view the live video and control the PELCO camera using the built-
in pan, tilt and zoom controls such as toolbar buttons, mouse and popup menus. See
Pan, Tilt and Zoom Toolbar for more information. Cameras can also be controlled using
customised buttons. Some examples of custom control buttons can be seen in the PELCO
example project.
27
Chapter 3: Connecting to a PELCO Camera from a Project
Using Cicode
A PELCO camera control can be created and the camera controlled using Cicode func-
tions. The PELCO Viewer ActiveX Control comes with a group of programming inter-
faces which can be accessed via Cicode. The two examples below demonstrate how to
use Cicode to control your camera through the programming interface.
Example
In this example, a Cicode command is embedded in a Button object named Left that will
control the camera to pan left at runtime.
The Cicode command for the button down input is:
_ObjectCallMethod(ObjectByName("PELCOCam"), "PanLeft");
_ObjectCallMethod(ObjectByName("PELCOCam"), "PanStop");
In this case, when the button is clicked, the camera will pan to the left. The pan left oper-
ation stops when your button is released. “PELCOCam” used in the Cicode function is
the object name assigned to the PELCO Viewer ActiveX Control object on the page of
your project.
Example
In this example, two Cicode functions are defined that do the same job as the example
above.
FUNCTION RunPanLeft()
OBJECT hPELCOPTZ = ObjectByName("PELCOCam");
_ObjectCallMethod( hPELCOPTZ, "PanLeft");
END
FUNCTION RunPanStop()
OBJECT hPELCOPTZ = ObjectByName("PELCOCam");
_ObjectCallMethod( hPELCOPTZ, " PanStop");
END
28
Chapter 3: Connecting to a PELCO Camera from a Project
1. Double-click the PELCO ActiveX control you want to change. The Properties dialog
box appears.
2. Click the Access tab.
3. Click the Identification tab. The Identification panel appears.
4. In the Persistence area, select the Persist ActiveX data between page transitions check
box, and then click Apply.
29
Chapter 3: Connecting to a PELCO Camera from a Project
30
Chapter 4: PELCO Example Project
To test the PELCO cameras in the SCADA system, a PELCO Example Project has been
included in the installation. Example projects are provided in XP Style (Compatible with
v7, v7.10 and v7.20) and Tab Style (v7.20). They can be found in the Projects sub folder
of your chosen installation folder. After the project has been restored and compiled, enter
the connection details on the page and connect to the camera. The PELCO Example
project gives examples of one, two and four cameras, the Sarix camera, and Camera
Management. Some genies have been developed to help you get started. The project can
be expanded to cover more cameras and the genies can be reused in your own projects.
The PELCO PTZ toolbar and popup menu are provided to control the camera(s) posi-
tion, as well as mouse and customized control buttons.
Example
In this example, there is a PELCO PTZ camera in the front entrance of an office and a
PIR (sensor) installed to trigger the alarm.
To configure the Alarm Link
1. Configure the camera’s preset (for example, 15) to point to the front entrance where
the PIR (sensor) will be triggered when the area is armed or secured.
2. Create a digital alarm tag (for example, PIRTrigged).
31
Chapter 4: PELCO Example Project
FUNCTION FrontEntranceAlarmLink()
OBJECT hPELCOPTZ = ObjectByName("PELCOCam");
INT preset = 15;
IF PIRTrigged = 1 THEN
_ObjectCallMethod( hPELCOPTZ, "PresetRun", preset );
END
END
Genies
To simplify project creation, additional genies have been included in the example project
for:
l function - used to call functions inside the ActiveX control on the one camera page.
l setValue - used to create buttons and text objects to change the properties of the
PELCO camera.
l pelcoCameraSelector - used to manage multiple cameras on the PELCO Camera
Management page.
See the PELCO Example Project for examples of these genies.
32
Chapter 5: Further Viewer Features
The PELCO Viewer includes the following features:
l Pan, Tilt and Zoom controls
l Popup menu controls
l Mouse Controls
l RTSP and Sarix Cameras
Icon Description
Focus near/far
Iris close/open
This toolbar can be hidden by right-clicking the mouse button in the viewer window and
checking Show/Hide Toolbar.
33
Chapter 5: Further Viewer Features
CAMERA CONTROL CONFLICT
l If the PELCO cameras are being controlled exclusively through the SCADA system then
ensure your SCADA system is designed to allow only one operator to perform operations
on a camera at a time.
l If the PELCO cameras are being controlled independently by multiple systems (e.g
SCADA and Security) then ensure you have a clear documented and communicated proc-
ess in place to ensure no camera conflict occur.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
Pattern Operation:
The Pattern menu will appear when connected to a SpectraIV camera.
l Pattern > Run... - Runs the specified pattern
l Pattern > Record... - Begins recording a new pattern
l Pattern > End Record - Stops the current recording process
Click the Stop button in the PTZ Toolbar to stop the Pattern Operation.
Preset Operation:
The Preset menu will appear when connected to a camera equipped with PTZ functions.
l Preset > Run... - Runs the specified preset
l Preset > Set... - Sets the selected preset to the current camera position
l Preset > Delete... - Deletes the specified preset
l Preset > Home - Runs the currently configure home preset
l Preset > Configure Home Preset... - Allows specification of which preset represents
the home position
Note: The number of presets that can be configured from PELCO ActiveX is 1-256
(based on the camera preset limit).
34
Chapter 5: Further Viewer Features
Scan operation:
The Scan menu will appear when connected to a SpectraIV camera equipped with PTZ
functions. There are three built in scan sequences: auto, random and frame. The default
is auto, which is a sequential scan.
l Scan > Scan Random - Continuously rotates the camera horizontally in random incre-
ments. Random scan, being random in nature, can take several seconds to commence
l Scan > Scan Frame - Continuously rotates the camera horizontally in 90 Degree incre-
ments
l Scan > Scan Auto - Continuously rotates the camera 360 degrees
Click the Stop button in PTZ Toolbar to stop the scan operation.
Tour operation:
The Tour menu will appear when connected to a Sarix camera equipped with PTZ func-
tions.
l Tour > Run... - Runs the specified tour
Click the Stop button in the PTZ Toolbar to stop the Tour Operation.
Note: Tours must be created using the camera's web interface. For more information,
please refer to the PELCO Spectra HD camera user manual. When creating the Tour
from the web interface you must follow a strict naming convention in order to run
the Tour from the PELCO Viewer. The tour name must contain and start with the
(case-insensitive) word "Endura" AND a number afterwards. The Tour names must
end in a digit and the set of all digits must be consecutively numbered starting at 1.
Tour Name Examples: Endura Tour 1, Endura Tour 2, Endura Tour 3
Other Operations:
The Operation menu will appear when connected to a SpectraIV camera.
l Operations > Rotate 180 Degrees - Pans the camera 180 degrees from its present posi-
tion.
l Operations > Pan to Zero - Pans the camera back to the camera's zero position. This
is not necessarily the same as the home position for the camera.
35
Chapter 5: Further Viewer Features
Note: Mouse controls for Spectra HD Sarix cameras may have slow response times.
To avoid this, use the buttons on the toolbar instead.
36
Part: 2
Reference
This section describes the properties and methods used to access and
control PELCO cameras from within SCADA. In addition it provides
a troubleshooting section to help investigate loss of connection with
your cameras.
Troubleshooting
37
38
Chapter 6: PELCO Viewer ActiveX Control Inter-
face Properties
The following properties can be used to manage and control PELCO IP cameras in var-
ious ways, from video streaming, PTZ control speed and other properties at SCADA run-
time. See "PELCO Viewer ActiveX Control Interface Properties"
Property Description
HomePresetId Camera preset ID used for the home position/button on the PTZ
control.
UnicastStreamIP The IP address of your local computer that the PELCO device will
stream the video to.
UnicastStreamPort The port that the PELCO device will use for unicast listening in for
the video.
39
Chapter 6: PELCO Viewer ActiveX Control Interface Properties
Properties
To be able to connect to a PELCO camera from the PELCO Viewer ActiveX control at run-
time, the camera connection information must be specified to an object in the PELCO
Viewer ActiveX control. When setting properties via Cicode, the values will not be per-
sisted when you navigate away from the page and they will need to be set again when
you re-open the page. You can have the last values automatically set either using tags
(see Tag Association) or using the “Persist ActiveX data between page transitions”
option.
Listed below are the properties of the PELCO Viewer ActiveX Control interface in this
release.
AutoConnect
This property causes a configured camera to be automatically connected when the page
is loaded in runtime. Set to "1" to enable auto connection.
Data Type: Digital
Allowable Values:
l 0 - AutoConnect property is Off
l 1 - AutoConnect property is On
Default Value: 0
Bandwidth
Returns the streaming video bandwidth constraints. The higher the bandwidth, the
better the image quality, the greater the processing power, but the network traffic will
also be greater.
There are three factors that affect bandwidth:
l The total number of cameras connected
l The motion type (low, medium, high) – A camera transmits actual frames and delta
frames so the more the image changes, the higher bandwidth used
l Bandwidth type - There are three types of bandwidth setting in PELCO Viewer:
High 30 2,000,000 15
Medium 30 150,000 15
40
Chapter 6: PELCO Viewer ActiveX Control Interface Properties
Low 30 198 15
CameraNumber
Changes the active camera being viewed on a DVR. Set this value to 1 for normal IP
cameras.
Data Type: Long
Allowable Values: Any valid PELCO camera number.
Default Value: 1
CameraIpAddress
The IP address of the PELCO device where video is streamed from.
Data Type: String
Allowable Values: Any valid PELCO camera IP address.
Example: 192.168.0.90
CameraPortNumber
The port number of the camera.
Data Type: Long
Allowable Values: Any valid PELCO camera port number.
Default Value: 49152
41
Chapter 6: PELCO Viewer ActiveX Control Interface Properties
HomePresetId
Camera preset ID used for the home position/button on the PTZ control.
Data Type: Int
Allowable Values: Any valid PELCO camera preset number.
Default Value: 3
ReverseTilt
This property allows the user to reverse the tilt direction when using the mouse during
RTP streaming.
Data Type: Digital
Allowable Values:
l 0 – Reverse Tilt property is Off
l 1 – Reverse Tilt property is On
Default Value: 0
RtspMode
Specifies the type of camera connected, either RTP or RTSP.
Data Type: Int
Allowable Values:
l 0 - RTP camera
l 1 - RTSP camera
Default Value: 0
RtspUrl
Provides the RTSP URL if the camera is a RTSP camera. Dependent on the configuration
of the RTSP camera.
Data Type: String
Allowable Values: Any valid PELCO Sarix camera URL.
Example: rtsp://192.168.0.18/stream1
42
Chapter 6: PELCO Viewer ActiveX Control Interface Properties
UnicastStream
Specifies either a unicast or multicast streaming type.
Unicast
A unicast connection sends a separate video stream from the camera to each Pelco
Viewer (client). Although multiple Pelco Viewers might request the same data from the
camera at the same time, a unique, separate video stream is transmitted to each Pelco
Viewer.
Every unicast connection to the camera consumes additional processing power which
limits the number of simultaneous clients which can access the camera.
PELCO cameras support a maximum of 20 simultaneous clients.
Multicast
A multicast connection sends a video stream to multiple PELCO Viewers (clients) at the
same time using one, shared transmission stream. Unlike unicast, multicast com-
munication requires much less processing power for the camera, instead your network
design and the type of network switches used are the important factors in the number of
clients that can be supported and the performance of your system. Multicast is useful
only for local area networks and can be used to preserve network bandwidth.
For more information about network, bandwidth and Switch Compatibility related infor-
mation please see Endura Network Design Guide and Endura Switch Compatibility
When using multi-cast please be aware that the video stream is sent to your primary net-
work adapter. If you are running virtualization software on your machine it may pre-
vent the video stream from being sent to your primary network adapter. Please see
Troubleshooting for more information.
When a unique connection to the camera is required then select the unicast option and
provide your computer's Local IP address and valid port details. The video will be
streamed to this IP address. If this property is false then multicast streaming will be
established.
Data Type: Digital
Allowable Values:
l 0 - Unicast Stream Off (Unicast Stream IP and port will be ignored)
l 1 - Unicast Stream On
Default Value: 0
UnicastStreamIP
The IP address of your local computer to which the PELCO device will stream the video.
43
Chapter 6: PELCO Viewer ActiveX Control Interface Properties
UnicastStreamPort
The port that the PELCO device will use for Unicast listening for the video.
Data Type: Long
Allowable Values: Your local computer’s port number used for video stream.
Note: Unicast stream port values should not be consecutive for different cameras on
the same page because the next immediate port numbers are reserved for PTZ oper-
ations.
VelocityHorizontal
The horizontal rotation velocity setting.
Data Type: Long
Allowable Values: Any valid PELCO camera horizontal velocity number. This is for
PTZ cameras only.
Default Value: 64000
VelocityVertical
The vertical rotation velocity setting.
Data Type: Long
Allowable Values: Any valid PELCO camera vertical velocity number. This is for PTZ
cameras only.
Default Value: 8000
44
Chapter 6: PELCO Viewer ActiveX Control Interface Properties
Example
Where "PELCOCam" is the object name of a PELCO Viewer ActiveX Control instance
inserted on a graphics page.
FUNCTION SetVelocityHorizontal()
OBJECT hPELCOPTZ = ObjectByName("PELCOCam");
INT oldSpeed = _ObjectGetProperty(hPELCOPTZ,"VelocityHorizontal");
INT newSpeed = StrToInt(Input("Velocity Horizontal", "Enter pan speed", old-
Speed));
_ObjectSetProperty( hPELCOPTZ, "VelocityHorizontal", newSpeed );
END
45
Chapter 6: PELCO Viewer ActiveX Control Interface Properties
46
Chapter 7: PELCO Viewer ActiveX Control Inter-
face Methods
The PELCO Viewer ActiveX Control methods are designed to give you the ability to con-
trol PELCO cameras automatically as much as possible. For example, you can auto-
matically switch to another camera in a viewer or to a different preset, or run a pattern.
The list below provides some tasks that can be achieved automatically:
l Switch cameras in a viewer
l Send focus (+ or --) commands
l Send PTZ commands to a PELCO PTZ camera
l Send iris close/open commands
l Send create/go to/delete preset commands
l Record and run patterns
In this section, available methods have been categorised and listed for each category.
Additional details on how to use these methods in each category are provided in the
examples.
The main categories for methods are:
l Connection methods
l Customize User Interface methods
l PTZ methods
l Preset methods
l Pattern methods
Connection Methods
Connection methods are used to connect to and disconnect from a PELCO device.
The table below contains connection methods for the PELCO Viewer ActiveX Control
interface in this release.
47
Chapter 7: PELCO Viewer ActiveX Control Interface Methods
Example
To connect to a camera, the Connect() method should be used. The example below
shows how Cicode can be used to connect to a PELCO camera. The other two methods
can be used in the same way as this method. "PELCOCam" used in the example code is
the actual object name that has been assigned to the PELCO Viewer ActiveX Control
object in this project.
FUNCTION ConnectCamera()
OBJECT hPELCOCam = ObjectByName("PELCOCam");
_ObjectCallMethod(hPELCOCam, "Connect");
END
48
Chapter 7: PELCO Viewer ActiveX Control Interface Methods
PTZ Methods
PTZ methods are used to pan, tilt and zoom a PELCO PTZ camera and are not appli-
cable to fixed cameras. If the camera supports it, it can also change the focus and iris on
any camera that support those functions programmatically.
The table below contains the PTZ methods for PELCO Viewer ActiveX Control in this
release.
49
Chapter 7: PELCO Viewer ActiveX Control Interface Methods
When a pan method is called, for example PanLeft, it will continue to run until a Pan-
Stop method is called.
LOSS OF CONTROL
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
Note: PanLeft and PanRight methods require PanStop to be called to stop the camera
from continuously panning.
Example
An example has been provided below on how to use the PanLeft method to pan a PTZ
camera left for 10 seconds and then stop the operation. Any other PTZ methods can be
used in the same way as this method. "PELCOCam" used in the example code is the
actual object name that has been assigned to the PELCO Viewer ActiveX Control object
in this project.
FUNCTION PanCameraLeft()
OBJECT hPELCOCam = ObjectByName("PELCOCam");
_ObjectCallMethod(hPELCOCam, "PanLeft");
SleepMS(10000);
_ObjectCallMethod(hPELCOCam, "PanStop");
END
Preset Methods
The preset methods are used to manage and run presets on a PELCO PTZ camera and
are not applicable to fixed cameras. Home is also a special preset in the PTZ camera. It
is also possible to set the Home position and point the camera to the Home position that
has been selected for the camera.
The table below contains preset methods for the PELCO Viewer ActiveX Control inter-
face in this release.
50
Chapter 7: PELCO Viewer ActiveX Control Interface Methods
PresetSet( long presetId ) Stores the current camera position (pan/tilt) and zoom
level at the specified preset ID.
PresetHomeSet() Stores the current camera position and zoom level as the
home preset ID (defaults to preset ID 3)
PresetRun( long presetId ) Moves the camera to the location and zoom level stored
at the specified preset ID.
PresetHomeRun() Moves the camera to the location and zoom level stored
in the home preset ID (defaults to preset ID 3).
Example
The example below shows how to use the PresetRun method to control the PTZ camera.
Other preset methods can be used in the same way as this method. In the example
below, a Cicode function has been written to run a preset position that has been pro-
grammed and stored into the PTZ camera. "PELCOCam" used in the example code is the
actual object name that has been assigned to the PELCO Viewer ActiveX Control object
in this project.
FUNCTION RunPreset()
OBJECT hPELCOCam = ObjectByName("PELCOCam");
INT preset = StrToInt(Input("Run Preset", "Enter the Preset number to Run", "1"
));
_ObjectCallMethod(hPELCOCam, "PresetRun", preset );
END
Example
In example below, the Cicode function demonstrates how to save the PTZ camera’s cur-
rent position and settings as the Home position.
FUNCTION SaveHomePosition()
OBJECT hPELCOCam = ObjectByName("PELCOCam");
51
Chapter 7: PELCO Viewer ActiveX Control Interface Methods
_ObjectCallMethod(hPELCOCam, "PresetHomeSet" );
END
Pattern Methods
Pattern methods are used to record and run patterns on a PELCO PTZ camera and are
not applicable to fixed cameras.
The table below contains pattern methods for the PELCO Viewer ActiveX Control inter-
face in this release.
PatternRun( long patternId ) Run the camera movement pattern specified by the pat-
tern ID.
PatternStop( long patternId ) Stop the camera movement pattern specified by the pat-
tern ID.
PatternStart( long patternId ) Start recording the camera movement pattern specified
by the pattern ID.
PatternEnd( long patternId ) End recording for the camera movement pattern spec-
ified by the pattern ID.
Note: If you use the PatternStart method to start recording a pattern, then a Pat-
ternEnd method must be used to end the recording. Also note that there is only one
pattern supported on some PELCO PTZ cameras in IP mode.
LOSS OF CONTROL
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
52
Chapter 7: PELCO Viewer ActiveX Control Interface Methods
Example
The example below shows how to use the PatternRun method to run a pattern on the
PTZ camera. Other pattern methods can be used in the same way as this method. In the
example below, a Cicode function has been written to run a pattern previously recorded
and stored in the PTZ camera. "PELCOCam" used in the example code is the actual
object name that has been assigned to the PELCO Viewer ActiveX Control object in this
project.
FUNCTION RunPattern()
OBJECT hPELCOCam= ObjectByName("PELCOCam");
INT pattern = StrToInt(Input("Run Pattern", "Enter the Pattern Number to Run",
"1" ));
_ObjectCallMethod(hPELCOCam, "PatternRun", pattern );
END
53
Chapter 7: PELCO Viewer ActiveX Control Interface Methods
54
Chapter 8: Troubleshooting
In this section, some guidelines and tips are provided for debugging on PELCO camera-related projects.
When working with PELCO Viewer ActiveX control, you will be able to see real time camera status in the
‘status bar' and additional information will be logged in the Windows ‘event viewer’. Enter the “eventvwr”
run command to launch the Event Viewer. For specific PELCO camera difficulties, please refer to your
PELCO camera's manual.
Essential devices
In order to analyse functionality related to PELCO camera projects, you will need either
direct or indirect access to a PELCO IP or Sarix camera. Be aware that if the camera is
accessed over the Internet, you will experience poor streaming quality and very poor
responsiveness to the camera controls.
Essential tools/utilities
There are some tools and utilities recommended to assist in analysing the functionality
of PELCO camera on SCADA projects:
l PELCO Device Utility – Assists in locating a PELCO camera IP address on your net-
work.
l PELCO Diagnostic Player – Tests camera video rendering on the system.
l DXDIAG – Checks the DirectX version and sets and tests Direct3D acceleration on
your computer.
l DESK.CPL – Checks dedicated on-board memory on your graphic card.
l Wireshark – Checks network communication between your computer and PELCO
camera.
l Intel UPnP Device spy – Locates the PELCO RTP camera IP address and port
number.
55
Chapter 8: Troubleshooting
Implementation checklist
Before debugging you system, please go through the checklist below to make sure that
the PELCO camera has been implemented optimally.
l The Hardware and software requirements in the Installation Requirements have been
met or exceeded.
l Only PELCO IP or Sarix cameras have been tested and are supported.
l Only use a cable modem router or a switch with a DHCP server when installing
PELCO IP cameras on a network.
l Do not use a HUB in the network setup of an IP camera.
l Place PELCO cameras behind a firewall when they are connected to a network.
l Install the latest version of the PELCO Viewer ActiveX Control.
Debugging procedure
Generally, there are three types of functions to analyse:
l Camera hardware, setup or network related
l PELCO Viewer ActiveX and its dependencies software setup/configuration related
l PELCO Viewer ActiveX configuration/setup in SCADA projects during SCADA
project configuration or runtime
The procedure listed below will help you identify the type of issue and assist with debug-
ging.
1. Is the camera a PELCO camera?
This manual addresses issues with PELCO cameras only.
2. Can you view the video stream in Internet Explorer?
If not, there may be an issue with the camera, installation or network.
3. Can you view the video stream in PELCO Diagnostic Player?
If not, there may be an issue with the PELCO Viewer installation. Re-install and con-
figure the PELCO Viewer and try again.
4. Can you view the video stream in SCADA runtime?
If not, there may be some project related issue preventing access to the video stream.
Try to connect to the camera using the PelcoExample test project.
See the Troubleshooting Guide section for information.
56
Chapter 8: Troubleshooting
REGISTRY CORRUPTION
Do not attempt to modify registry settings unless you are an expert user of the Windows oper-
ating system and SCADA, or are under the direct guidance of technical support for this prod-
uct.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
To enable event logs, open a registry editor and make the following change:
1. In Windows Run Command type “regedit”
2. Navigate to “HKEY_LOCAL_MACHINE\SOFTWARE\Schneider Electric\Pelco”
3. Set the “Log Value” key to "1" to enable event logging and "0" to disable event log-
ging.
Troubleshooting guide
Symptom: .NET Framework 3.5 SP1 fails to install through web directly.
A port may be Download the full package of .NET 3.5 SP1 manually and install it
blocked from down- before installing Pelco Viewer. The full version can be downloaded
loading and install- from the Microsoft website.
ing the installer
directly from web.
Installer might
launch a link to
download .NET ver-
sion other than 3.5
SP1
57
Chapter 8: Troubleshooting
Symptom: During Uninstalling PelcoViewer an error message saying “Error 1001: InstallUtilLib.dll.
Unknown error.” is appearing.
The necessary .NET Install .NET Framework 3.5 SP1 and un-install Pelco Viewer.
version missing.
Symptom: In case of #COM errors or Runtime values for tags not getting updated/refreshed.
Sample project Run Computer Setup wizard or navigate to another page and then
restore/pages return to the page causing update issues.
update issues.
REGISTRY CORRUPTION
Do not attempt to modify registry settings unless you are an expert user of the Windows oper-
ating system and SCADA, or are under the direct guidance of technical support for this prod-
uct.
Failure to follow these instructions can result in death, serious injury, or equip-
ment damage.
58
Chapter 8: Troubleshooting
Are the camera IP Use Intel UPnP Device spy to check your camera IP address and
address, port port number. The port number usually has a default value 49152
number and cam- and camera number should be 1.
era number cor-
rect?
If not, (if they are different from camera IP address and port
number reported by Intel UPnP Device spy), try the new IP
address and port number.
If yes, (they are the same), or there is still no video image when
trying the new values, then continue.
You are using Virtualization software typically installs its own software network
multi-cast and adapters on your machine. These adapters, if enabled, can steal
have virtualization multi-cast traffic. Resolutions include:
software installed
such as VMWare. 1. Disable virtual network adapters
2. Use a unicast connection and specify your network adapter
3. Consult your virtualization software manufacturer for other
solutions
Does this happen If yes, this is by design and cannot be changed during runtime.
when using toolbar If no, please continue.
PTZ control buttons?
Does this happen If yes, this is by design and cannot be changed during runtime.
when using mouse If no, please continue.
control?
59
Chapter 8: Troubleshooting
Network too slow Make sure the camera is within the local network. Improve net-
work speed.
Have you set If no, set RtspMode property to true (non-zero value) at runtime
RtspMode property and try again.
to true at runtime?
If yes, continue.
Have you set If no, set RtspURL property to the correct value at runtime and try
RtspURL property again. The default format of this property is: Rtsp://Camera_IP_
to correct value at Address/stream1
runtime?
60
Chapter 8: Troubleshooting
Caused by conflicting object Rename conflicted object name assigned to the PELCO
names assigned to the Viewer ActiveX Control object
PELCO Viewer ActiveX Con-
trol object
Caused by conflicting object Rename conflicted object name used in Cicode Connect
names used in Cicode Con- function
nect function
Caused by conflicting uni- Resolve conflicted uni-casting port number. Any uni-
casting port numbers casting port number can only be used once.
61
Chapter 8: Troubleshooting
There is not enough ded- Replace current graphics card/computer with graphics
icated memory card/computer that has more dedicated memory
Cicode error in the project Fix Cicode error in the SCADA project.
62
Glossary
A
ActiveX
A framework for defining reusable software components that perform a particular function or set of
functions in Microsoft Windows in a way that is independent of the programming language used to
implement them. A software application can then be composed of one or more of these components
in order to provide its functionality.
D
DVR
Digital Video Recorder
I
Iris
A mechanical device found in cameras that mimics the function of the biological iris.
P
PELCO camera
In this document, PELCO camera refers to PELCO IP cameras and PELCO Sarix cameras.
PELCO device
In this document, PELCO device refers to PELCO RTP and RTSP cameras.
PTZ
Pan, Tilt and Zoom
R
RAM
Random Access Memory
RTP
Real-Time Transport Protocol
63
Glossary
RTSP
Real-Time Streaming Protocol
S
Sarix
A new camera imaging technology developed by Pelco
SCADA
Supervisory Control and Data Acquisition. In this document, SCADA refers to Vijeo Citect, Citect-
SCADA or CitectFacilities
64
D
Index debugging checklist
debugging procedure
56
56
DirectX 16
Disconnect() method 47
disconnecting from a camera 26
#
DXDIAG 55
#COM issues 58
A E
example project 31
ActiveX control, installing 18
camera management page 31
adding buttons 26
Alarm link issues 62 F
AutoConnect property 40 FocusAuto() method 49
FocusFar() method 49
B
FocusNear() method 49
Bandwidth property 40
FocusStop() method 49
buttons, adding 26
buttons, connect and disconnect 26 G
genie
C
function 32
camera availability 20
pelcoCameraSelector 32
camera control with Cicode 28
SetValue 26, 32
camera control, with mouse 36
graphic card memory 18
camera management page, example project 31
graphics pages, defining 23
camera number 20
camera port number 20 H
camera preset positions 34 hardware requirements 16
camera properties 26, 40 HomePresetID prroperty 42
camera properties, reading and writing 44 I
camera scan sequences 35 image quality issues 61
camera tour operations 35 implementation checklist 56
camera, configuring in design time 24 install issues 57
CameraNumber property 41 installation 15
cameras verifying 18
RTSP & Sarix 36 invalid IP address 58
supported 13 IP address 20
Cicode, controlling the camera 28, 47 IPAddress property 41
concurrent video streams 17 IrisAuto() method 49
Connect() method 47 IrisClose() method 49
connecting to a camera 26 IrisOpen() method 49
control methods 47 IrisStop() method 49
controlling the camera with mouse 36 M
controls, adding 26 mapping tags 26
65
Index
66
Index
VelocityVertical property 44
video streaming requirements 17
W
writing camera properties 44
Z
zero position 35
ZoomIn() method 49
zooming 33
ZoomOut() method 49
ZoomStop() method 49
67
Index
68