CPARAPI Parameters¶

The CPARAPI allows to set many parameters of camera. The description of some parameters follows.

Zoom¶

ptz.zoom¶

Description: This parameter controls the current zoom of camera. 1=wide, 9999=tele.
Values: 1 to 9999.
Default: 1

ptz.zoomDigitalEnabled¶

Description: If it is enabled (yes) - camera can use the digital zooming capabilities. If disabled (no) - camera use only optical zoom.
Values: no/yes
Default: no

Focus¶

ptz.autofocus¶

Description: If enabled (yes) - camera trying to focus the target object automatically.
Values: no/yes
Default: yes

ptz.focus¶

Description: Manual focus distance (1=near)
Values: 1 to 9999
Default: 1
Note: This parameter works only when ptz.autofocus is set to no.

ptz.autofocusMode¶

Description: Selection of internal type of autofocus. The mode is internally implemented in camera block. See specification of Sony-FCB core for details.
Values: Normal/Interval-AF/Zoom Trigger Auto Focus Mode
Default: Normal

ptz.focusNearLimit¶

Description: This parameter limits the minimal distance of autofocus function. 1=approx 2cm, 9999=infinity.
Values: 1 to 9999
Default: 1
Note: This parameter works only when ptz.autofocus is set to no.

Iris¶

ptz.autoiris¶

Description: By setting of this parameter to yes the iris in lens is controlled automatically.
Values: no/yes
Default: yes

ptz.iris¶

Description: By setting of this parameter the iris in lens is set to new value.
Values: 1 to 9999
Default: 1
Note: To use this parameter the ptz.autoiris should be set to no.

Pan/Tilt/Zoom Relative moves¶

The camera does not contain any of pan/tilt motor units, but it can resend the CPARAPI requests to RS485 link with PELCO-D protocol. The zoom movements are not resend over PELCO, but they are applied directly on the camera optics.

ptz.continuouspanmove, ptz.continuoustiltmove, ptz.continuouszoommove¶

Description: Setting any of parameters to non zero value starts movement of pan/tilt/zoom to selected direction in given speed. Setting value to zero stops the movement immediately.
Values: -100 to 100
Default: 0

ptz.contPanSpeedScale, ptz.contTiltSpeedScale, ptz.contZoomSpeedScale¶

Description: This value changes the scaling of the speed ptz.continuouspanmove, ptz.continuoustiltmove, ptz.continuouszoommove to PELCO-D speed.
Values: 0 to 1000
Default: 10

ptz.contPanSpeedZoomDownScale, ptz.contTiltSpeedZoomDownScale¶

Description: This value controls the decreasing of relative speed dependency on current zoom. Increasing of this parameter the speed of relative movements decreases when ptz.zoom is increased. It is good when operator wants to pan/tilt more precisely on higher zoom levels.
Values: 0 to 100
Mapping: Number of PELCO-D steps decrease applied per 1000 zoom steps. E.g. when ptz.contPanSpeedZoomDownScale=10 and ptz.zoom=1000, then PELCO-D speed is decreased with 10 steps down to decrease relative speed of ptz.continuouspanmove.
Default: 0

Pan/Tilt/Zoom Presets¶

ptz.conf.setdevicepreset¶

Description: By setting this parameter the current position of PTZ will be stored into internal preset of PTZ unit as preset with id value.
Value: 1 to 20 (used like number of preset)

ptz.gotodevicepreset¶

Description: By setting of this parameter the current position or PTZ is moved to position last stored as preset with id value.
Value: 1 to 20 (used like number of preset)

Digital Outputs¶

Note: Controlling of digital outputs is planned to be implemented in future versions of firmware.

root.Output.O1.LogState, root.Output.O2.LogState, root.Output.O3.LogState, root.Output.O4.LogState¶

Description: State of digital output (O1-O4). If set to 1 - output voltage on EGPIO1 - EGPIO4 is set to 3.3V relative to GND. If set to 0 - output is set to 0V.
Values: 0/1
Default: no
Note: Maximum current is limited by serial 330Ohm resistor. It is possible to directly connect small current devices like LED diode between EGPIOx and GND. Max current 5mA. To connect devices with higher current needs or inductive device, some relay must be used (e.g. SSR) for driving.