Serial communication interfaces.

This driver needs to both send commands and to receive replies back from the PTZ units. This means that this driver needs a video encoder with a full or half duplex serial communication interface.

Consult the documentation for the video encoder for information about which of the serial interfaces (see below) that are supported.

RS232 serial interface. This is a full duplex, point-to-point serial interface. A serial converter is probably required to match the interface on the Pelco PTZ unit.
RS422 (4-wire) serial interface. This is a full duplex, point-to-point serial interface.
RS422 (2-wire) serial interface. This is a simplex serial interface. This interface will not work together with this driver.
RS485 (4-wire) serial interface. This is a full duplex, multi-drop serial interface.
RS485 (2-wire) serial interface. This is a half duplex, multi-drop serial interface.

Support for different Pelco PTZ models.

Some Pelco PTZ unit will not work with this absolute driver. This depends on the Pelco PTZ model and the internal firmware version inside the Pelco PTZ unit. Below is a short guideline. Ask Pelco for more detailed information about a specific Pelco unit.

Pelco Esprit model. This model use a RS422 4-wire serial interface. This model is not tested. Pelco Esprit units with old internal firmware will not work (absolute PTZ commands are not supported). Ask Pelco for more information about the different Pelco Esprit models and firmware versions.
Pelco Spectra III model. This model will work using a RS422 4-wire serial interface.
Pelco Spectra IV model. This model will work using a RS422 4-wire, RS485 4-wire or RS485 2-wire serial interface. Connecting more than one Pelco Spectra IV PTZ unit to the same serial port is not tested (some commands might introduce conflicts if more than one PTZ unit is connected).
Pelco Spectra Mini Dome model. This model will work using a RS422 4-wire serial interface.

Auxiliary commands

The base URL for auxiliary commands looks like the following: http://<axis-video-encoder-ip>/axis-cgi/com/ptz.cgi?camera=<n>&auxiliary=<aux-command>

<axis-video-encoder-ip> specifies the IP-address of the Axis Video encoder.

<n> specifies the camera number(default = 1) in the Axis Video Server.

<aux-command> is specified as follows:

version: Ask for version information from the PTZ unit. The version information will be written to the log-file.
aux<k>:on: Send the Pelco command "Set Auxiliary" with the value <k>
aux<k>:off: Send the Pelco command "Clear Auxiliary" with the value <k>
write:<hex>,read:<nbr>,timeout:<t>: Writes <hex> and reads <nbr> bytes as response with <t> ms timoeout
write:<hex>,read:<nbr>: Writes <hex> and reads <nbr> bytes as response with default timoeout
write:<hex>: Writes <hex> without reading respons.
read:<nbr>,timeout:<t>: Reads <nbr> number of bytes and sets timeout to <t>ms.
read:<nbr>: Reads <nbr> number of bytes and uses default value of timeout.

<k> specifies the Pelco "aux number" and must be between 1 and 8. The function and the number <k> is Pelco PTZ unit dependent.

Different Pelco PTZ units have different capabilities.

Different Pelco PTZ units have different capabilities. The parameters below need to be adjusted to match the behavior of the connected Pelco PTZ unit.

Video Source Configuration

Parameter	Description	Range
Device ID	This is the address of the connected device. This value corresponds to the value of the address switches in the connected device.	1-255
Device Type	Selects the type of device to use.	"Generic", "Esprit ES30C/ES31C", "Spectra III", "Spectra IV", "Spectra Mini"

Driver Specific Settings

There are no driver specific settings for this driver.

Mechanical limits

Note: These limits may not affect the camera when it is controlled by a joystick in continuous mode. To restrict the camera in continuous mode, the PTZ unit must support setting of these limits (see also "Pan limits support" and "Zoom limits support" below). On some PTZ units, it is possible to set these limits inside the "On Screen Display" menu (see below).

Movement Limits	Minimal value	Maximal value	Comment
Left	-180	180
Right	-180	180
Up	-180	180
Down	-180	180
Zoom Limits
Zoom wide	1	19999	The digital zoom range is 10000-19999.
Zoom tele	1	19999	The digital zoom range is 10000-19999.
Optical Data
Min field angle	1	1000	Not used.
Max field angle	1	1000	The horizontal field angle (degrees * 10) at zoom wide position.

The "Max field angle" is used to tune image centering:

Set the parameters "Max optical zoom", "Max digital zoom" and "Max zoom limit" (see below) to match your PTZ unit.
Set the parameter "Max field angle" to match your PTZ unit.
Zoom out completely and adjust "Max field angle" until the spot you click becomes centered accurately. A smaller "Max field angle" will yield smaller movements.

Light Control

Parameter	Description	Range
IR cut filter	Set to on to enable the infrared cut filter if present. Note: Set the IR cut filter to "OFF" in the On Screen Display menu to enable control via the web interface.	Off, On, Auto
Back light compensation	Set to true to use the back light compensation if present.	true, false

Extended Driver Specific Settings

Parameter	Description	Range
Focus speed	Current focus speed. If "Focus speed support" (see below) is false, the focus speed "100" will always be used. NOTE: This value is mapped to 4 discrete speeds in the driver.	1-100
Focus per unit	Calibration constant for focus. Higher values give greater focus changes. Calibrate at the most commonly used focus speed, by confirming that a maximum focus request performs a maximum focus change.	1-65535
Iris time	Calibration constant for iris (time in ms for maximum iris change). Higher values give greater iris changes. Calibrate by confirming that a maximum iris request (e.g. "riris=9999") at one extreme (e.g. full iris close) takes you to the other.	1-65535
Max optical zoom	The maximum optical zoom magnification.	1-100
Max digital zoom	The maximum optical and digital zoom magnification.	1-10000
Max zoom limit	The maximum zoom magnification limit. This limit is normally set using the "On Screen Display" (see below) in the PTZ unit.	1-10000
Zoom log factor	A factor controlling how much the zoom is logaritmized. A larger factor will make the zoom curve more non-linear. This does not affect the limits, just how the values between the limits are distributed. If this factor is zero, a linear magnification scale will be used.	0-50
Flip pan	If set to true, pan operations will be inverted.	true, false
Flip tilt	If set to true, tilt operations will be inverted.	true, false
Pan limits support	Set to true if the PTZ unit support setting of pan limits.	true, false
Zoom limits support	Set to true if the PTZ unit support setting of zoom limits.	true, false
Focus speed support	Set to true if the PTZ unit support different focus speeds.	true, false
Ircut filter support	Set to true if the PTZ unit support ircut filter.	true, false
Backlight support	Set to true if the PTZ unit support backlight compensation.	true, false
Goto preset delay	Time (in seconds) it takes for the image to stabilize it self, after the camera has performed the longest "goto preset action". Used for disabling/enabling image analysis (e.g. motion detection).	0-100

Supported on-screen display commands

CGI Command	Description	PTZ Command
Open	Open the on-screen display menu of the connected device. A menu will then appear in the image.	Combination of commands (iris open, focus near, zoom out).
Close	Exit the internal menu of the device.	Combination of commands (iris close and focus near).
Back	Increase the value of the selected setting or display the next choice of the setting. During naming moves the cursor to the right of the current character in the name.	Zoom In.
Select	Select the current item in the internal menu.	Focus far.
Up	Move one step up in the internal menu.	Tilt up.
Down	Move one step down in the internal menu.	Tilt down.
Left	Move one step left in the internal menu.	Pan left.
Right	Move one step right in the internal menu.	Pan right.