Convision Systems GmbH

1

Manual

CGI Application Programming Interface

CONVISION CC-8xxx Cameras

(NVSCGI API)

Firmware v1.1.4 or above

Version: 1.7b

Issue: December 2012 Convision Systems

Convision Systems GmbH

2

 

Network Video Server CGI Application Programming Interface (NVSCGI API)    

Compatible with CONVISION CC‐8xxx Cameras For  Firmware  v1.1.4  build001  or  above 

 

Ver. 1.7b    

Document History  

 

Version  

Date  

Comment 

1.0 (beta)  2010/11/5  initial version. 

1.1  2010/11/10  Added RTSP Stream Video Section; removed HTTP examples applicable to CGI for EVxx5x series; added explanation of grey text (Future Functionality) 

1.2  2010/11/15  Modify values in 3.3.5 (sensor config) 

Added JSON example 

Updated 3.3.3 (get video config) and 3.3.4 (set video config) 

1.3  2011/02/10  Add Notification API, Notify_Stream.cgi 

Add User Account Management CGI interface 

Convision Systems GmbH

3

1.4  2011/04/27  Add 

action_mail.cgi 

event.cgi 

event_log.cgi 

httpport.cgi 

nas.cgi 

record_prepost.cgi 

remote_log.cgi 

sdcard.cgi 

sdcard_del.cgi 

sdcard_download.cgi 

sdcard_format.cgi 

sdcard_list.cgi 

system_log.cgi 

system_reboot.cgi 

user_del.cgi 

    web_reboot.cgi 

 

Modify 

Video.cgi 

1.4a  2011/06/09  Add 

video_info.cgi 

to add on a “hiddenmode” parameter to show the original Convision model name, even generic models. 

1.4b  2011/07/13  Add 

audiopost.cgi 

to change the audio port from client to camera. 

1.4c  2011/12/15  Add 

iris.cgi 

to control the device iris progressively. 

Modify 

sensor.cgi 

to correct the maximum value of sensor gain/exposure. 

1.5  2010/07/01  Add 

send_cmd.cgi and get_serial.cgi for rs485 transparent mode 

mjpg.cgi for having server push Motion JPEG stream. 

Convision Systems GmbH

4

1.6  2011/12/13  Modify 

iris.cgi for transparent and built in PTZ 

1.7  2012/05/02  Add 

ptz_home.cgi& ptz_autorun.cgi& ptz_patrol_info.cgi& ptz_privacy_mask.cgi& ptz_scan.cgi 

1.7b  2012/08/08  Add 

ptz_degree.cgi 

textoverlay.cgi.cgi 

audio_in.cgi 

camera_info.cgi 

daynight_ae.cgi 

event_log.cgi 

record_cont.cgi 

sensor_info.cgi 

tamper.cgi 

CyclicRec.cgi 

lightsensor.cgi 

dn_set.cgi 

ptz_autofocus.cgi 

sensor_night.cgi 

video_mask.cgi 

Modify 

Add audio.cgi with new “codec” parameter. 

Remove “audioout” parameter out of video.cgi. 

1.7c  2012/11/30  Add 

ZoomLimit.cgi   

ftp.cgi 

http_not.cgi 

tcp_not.cgi 

event_jpeg.cgi 

Modify 

ptz_scan.cgi 

ptz_degree.cgi 

Convision Systems GmbH

5

 

  Contents  

1  Overview ............................................................................................................................................... 8 1.1  Support Platform............................................................................................................................ 8 1.2  Future Functionality ....................................................................................................................... 8 1.3  API Versions.................................................................................................................................... 8 1.4  Valid Values .................................................................................................................................... 8 1.5  Read Me before Starting ................................................................................................................ 9 

2  HTTP Interface ..................................................................................................................................... 10 2.1  Request Messages ........................................................................................................................ 10 2.2  Response Messages...................................................................................................................... 11 2.3  Response Status Codes................................................................................................................. 11 2.4  Restart Web Server ...................................................................................................................... 11 

2.4.1  Set web server to be restarted ......................................................................................... 11 3  Configuration API ................................................................................................................................ 12 

3.1  Device Information....................................................................................................................... 12 3.1.1  get basic information........................................................................................................ 12 3.1.2  get camera info................................................................................................................. 12 3.1.3  get system date and time ................................................................................................. 12 3.1.4  set system date and time ................................................................................................. 13 

3.2  Users and Groups ......................................................................................................................... 13 3.2.1  get users ........................................................................................................................... 13 3.2.2  add or modify a user ........................................................................................................ 13 3.2.3  delete users ...................................................................................................................... 14 3.2.4  get groups......................................................................................................................... 14 3.2.5  query support privileges .................................................................................................. 14 

3.3  Video, Sensor, Audio .................................................................................................................... 14 3.3.1  get stream config .............................................................................................................. 15 3.3.2  set stream config .............................................................................................................. 15 3.3.3  get video config ................................................................................................................ 15 3.3.4  set video config................................................................................................................. 16 3.3.5  get audio‐in configuration ................................................................................................ 17 3.3.6  get valid resolution list ..................................................................................................... 18 3.3.7  get the available range of color setting (read only) ......................................................... 18 3.3.8  get sensors config ............................................................................................................. 18 3.3.9  set sensors config on day mode ....................................................................................... 19 3.3.10  set sensors config on night mode..................................................................................... 19 3.3.11  get sensors config on night mode .................................................................................... 20 3.3.12  get Day/Night (DN) mode................................................................................................. 20 3.3.13  get Day/Night (DN) mode................................................................................................. 20 3.3.14  get audio config ................................................................................................................ 20 3.3.15  set audio config ................................................................................................................ 20 3.3.16  get audio port from client to camera ............................................................................... 21 3.3.17  set audio port from client to camera ............................................................................... 21 3.3.18  IRIS control ....................................................................................................................... 21 3.3.19  configure the threshold of Day/Night switching (AE mode) ............................................ 21 

Convision Systems GmbH

6

3.3.20  text overlay ....................................................................................................................... 21 3.3.1  configure video mask settings .......................................................................................... 21 

3.4  Network........................................................................................................................................ 22 3.4.1  get network config............................................................................................................ 22 3.4.2  set network config ............................................................................................................ 23 3.4.3  get DDNS settings ............................................................................................................. 23 3.4.4  set DDNS ........................................................................................................................... 23 3.4.5  get HTTP port.................................................................................................................... 23 3.4.6  set HTTP port.................................................................................................................... 23 

3.5  Event Handling ............................................................................................................................. 24 3.5.1  get motion detection........................................................................................................ 24 3.5.2  set motion detection ........................................................................................................ 24 3.5.3  get digital input ................................................................................................................. 24 3.5.4  set digital input.................................................................................................................. 25 3.5.5  set tampering detection ................................................................................................... 25 3.5.6  set event rule.................................................................................................................... 26 

3.6  Event Server ................................................................................................................................. 26 3.6.1  get email Server ............................................................................................................... 26 3.6.2  set email server ................................................................................................................ 26 3.6.3  get NAS server .................................................................................................................. 27 3.6.4  set NAS server .................................................................................................................. 27 3.6.5  set FTP server ................................................................................................................... 27 3.6.6  set TCP Notification .......................................................................................................... 27 3.6.7  set HTTP Notification........................................................................................................ 28 

3.7  System Tools ................................................................................................................................. 28 3.7.1  get digital input/output .................................................................................................... 28 3.7.2  set digital output .............................................................................................................. 28 3.7.3  get LED.............................................................................................................................. 28 3.7.4  set LED .............................................................................................................................. 29 3.7.5  configure Light sensor settings......................................................................................... 29 3.7.6  reset all configurations to the factory default .................................................................. 30 3.7.7  get RS‐485 settings ........................................................................................................... 30 3.7.8  set RS‐485 settings ........................................................................................................... 30 3.7.9  get event log ..................................................................................................................... 30 3.7.10  get system log................................................................................................................... 30 3.7.11  get remote event log server ............................................................................................. 31 3.7.12  set remote event log server ............................................................................................. 31 3.7.13  reboot the camera ............................................................................................................ 31 

3.8  Local Storage ................................................................................................................................ 31 3.8.1  get SD card information.................................................................................................... 31 3.8.2  format SD card.................................................................................................................. 32 3.8.3  SD card space control ....................................................................................................... 32 3.8.4  list files in SD card............................................................................................................. 32 3.8.5  download file in SD card................................................................................................... 33 3.8.6  delete files in SD card ....................................................................................................... 34 

4  Streaming ............................................................................................................................................ 35 4.1  Audio & Video .............................................................................................................................. 35 

4.1.1  get a JPEG image .............................................................................................................. 35 

Convision Systems GmbH

7

4.1.2  get motion JPEG Video stream......................................................................................... 35 4.1.3  RTSP stream video ............................................................................................................ 35 

4.2  Record Setting .............................................................................................................................. 36 4.2.1  get pre/post record setting .............................................................................................. 36 4.2.2  set pre/post record setting............................................................................................... 36 4.2.3  configure Continuous Recording settings ........................................................................ 36 4.2.4  configure Cyclic Recording settings .................................................................................. 36 

5  Camera Control API ............................................................................................................................. 38 5.1  Motor Control .............................................................................................................................. 38 

5.1.1  add, delete or goto a PTZ preset ...................................................................................... 38 5.1.2  move PTZ continuously .................................................................................................... 38 5.1.3  focus continuously............................................................................................................ 38 5.1.4  iris continuously ............................................................................................................... 39 5.1.5  PTZ home Function............................................................................................................ 39 5.1.6  enable PTZ Autorun.......................................................................................................... 39 5.1.7  patrol................................................................................................................................. 40 5.1.8  PTZ privacy mask ............................................................................................................... 41 5.1.9  auto scan ........................................................................................................................... 42 5.1.10  set absolute PTZ position ................................................................................................. 44 5.1.11  get auto focus mode......................................................................................................... 44 5.1.12  Set Zoom Limitation ......................................................................................................... 44 

5.2  Via RS‐485 .................................................................................................................................... 45 5.2.1  send serial command ....................................................................................................... 45 5.2.2  get serial data ................................................................................................................... 45 

6  Notification API ................................................................................................................................... 45 6.1.1  get the notification stream............................................................................................... 45 

7  RTSP API............................................................................................................................................... 46 8  I/O Ports API ........................................................................................................................................ 46 9  Appendix ............................................................................................................................................. 47 

9.1  Time zone..................................................................................................................................... 47  

 

Convision Systems GmbH

8

   

1 Overview  

Network Video Server CGI Application Programming Interface (NVSCGI‐API) is an HTTP‐based API for network video server and IP camera products. Users can write program easily by calling this API to access all functionalities provided by our IP cameras including configuration and control facilities. 

 The API uses the same format in transporting HTTP‐based message. We will describe the command HTTP request format in the next chapter. 

 We also provide the RTSP interface for our IP cameras. 

  1.1 Support Platform 

This document is solely intended for the EVxx8x series CGI API. Please refer to the NVS CGI API version 1.5 document for the EVxx5x series.   

 This document is based on firmware version 1.0.7 build 005 or above. 

  1.2 Future Functionality 

Below in the interface description are parameters/functions in gray text. This represents parameters/functions that are currently not available, but will be available in the future. While these parameters need not be included in CGI requests, they will be present in CGI responses; these values can be ignored.   

  1.3 API Versions 

Though we provide a common API for all IP camera models, it may not apply to some older models which were produced before the first version of this API was published. We may also publish the further versions of this API in the future. So there may be some difference between different versions of the API. However, all our products shall provide the API version information with every firmware version for each model. 

  1.4 Valid Values 

 The following valid values are used in this document: 

 Values  Description 

An integer  Any number between ‐2147483647 (‐231‐1) and 2147483647 (231‐1). 

m ... n (m~n)  Any number between number m and number n. #  A number equal to or greater than 0 A string  Any string encoded by UTF‐8 An IP address  A string limited to contain an IP address of the format 

xxx.xxx.xxx.xxx, where xxx is a number between 0 to 255. Example: 192.168.0.90 

A MAC Address  A string limited to contain a MAC address of the format xx:xx:xx:xx:xx:xx, where xx is a hexadecimal value. Example: 00:40:8c:cd:00:00 

A time  A string limited to contain a time of the format hh:mm:ss. Example: 23:01:14 

A date  A string limited to contain a date of the format yyyy‐mm‐dd. Example: 2004‐02‐16 

, , , ...  Enumeration, only the given values are valid. 

Convision Systems GmbH

9

  Every italic strings inside brackets including the brackets should be replaced by proper values. 

※ Every parameters and its value should follow the case sensitive accuracy described in the API document.  1.5 Read Me before Starting 

 The CONVISION CC‐8xxx series is a megapixel series.  The CONVISION CC‐8xxx cameras and the CONVISION CC‐801x encoders should use different CGIs but they’re 80% alike to each other. Once if you integrated the four models CC‐8171 / CC‐815 / CC‐8131 / CC‐8111, you can leverage the hard work to other of Convision´s megapixel models. 

The product kernel is the same but only differs into different exteriors and the maximum resolution it can control (detailed control information, please refer to video.cgi ). Take the CC‐8333 for example. Once if you finish the integration to CC‐8131, you may take the driver mapping to the CC‐8333 (the camera with the same resolution, except the PTZ models).    So a best way for a total listing of Convision megapixel models is provide an quick driver link as following (except those PTZ models). 

‐ CC‐8171 (5 megapixel) ‐ CC‐8151 (3 megapixel) ‐ CC‐8131 (2 megapixel) ‐ CC‐8111 (1.3 megapixel) 

Convision Systems GmbH

10

  2 HTTP Interface  

An HTTP‐based protocol always includes two kinds of message, request and response. An IP camera has a service to wait and accept a TCP connection request with a specified port and to process the request message from a user defined application. In this chapter, we will describe the common format comprising all the different request and response messages. You may also refer to the RFC 1945 HTTP/1.0. 

  2.1 Request Messages 

 To query information for an IP camera, use the syntax 

 GET /?= HTTP/1.0 Authorization: Basic  

  

where,  

 is a URL of a CGI. For example, get basic information is “/config/info.cgi”.  

Authorization is optional for some CGIs.  

 is the base64 encoding of userid:password.  

 is Carriage Return and Line Feed    (\r\n).   

To set values in the IP camera, you may use HTTP GET method, the syntax is  

GET /  

?=[&=...] HTTP/1.0 Authorization: Basic 

 

   

or HTTP method POST, the syntax is  

POST / HTTP/1.0 Authorization: Basic  

Content‐Type: application/x‐www‐form‐urlencoded  

Content‐Length:   

  

=[&=]   

where,  

 is the length of the entity body.  

 will be described in the following chapters. Valid characters only include letters ([A‐Za‐z]), digits ([0‐9]) and underline (_). There is no such restriction for . The content part of the post message should be encoded with “url‐ encoding” function. 

Convision Systems GmbH

11

  

2.2 Response Messages  

  After the  call, it will be processed and the default output will be transmitted as response message in JSON (JavaScript Object Notation) format: 

 HTTP/1.0   

Content‐Type: text  

Content‐Length:  

 

 

...  Below is an example of the JSON format:  {"profile_id_1":[{"resolution":"1920x1080", "bitrate":"8000", "codec":"H264", "framerate":"25", "gopsize":"30", "quality":"good", "mode":"full", "roistartx":"1", "roistarty":"0", "audioout":"on", "record":"Disable", "rate_control":"CBR"}], "profile_id_2":[{"resolution":"640x480", "bitrate":"1000", "codec":"H264", "framerate":"15", "gopsize":"30", "quality":"good", "mode":"resize", "roistartx":"1", "roistarty":"0", "audioout":"off", "record":"Disable", "rate_control":"CBR"}]}   

2.3 Response Status Codes  

The API status codes are defined here.  Table 1: HTTP status codes 

 

HTTP code  HTTP text  Description 200  OK  The request has succeeded, but an application error may occur, 

please refer to each CGI response. 400  Bad Request  You used invalid or unsupported parameters or values for this IP 

camera. 401  Unauthorized  The request requires user authentication or the authorization 

was refused. 404  Not Found  This API is not supported for this IP camera. 500  Internal Error  The IP camera encountered an internal error or the API can not get 

the correct status. 503  Service Unavailable  The IP camera is unable to handle the request due to 

temporary overload. 

2.4 Restart Web Server  2.4.1 Set web server to be restarted 

 

request: GET /config/web_restart.cgi 

 ※ The web server will temporarily stopped for about 5 seconds. 

Convision Systems GmbH

12

   3 Configuration API  

The CGIs under /config can only be accessed by users who have 'config' privilege.   

3.1 Device Information   3.1.1 get basic information 

 

request: GET /config/info.cgi No authentication required. response: 

Name  Value  Description model  A string  model name product  A string  product name of camera brand  A string  brand name version  A string  version number build  A string  firmware build number sn    product serial no nipca  A string  version number of NIPCA supported name  A string  camera name location  A string  camera location macaddr  A MAC address  the MAC address ipaddr  An IP address  IP address netmask  An IP address  Subnet mask gateway  An IP address  Default router/gateway used for connecting devices attached to 

different networks and networks segment. wireless  yes  Only displayed if has wireless ptz  P, T, Z  Only show supported Pan or Tilt or Zoom. 

For example, ptz=P,T inputs  #  The number of inputs outputs  #  The number of outputs speaker  yes, no  Only displayed if the IP camera has speaker. videoout  yes, no  Only displayed if the IP camera has video out connector dns    DNS server address dns1    alternative DNS server address hiddenmod  A string  Display the model name mapped from. 

 3.1.2 get camera info 

request: GET /config/datetime.cgi 

 response: 

Name  Value  Description Name  A string  Camera name. 

 3.1.3 get system date and time 

 

request: GET /config/datetime.cgi 

 response: 

Name  Value  Description 

Convision Systems GmbH

13

method  0, 1  0: disable ntpd (manual sync) 1: enable ntpd 

timeserver  A host or IP address  NTP time server host name or IP address. timezone  #  time zone ID, see Time zone date  A date  yyyy‐mm‐dd time  A time  hh:mm:ss dstenable  no, yes  disable or enable the DST (Daylight Saving Time) dstauto  no, yes  set DST automatically offset  A time  The amount of time the clock should be turned back/forward (hh:mm), 

due to DST. 

starttime    The time when DST should be enabled in the format m.w.d/hh:mm:ss day d(0…6) of week w(1…5) of month m(1…12). 

stoptime    Stop time when DST should be disabled in the same format as above 

 3.1.4 set system date and time 

 

request: GET /config/datetime.cgi 

 parameters: 

  response: 

see above table  

3.2 Users and Groups  

3.2.1 get users  Request   GET /config/user_list.cgi      Parameters:      None or name=   Response:    If no request parameter 

 Name  Value  Description 

users  #  The total number of users  … 

  For example, admin=admin It will display all user names line by line. 

   If request parameters is name  

Name  Value  Description password  A string  Base 64 encoded password group  A string  Group name privilege  A string  (optional) the permission of this user ※ Each User Access Management modification should also execute web_restart.cgi to refresh the record. 

 3.2.2 add or modify a user 

 Request 

Convision Systems GmbH

14

  GET /config/user_mod.cgi      Parameters: 

 Name  Value  Description 

name  A string  User name password  A string  Base 64 encoded password group  A string  Group name privilege  A string  (optional) the permission of this user ※ Each User Access Management modification should also execute web_restart.cgi to refresh the record. 

 3.2.3 delete users 

 Request   GET /config/user_del.cgi    Parameters:   Name=,,…   You can delete more than one user account via one command  Response:     Name=,,….  ※ Each User Access Management modification should also execute web_restart.cgi to refresh the record. 

 3.2.4 get groups 

 Request   GET /config/group_list.cgi    Parameters: 

None or name=  Response:     If no request parameters,  

Name  Value  Description groups  An integer  The total number of groups   ,…  For example, admin=admin,root 

 Response:     If request parameters, 

Name  Value  Description groups  An integer  The total number of groups privilege  Ptz, outputs, video, config The permission list for this group 

 3.2.5 query support privileges 

 Request   GET /config/privilege_info.cgi  Response: 

Name  Value  Description privilege  Ptz, outputs, video, config Available privileges. 

 3.3 Video, Sensor, Audio 

 

Convision Systems GmbH

15

 3.3.1 get stream config 

  

Request: GET /config/stream.cgi 

 response: 

Name  Value  Description auth  Enable,Disable  Stream auth stream_name  string  Stream url name rtsp_port  Integer  The port of rtsp rtp_video_port  Integer  The video port of rtp rtp_audio_port  Integer  The audio port of rtp multicast  On,off  Stream Support multicast multicast_ip  String (ipv4 format)  Multicast ip address multicast_port  Integer  Multicast port multicast_ttl  Integer (1‐255)  Multicast ttl number max_client  Integer (0‐20)  Max connect client number 

 3.3.2 set stream config 

request: GET /config/stream.cgi 

 parameters:    see above table 

  response: 

see above table  3.3.3 get video config 

 

request: GET /config/video.cgi 

 parameters: 

 profile_id=; if no profile_id is specified, then all available profiles will be provided 

 response: 

Name  Value  Description 

sensor_mode  "5mp" ‐   5MP mode "3mp" ‐   3MP mode "1080p" ‐ 1080p mode "1mp" ‐   1.3MP mode (A models) "720pb" ‐ Minilux 720p mode 

Max resolution 

profile_id_  1..4  The profile id 

resolution  e.q. 1920x1080/ 640x480/ 320x240 

Resolution list for different sensor mode. 

bitrate  An integer (1000‐12000)  in kbit/s codec  MPEG4,MJPEG,H264  a video codec framerate  1 ... 30  a frame rate in fps gopsize  e.q. 

30/60/90/120   the MPEG GOP size which means  times of framerate. (1‐4 fps) 

quality  excellent/good/normal/poor/bad  only used when the codec is MJPEG roistartx  200/(0‐1280)  Video cropper start x 

roistarty  100/(0‐500)  Video cropper start y 

Convision Systems GmbH

16

record  on,off  Event recording control   

ratecontrol  CBR/VBR  Rate control 

tvout  off, sdtv, hdtv  If enable the TV out (SDTV/HDTV) 

osd  on,off  to control the text overlay to display or not. 

contrec  on,off  continuous recording control   

 3.3.4 set video config 

 

request: GET /config/video.cgi 

 In the table below, substitute  with the specific profile ID to modify; a group of parameters must all use the specify the same profile ID.  = must be 1/2/4/8 

 parameters: 

 

Name  Value  Description sensor_mode  "5mp" ‐   5MP mode 

"3mp" ‐   3MP mode "1080p" ‐ 1080p mode "1mp" ‐   1.3MP mode (A models) "720pb" ‐ Minilux 720p mode 

Max resolution 

resolution_p  1920x1080/ 640x480/ 320x240  width of resolution   bitrate_p  An integer (1000‐12000)  in kbit/s codec_p  MPEG4,MJPEG,H264  a video codec framerate_p  1 ... 30  a frame rate in fps gopsize_p  30/60/90/120    the MPEG GOP szie which means  times of framerate. (1‐4 fps) quality_p  excellent/good/normal/poor/bad  only used when the codec is MJPEG roistartx_p  200/(0‐1280)  Video cropper start x 

roistarty_p  100/(0‐500)  Video cropper start y 

audioout_p  on, off  Video audio out 

record_p  enable, disable  set not available yet 

ratecontrol _p  CBR/VBR  set not available yet 

tvout_p  off, sdtv, hdtv  Set TV out specification  

 Note: The number of the profile being set must be one, two or four. WARNING: profile_id 1must be set to H.264, 1920x1080; do not modify profile_1 codec, resolution and mode; changes may result in loss of video 

 response: 

see the above table.  

Example 1 (1 profile) : http://IP_address/config/video.cgi?   sensor_mode=5mp& framerate_p1=10&ratecontrol_p1=CBR&bitrate_p1=8000&resolution_p1=2592x1920&codec_p1=H264&mode_p1=full&record_p1=off&audioout_p1=on&tvout_p1=off&  Example 2 (2 profiles): http://IP_address /config/video.cgi?   sensor_mode=1080p& framerate_p1=20&ratecontrol_p1=CBR&bitrate_p1=4000&resolution_p1=1920x1080&codec_p1=H264&record_p1=off&audioout_p1=on&tvout_p1=off& framerate_p2=15&ratecontrol_p2=CBR&bitrate_p2=2000&resolution_p2=640x480&codec_p2=MPEG4&record_p2=off&audioout_p2=off&tvout_p2=off&  The tables below shows certain profile resolution/frame rate settings that may have limitations based on profile ID. 

Convision Systems GmbH

17

 sensor mode  Max resolution & frame rate 

1 profile & 1st profile resolution list(@10fps) 

2 profiles & 2nd profile/ resolution list(@10fps)  4 profiles' resolution(@10fps) 

2592x1920  736x480(60Hz) / 736x576(50Hz)  640x480 only 1024x768  640x480   800x600  320x240   

5MP 

  160x120   1 profile & 1st profile resolution list(@20fps) 

2 profiles & 2nd profile/ resolution list(@20fps)  4 profiles' resolution(@20fps) 

2048x1536  736x480(60Hz) / 736x576(50Hz)  640x480 only 1024x768  640x480   800x600  320x240   

3MP 

  160x120   1st profile resolution list (30fps or 15 fps) 

2 profiles & 2nd profile/ resolution list(@15fps)  4 profiles' resolution(@20fps) 

one profile  two profiles  736x480(60Hz) / 736x576(50Hz)  640x480 only 1920x1080 @ 30fps 

1920x1080 @ 15fps  640x480   

1280x720 @ 30fps 1280x720 @ 15fps  320x240   

1080p 

    160x120   1 profile & 1st profile resolution list(@30fps) 

2 profiles & 2nd profile/ resolution list(@30fps)  4 profiles' resolution(@20fps) 

1280x1024  736x480(60Hz) / 736x576(50Hz)  640x480 only 1024x768  640x480   800x600  320x240   

1mp   (A 

model) 

  160x120   1 profile & 1st profile resolution list(@30fps) 

2 profiles & 2nd profile/ resolution list(@30fps)  4 profiles' resolution(@20fps) 

1280x720  736x480(60Hz) / 736x576(50Hz)  640x480 only    640x480      320x240   

720p 

  160x120    ※ If enable the TV out(SDTV or HDTV), the video profile setting should be configured as 1080p with 2 profiles setting ONLY. This is the 

system resource limitation.    Here is the available sensor mode list in different CONVISION products:  ‐ CC‐8171          : 5mp, 3mp, 1080p, 1mp, 720p ‐ CC‐8151 / 8262 / 8353 / 8453 / 8552    : 3mp, 1080p, 1mp ‐ CC‐8131 / 8233 / 8732 / 8333 / 8433  : 1080p, 1mp (except EV8280U‐MD. It only supports 1080p sensor mode) ‐ CC‐8111 / 8213 / 8313 / 8413 / 8512 / 8722 : 1mp 

 

3.3.5 get audio‐in configuration request: 

GET /config/audio_in.cgi  parameters:  

Name  Value  Description in  mic, line_in  mic: Microphone input 

line_in: Line input  

Convision Systems GmbH

18

 3.3.6 get valid resolution list 

 With different sensor modes, we provide various resolutions for users to choose from. Users may query video_info.cgi to know which available resolution can be set for profile 1 and profile 2.  request: 

GET /config/video_info.cgi  parameters:  

Name  Value  Description sensor_mode  "5mp" ‐   5MP mode 

"3mp" ‐   3MP mode "1080p" ‐ 1080p mode "1mp" ‐   1.3MP mode (A models) "720pb" ‐ Minilux 720p mode 

Sensor mode has been set. 

profile_id_1  A string  Valid resolution list for profile 1 profile_id_2  A string  Valid resolution list for profile 2 

 ※ Once if the 4 profile (Video/Audio>Video Setting>Profile Mode) is enabled, the only valid resolution for all 4 profiles will be VGA 

(640x480) only. 

3.3.7 get the available range of color setting (read only) request: 

GET /config/sensor_info.cgi   response: (only supported parameters are displayed.) 

Name  Value  Description brightness  range  The available range of brightness value contrast  range  The available range of contrast value saturation  range  The available range of saturation value sharpness  range  The available range of sharpness value noisefilter  range  The available range of noisefilter value 

 3.3.8 get sensors config 

 

request: GET /config/sensor.cgi 

 response: (only supported parameters are displayed.) 

Name  Value  Description brightness  An integer  the brightness (0…255) contrast  An integer  the contrast (0...255) saturation  An integer  the saturation (0...255) sharpness  An integer  the sharpness (0...255) max_exposure  An integer  the max exposure value (0...4) man_exposure  An integer  the manual exposure value (0...12) max_gain  An integer  the max gain value (0…6) man_gain  An integer  the manual gain value (0…6) autoexposurelimit  yes,no  To limit the auto exposure range or not 

limit_upper  An integer  Once the autoexposurelimit is set to yes, limit_upper shoud be set between 0~+2EV (0…4) 

limit_lower  An integer  Once the autoexposurelimit is set to yes, limit_lower shoud be set between 0~ ‐2EV (0…4) blc  An integer  the backlight compensation value (0…8) defilicker  An integer  deflicker frequency value (50 or 60) whitebalance  auto,disabled  enable or disable the auto white balance 

Convision Systems GmbH

19

autoexposure  yes,no  enable or disable the auto exposure autogaincontrol  yes,no  enable or disable the auto gain control function nf_mode  auto,manual  noise reduction: auto or manual nf_level  An integer  noise reduction level at manual mode (0…255) dn_fps  An integer  the night mode fps type (0…3) mirror  on,off  enable ,disable image mirror horizontally flip  on,off  enable ,disable image flip vertically ext_wdr  disable, 

low,    medium,   high 

disable WDR mode, set low strength WDR mode, (not all models supported) set medium strength WDR mode, set high strength WDR mode, 

env_pos  indoor, outdoor  Location: indoor or outdoor autoiris  yes,no  enable or disable the auto iris 

Only for EV8280U. man_iris  yes,no  set iris position at manual mode (0…13) 

Only for EV8280U.  3.3.9 set sensors config on day mode 

 

request: GET /config/sensor.cgi 

 

response: see the above table. 

3.3.10 set sensors config on night mode request: 

GET /config/sensor_night.cgi  response: (only supported parameters are displayed.) 

Name  Value  Description brightness  An integer  the brightness (0…255) contrast  An integer  the contrast (0...255) saturation  An integer  the saturation (0...255) sharpness  An integer  the sharpness (0...255) max_exposure  An integer  the max exposure value (0...4) man_exposure  An integer  the manual exposure value (0...12) max_gain  An integer  the max gain value (0…6) man_gain  An integer  the manual gain value (0…6) autoexposurelimit  yes,no  To limit the auto exposure range or not 

limit_upper  An integer  Once the autoexposurelimit is set to yes, limit_upper shoud be set between 0~+2EV (0…4) 

limit_lower  An integer  Once the autoexposurelimit is set to yes, limit_lower shoud be set between 0~ ‐2EV (0…4) blc  An integer  the backlight compensation value (0…8) whitebalance  auto,disabled  enable or disable the auto white balance autoexposure  yes,no  enable or disable the auto exposure autogaincontrol  yes,no  enable or disable the auto gain control function nf_mode  auto,manual  noise reduction: auto or manual nf_level  An integer  noise reduction level at manual mode (0…255) dn_fps  An integer  the night mode fps type (0…3) mirror  on,off  enable ,disable image mirror horizontally flip  on,off  enable ,disable image flip vertically ext_wdr  disable, 

low,    

disable WDR mode, set low strength WDR mode,   (not all models supported) 

Convision Systems GmbH

20

medium,   high 

set medium strength WDR mode, set high strength WDR mode, 

env_pos  indoor, outdoor  Location: indoor or outdoor autoiris  yes,no  enable or disable the auto iris 

Only for EV8280U. man_iris  yes,no  set iris position at manual mode (0…13) 

Only for EV8280U.  3.3.11 get sensors config on night mode 

request: GET /config/sensor_night.cgi 

 

response: see the above table. 

 

3.3.12 get Day/Night (DN) mode request: 

GET /config/dn_set.cgi  response: 

Name  Value  Description dn_mode  auto,   

day, night, di, extls, ae 

auto DN mode by light sensor, forced to day mode, forced to night mode, auto DN mode by digital input (DI), auto DN mode by external light sensor, auto DN mode by AE metering 

dn_bw  on,off  enable ,disable night B/W mode dn_status  day,night  day or night status deflicker  An integer  deflicker frequency value. (50 or 60) 

3.3.13 get Day/Night (DN) mode 

request: GET /config/dn_set.cgi 

 response: 

See the above table. The dn_status and deflicker are not supported. 

 3.3.14 get audio config 

 

request: GET /config/audio.cgi 

 response: 

Name  Value  Description codec  none,aac,ulaw,alaw,adpcm  the audio codec;   

“none” will mute the device. channel  1 (fixed)  Number of audio channel (1, fixed) 

bitrate  An integer  The output bitrate. (in kbit/s) samplerate  8000 (fixed)  Sampling rate (8000, fixed) 

vol_in  An integer  Volume of line‐in (range 1‐10) 

vol_out  An integer  Volume of line‐out (range 1‐10)  

3.3.15 set audio config request: 

see the above table 

Convision Systems GmbH

21

  response: 

see the above table 

 3.3.16 get audio port from client to camera 

request: GET /config/audiopost.cgi 

  response: 

Name  Value  Description port  An integer ( 1000~ 65530)  Audio port from client to camera 

 3.3.17 set audio port from client to camera 

request: GET /config/audiopost.cgi 

 response: 

see the above table  3.3.18 IRIS control 

request: GET /config/iris.cgi 

 response: 

Name  Value  Description i  ‐6…6  i represents the iris control speed. The bigger abs. value, the faster it 

responds. 0: to stop the progressive iris control. >0: to progressively set iris open 

Convision Systems GmbH

22

 response: 

Name  Value  Description enable__1  no,yes  Enable Mask Window 1 

enable__2  no,yes  Enable Mask Window 2 

enable__3  no,yes  Enable Mask Window 3 

enable__4  no,yes  Enable Mask Window 4 

enable__5  no,yes  Enable Mask Window 5 

color__1  0~8 

color__2  0~8 

color__3  0~8 

color__4  0~8 

color__5  0~8 

Mask Window Color Options 0: White 1: Red 2: Orange 3: Yellow 4: Green 5: Blue 6: Indigo 7: Purple 8: Black 

area__1  [X],[y],[w],[h] 

area__2  [X],[y],[w],[h] 

area__3  [X],[y],[w],[h] 

area__4  [X],[y],[w],[h] 

area__5  [X],[y],[w],[h] 

Mask Window Area Value x: x‐axis value, 0~320 y: y‐axis, 0~180 w: width, 0~80 h: height , 0~45 

 3.4 Network 

  3.4.1 get network config 

 

request: GET /config/network.cgi 

  response: 

Name  Value  Description dhcp  off, on  disable/Enable dynamic IP address assignment ip  An IP address  IP address netmask  An IP address  subnet mask gateway  An IP address  default gateway dns1  An IP address  primary DNS server dns2  An IP address  secondary DNS server pppoe  off, on  use PPPoE pppoeuser  A string  PPPoE user name pppoepass  A string  PPPoE password ddns  off, on  disable/enable dynamic ddns service ddnsprovider  ID of the provider ddnshost  A string  ddns host name ddnsuser  A string  ddns user name ddnspass  A string  ddns password upnp  off, on  disable/enable UPnP httpport  1 ... 65535  TCP port number for HTTP httpexternalport  1 ... 65535  The external port number for upnp NAT router to map the HTTP service 

port of camera rtspport  1 … 65535  The port number of RTSP service 

Convision Systems GmbH

23

rtspexternalport  1 … 65535  The external port number for upnp NAT router to map the RTSP service port of camera 

  3.4.2 set network config 

 

request:  

GET /config/network.cgi  

parameters:  

see the above table.   response: 

see the above table.   3.4.3 get DDNS settings 

 

request: GET /config/ddns.cgi 

  response: 

Name  Value  Description ddns  off, on  disable/enable dynamic DNS service provider  ID of the provider host  DDNS host name user  DDNS user name pass  DDNS password 

 3.4.4 set DDNS 

 

request: GET /config/ddns.cgi 

 parameters: 

see the above table. 

response: see the above table. 

  3.4.5 get HTTP port 

 

request: GET /config/httpport.cgi 

 response: 

Name  Value  Description httpport  An integer  Port number of HTTP protocol 

 3.4.6 set HTTP port 

 request: 

GET /config/httpport.cgi  parameters: 

see the above table. 

Convision Systems GmbH

24

response: see the above table. 

 ※ After setting the http port with a new value, system should restart its web server via /config/web_restart.cgi 

command to have this configuration taken effect. 

3.5 Event Handling   3.5.1 get motion detection 

  request: 

GET /config/motion.cgi    = window id max number 3  response:         window type: 

Name  Value  Description 

totalnum  #    total motion detection window numbers. read‐only. 

sensitivity__  0 ... 100  sensitivity 

specificity__     

enable__  no, yes  disable/enable motion detection window # 

mdw__  A string  motion detection window # in the format x,y,w,h x,y is the coordinate. the 0,0 means the left top position. w,h is the width and height of the window. 

   3.5.2 set motion detection 

 

request: GET /config/motion.cgi 

parameters: 

see the above table.   response: 

see the above table.   

3.5.3 get digital input  request: 

GET /config/event_input.cgi   response: 

Name  Value  Description input  #  Digital input 1, 2 (Required ) 

Convision Systems GmbH

25

type  NO NC

Normal Open Normal Close 

  3.5.4 set digital input 

 

request: GET /config/event_input.cgi 

parameters: see the above table. 

  response: 

see the above table.  

 

3.5.5 set tampering detection  request: 

GET /config/tamper.cgi  response: 

Name  Value  Description enable  yes, no  yes: tampering detection enabled. 

no: tamper detection disabled.  

※ Please contact sales person . 

Convision Systems GmbH

26

3.5.6 set event rule  request: 

GET /config/event.cgi   response: 

Name  Value  Description name  A string  Rule name 

event_type  MOTION, DI, NLOSS, TIME   

action_type  RECORD, EMAIL, DO   

schedule  0  0 : disable scheduling 

interval  An Integer  Period time 

group_id  An integer  0 for default. 

event_arg  A string  Arguments about event. Trigger: 3 digits, motion area enabled, e.q., 001, enable Area 3 110, enable Area 1 & 2 

action_arg  A string  Arguments about action. TIME: An integer, action duration 

 

3.6 Event Server   3.6.1 get email Server 

 request: 

GET /config/action_mail.cgi   response: (only supported inputs and outputs are displayed)  

Name  Value  Description sender_user1    Sender Email address to_user1    Recipient email address host_user1    Email server address port_user1    Email server port user_user1    User name pass_user1    User password auth_user1     enable_user1  yes,no   timeout_user1  An Integer  Connection Timeout(sec) ssl_user1  yes,no  Require SSL connection time     enable  yes,no  Enable primary email server 

 3.6.2 set email server 

 request: 

GET /config/action_mail.cgi  parameters: 

see the above table. 

Convision Systems GmbH

27

 response: 

see the above table.  

3.6.3 get NAS server  request: 

GET /config/nas.cgi   response:    

Name  Value  Description nas  yes,no  Enable NAS server   protocol  NAS, SMB  Type of NAS server addr  A string  Server Address folder  A string  Folder path user  A string  User account pass  A string  User password 

 3.6.4 set NAS server 

 request: 

GET /config/nas.cgi  parameters: 

see the above table.  response: 

see the above table.  3.6.5 set FTP server 

 request: 

GET /config/ftp.cgi  parameters: 

Name  Value  Description Ip  A string  ftp server ip address port  A string ftp server communication port user  A string ftp server user account pass  A string ftp server user password remote_dir  A string Folder for uploading files onto ftp server file_prefix  A string Prefix name for uploading files pasvmode  yes,no  Enable passive mode. 

 response: 

see the above table.  3.6.6 set TCP Notification   

 request: 

GET /config/tcp_not.cgi  parameters: 

Name  Value  Description ip  A string  tcp server ip address port  A string tcp server communication port 

 

Convision Systems GmbH

28

response: see the above table. 

3.6.7 set HTTP Notification  request: 

GET /config/http_not.cgi  parameters: 

Name  Value  Description url  A string  http URL for receiving notification user  A string http basic authentication user account Pass  A string http basic authentication user password 

 response: 

see the above table.  3.7 System Tools 

  3.7.1 get digital input/output 

 

request: GET /config/io.cgi 

  response: (only supported inputs and outputs are displayed)  

Name  Value  Description in1  off, on  Digital input set 1 in2  off, on  Digital input set 2 out1  off, on  Digital output set 1 

  3.7.2 set digital output 

You can only set the available digital outputs, inputs are read‐only. 

 request: 

GET /config/io.cgi  parameters: 

 

out1  off, on  Digital output set 1  response: 

see the above table.   3.7.3 get LED   

 

request: GET /config/led.cgi 

 response: 

Name  Value  Description pwrled  on, off  enable or disable the special purpose LED. 

netled  on, off   

ir  on, off   

 # Only get the configuration of LEDs, not the flashing status. 

Convision Systems GmbH

29

 3.7.4 set LED 

 

request: GET /config/led.cgi 

parameters: 

see the above table.  response: 

see the above table.  

3.7.5 configure Light sensor settings  request: 

GET /config/lightsensor.cgi  response: 

Name  Value  Description switch  INT , EXT  INT = select internal‐ light sensor function. 

EXT l l li h f itype  NL , NH  NL = When voltage low level state switch to   Ni h d

Convision Systems GmbH

30

  3.7.6 reset all configurations to the factory default 

 

request: GET /config/system_reset.cgi 

 parameters: 

Name  Value  Description reset  go  Reset the system 

keep_net  yes,no  Keep the network setting 

keep_user  yes,no  Keep the user account  3.7.7 get RS‐485 settings 

 

request: GET /config/rs485.cgi 

  response: 

Name  Value  description proto  PelcoD, PelcoP, none, Transparent  protocol type 

devid  An integer  device ID of the RS‐485 slave device.   PelcoD: 1 ... 255 PelcoP: 1 ... 255 

baudrate  1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 

customized baud rate 

databits  7, 8  customized data bits parity  None, Even, Odd  customized parity stopbits  1, 2  customized stop bits comm  RS484,RS422  customized communication mode 

 3.7.8 set RS‐485 settings 

 

request: GET /config/rs485.cgi 

see the above table. 

response: see the above table. 

 

3.7.9 get event log  request: 

GET /config/event_log.cgi  response:  

Name  Value  description event_log  Log data  Event logging data. 

  

3.7.10 get system log  

Convision Systems GmbH

31

request: GET /config/system_log.cgi 

 response: 

System logs.  

3.7.11 get remote event log server If with log server, e.q. KIWI log server, to log information from devices for report output or statistics use, here you may enable the remote log server feature to send those log information to the defined log servers.  request: 

GET /config/remote_log.cgi  response: 

Name  Value  description event_enable  0, 1  0: disable; 1: enable remote event log server 

event_ip  IP Address  Event log server IP address 

sys_enable  0, 1  0: disable; 1: enable remote event log server 

sys_ip  IP Address  Sys log server IP address 

 

3.7.12 set remote event log server request: 

GET /config/remote_log.cgi  response: 

see the above table.  

3.7.13 reboot the camera  

request: GET /config/system_reboot.cgi 

 

response:         OK, for successfully rebooted.  

3.8 Local Storage  3.8.1 get SD card information 

 

request: GET /config/sdcard.cgi 

 response: 

Name  Value  description status  ready, write_protected, invalid, 

path_invalid Status of SD card 

total  An integer  Total space of SD card (bytes) 

used  An integer  Used space of SD card (bytes) 

free  An integer  Free space of SD card (bytes) 

picture  An integer  Amount of subfolders which stored pictures   

Convision Systems GmbH

32

video  An integer  Amount of subfolders which stored videos 

  3.8.2 format SD card 

 

request: GET /config/ sdcard_format.cgi 

 parameters: 

Name  Value  description format  go  Do format or query SD status. 

Note: If field 'format' isn't given or SD card is being formatted, the device will report the status of formatting If field 'format' isn't given or SD card is being formatted, the ip camera reports the status of formatting 

 response: 

Name  Value  description status  none, 

formatting, ready, unformatted 

Stats of SD card 

 3.8.3 SD card space control 

 

request: GET /config/sdcard_reserve.cgi 

 parameters: 

Name  Value  description enable  An integer  0: not recycling the space in used. 

1: will recycling the space in used 

day  An integer(N)  Valid value(N) is among 0~120  0:    Not reserve any recorded files; recycling(delete files) the SD space if needed. N:    Keep the recorded files within N days. This setting will cause therecording behavior to be stopped if the action is request to reserve the files in N days and no other space is available. 

 response: 

see the above table.  3.8.4 list files in SD card 

 

request: GET /config/sdcard_list.cgi 

 parameters: 

Name  Value  description path  A string  List details under specified folder path   

page  An integer  This command would list files of a page. You can indicate which list of page you would like to see. 

pagesize  An integer  Amount of files listed in one page  response: 

Convision Systems GmbH

33

Name  Value  description status  Available, unavailable  Status of SD Card, if SD Card is not available, the value would be 

'unavailable’, or it would show 'available'' unavailable’, or it would show 'available' 

path  A string  Path specified page  An integer  This command would list files of a page. You can indicate which list 

of page you would like to see.  For example: If got 40 files in the 'date' folder and would like to list the files in page 1 where it is assumed the number of files in each page is 20. The request url may be: GET /config/sdcard_list.cgi?type=picture&path=\20080704\00&page=1&pagesize=20  Where: type=picture: list the files in jpg format path=\20080229\10: (see below) page=1: list the files in page 1 pagesize=1: indicate that there are 20 files in each page And the server would response the fist 20 files which snapshoot at 2008/2/29 

pagesize  An integer  How many files in a page. See more details in previous parameter total_num    Total number of these files total_page    Total page of these files num    Number of files in indicated page list    Attributes of this file, format is ,, where: timestamp: yyyy‐mm‐dd HH:MM:SS recording type: d (digital input) or m (motion) size: size of file 

 3.8.5 download file in SD card 

 

request: GET /config/sdcard_download.cgi 

 parameters: 

Name  Value  description path  A string  Path of file 

file  A string  The file name could be got in command /config/sdcard_list.cgi 

 response:  HTTP /1.0 200 OK Content‐Type: application/octet‐stream Content‐Length:     Response when file is not available: 

Name  Value  description Num  An integer  Number of files which in deleting list 

Path  A string  Path of file 

Convision Systems GmbH

34

File_  Integer  The status of deleting action of indicated file,  0: File is successfully deleted 1: File does not exist. 2: File is not deleted   

  

3.8.6 delete files in SD card  

request: GET /config/sdcard_del.cgi 

 parameters: 

Name  Value  description path  A string  Path of file 

name  A string  The file name could be got in command /config/sdcard_list.cgi 

 response: 

Name  Value  description Status  A string  Status of SD card 

num  An integer  Number of files which in deleting list 

path  A string  Path of file 

List  A string   

Convision Systems GmbH

35

 4 Streaming  4.1 Audio & Video 

 4.1.1 get a JPEG image 

 

request: GET /config/jpeg.cgi 

 response: 

HTTP/1.0 200 OK\r\n Content‐Type: image/jpeg\r\n\r\n Content‐Length: \r\n \r\n \r\n  

4.1.2 get motion JPEG Video stream  HTTP JPEG Server‐Push in supported in CGI form which you should following command to have.  request: 

GET /stream/mjpg.cgi?profile=n  parameters: 

Name  Value  description n  An integer (1‐4)  Video profile # 

 response: 

HTTP/1.0 200 OK\r\n Content‐Type: multipart/x‐mixed‐replace;boundary=\r\n \r\n ‐‐\r\n Content‐Type: image/jpeg\r\n Content‐Length: \r\n \r\n \r\n ‐‐\r\n Content‐Type: image/jpeg\r\n Content‐Length: \r\n \r\n \r\n ‐‐\r\n 

 remarks:  

The profile used for http streaming must be configured as MJPEG encode.  Support up to 4 connections.  Microsoft IE does NOT support server‐push technology. 

 

4.1.3 RTSP stream video  Video can be streamed to a streaming video player using the rtsp interface. The URL is in the following format: rtsp:///rtpvideo.sdp  Replace with the appropriate IP address.  rtpvideo1‐4 represents ROI profiles with different characteristics. Some cameras support up to 8 ROI (e.g. EV8180F). The default naming prefix is “rtpvideo”, but this is configurable.    Example: rtsp://192.168.0.2/rtpvideo3.sdp 

Convision Systems GmbH

36

 

4.2 Record Setting  4.2.1 get pre/post record setting 

 

request: GET /config/record_prepost.cgi 

 response: 

Name  Value  description prebuf  An integer  Pre‐alarm recording buffer (MB) 

postbuf  An integer  Post‐alarm recording buffer (MB) 

maxbuf  An integer (read only)  Maximum 24 MB. 

record_nas  on, off  Recording storage (NAS) 

record_sd  on, off  Recording storage (SD Card) 

 4.2.2 set pre/post record setting 

 

request: GET /config/record_prepost.cgi 

see the above table. 

response: see the above table. 

 4.2.3 configure Continuous Recording settings 

request: GET /config/record_cont.cgi  

response: Name  Value  description 

crec_max_fsize  10~300  The maximum file size of each recording clip, in MB. 

crec_storage  sd, nas  Storage for recording clips. sd: local SD card

crec_sched_rec  on, off  on: scheduling recording enabled. off: scheduling recording disabled. 

crec_sched_wday  0,0,0,0,0,0,0  week days: Sun, Mon,…,Sat. 

crec_sched_stm  0000~2359  Start recording time. Format HHMM. e.g.:    1420 means 14:20. 

crec_sched_etm  0000~2359  End recording time. Format HHMM. e.g.:    2050 means 20:50. 

 4.2.4 configure Cyclic Recording settings 

request: GET /config/CyclicRec.cgi  

response: Name  Value  description 

sd_cyclic_enable  0, 1  0 = Enable Cyclic recording for SD 1 = Disable Cyclic recording for SD 

sd_reserve_day  0 ~ 120  File day of reserve in SD 

Convision Systems GmbH

37

nas_cyclic_enable  0, 1  0 = Enable Cyclic recording for NAS 1 = Disable Cyclic recording for NAS 

nas_reserve_day  0 ~ 120  File day of reserve in NAS 

Convision Systems GmbH

38

 5 Camera Control API    5.1 Motor Control 5.1.1 add, delete or goto a PTZ preset 

request: GET /config/ptz_preset.cgi 

parameters: Name  Value  Description 

name 

 1…255  preset id name 

the maximum id depends on the RS485 slave device support 

act  add del go 

add the current position to the preset delete the preset go to the preset  

 response: see the above table.  5.1.2 move PTZ continuously 

 

request: GET /config/ptz_move_cont.cgi 

 parameters: 

 

Name  Value  Description p  ‐6…6  pan the device continuously. 

0: stop >0: pan right 0: tilt up 0: to tele angle 0: focus in 

Convision Systems GmbH

39

see the above table.  

5.1.4 iris continuously  

request: GET /config/iris.cgi 

 parameters: 

Name  Value  Description i  ‐6…6  Iris the device continuously. 

0: stop >0: iris open 

Convision Systems GmbH

40

name  none, patrol, scan, 

PTZ Auto Run Type.  

num  #  if parameter set is schedule or patrol, num should be set as schedule or patrol number. 

  response: 

Name  Value  Description name  none, 

patrol, scan, 

Running PTZ Auto Run state 

patrol_info  Patrol number  When parameter name is patrol, patrol_info will be showing the running Patrol number. 

preset_info  Preset number  When parameter name is patrol, preset_info will be showing the running preset number. 

cruise _info  cruise number  

When parameter name is cruise,    cruise _info will be showing the running cruise number. 

5.1.7 patrol  

request: POST /config/ptz_patrol_info.cgi 

 parameters: 

 

Name  Value  Description num  An Integer (1‐24)  patrol number (1‐24) 

name  A string  patrol name 

act  update, del  

Update or delete preset points in patrol. 

run_num  An integer (1‐256); n is also an integer between 1‐256

n represents the preset group order, e.q.   run7_num=12 means the 7th preset in patrol preset group is preset #12.

run_stay  An integer (3‐3600 ); n is also an integer between 1‐256

n represents the preset group order, e.q.   run7_stay=60 means device should stay 60 seconds/1 minute at the 7th preset then go to next 8th preset in patrol preset group. 

 response: 

Name  Value  Description num  Integer (1‐24)  patrol number 

1‐24 

name  A string  patrol name 

run_num  An integer (1‐256); n is also an integer between 1‐256

n represents the preset group order, e.q.   run7_num=12 means the 7th preset in patrol preset group has been set to preset #12. 

run_stay  An integer (3‐3600 ); n is also an integer between 1‐256

n represents the preset group order, e.q.   run7_stay=60 means device has been set to stay 60 seconds/1 minute at the 7th preset then go to next 8th preset in patrol preset group. 

 

Convision Systems GmbH

41

5.1.8 PTZ privacy mask  

request: GET /config/ptz_privacy_mask.cgi 

 parameters: 

 

Name  Value  Description enable  0 or 1  Enable privacy mask 

0:disable 1:enable 

num  An Integer(1‐24)  mask number 

name  A string  mask name 

act  set, clear check 

mask setup commands;  set, to create a mask clear, to delete a mask check, check if a mask can be set or not 

color  Black   Gray1   Gray2   Gray3   Gray4   Gray5   Gray6   White   Red   Green   Blue   Cyan   Yellow   Magenta 

mask color 

width  An Integer(1‐80)  mask width; the visible are will divide its width into 80 divisions. Each unit represents the width unit here. 

height  An Integer(1‐45)  mask height; the visible are will divide its height into 45 divisions. Each unit represents the width unit here. 

go  An Integer(1‐24)  Go to the position where mask # was set. 

 response: 

Name  Value  Description enable  yes     

no Enable privacy mask  

num  An Integer(1‐24)  mask number;  p.s. The total number of privacy mask is up to 24 but only valid to set 8 masks within visible area. 

Convision Systems GmbH

42

Color  Black   Gray1   Gray2   Gray3   Gray4   Gray5   Gray6   White   Red   Green   Blue   Cyan   Yellow   Magenta 

mask color 

num_name  A string; n is also an integer between 1‐24

mask name 

num_width  An Integer(1‐80); n is also an integer between 1‐24

mask width; the visible are will divide its width into 80 divisions. Each unit represents the width unit here. 

num_height  An Integer(1‐45); n is also an integer between 1‐24

mask height; the visible are will divide its height into 45 divisions. Each unit represents the width unit here. 

tilt  ok not_support  

The valid tilt angle allows to set the privacy mask is between 20 to 84 degrees.  p.s. it will only respond while act=check. 

monitor  ok full 

If the masks currently set within visible area are over 8 masks, it respond full, otherwise ok.  p.s. it will only respond while act=check. 

set  ok fail   

If parameter act=set(clear or check), the parameter set will respond with ok or fail. 

 remarks:     This CGI only valid while using the EV8280U PTZ camera. 

 

5.1.9 auto scan  

request: GET /config/ptz_scan.cgi 

 parameters: 

 

Name  Value  Description type  circle, 

point Auto Scan type.  circle: 360 degree scan point : customized angle scan 

move_zoom  An integer(1~31)  Change zoom ratio   1‐20 mains optical zoom 21 mains optical zoom 20X and digital zoom 2X 22 mains optical zoom 20X and digital zoom 3X 23 mains optical zoom 20X and digital zoom 4X 24 mains optical zoom 20X and digital zoom 5X 25 mains optical zoom 20X and digital zoom 6X 26 mains optical zoom 20X and digital zoom 7X 27 mains optical zoom 20X and digital zoom 8X 28 mains optical zoom 20X and digital zoom 9X 29 mains optical zoom 20X and digital zoom 10X 30 mains optical zoom 20X and digital zoom 11X 31 mains optical zoom 20X and digital zoom 12X 

Convision Systems GmbH

43

set_zoom  An integer(1~31), now 

setting zoom ratio 1‐20 mains optical zoom 21 mains optical zoom 20X and digital zoom 2X 22 mains optical zoom 20X and digital zoom 3X 23 mains optical zoom 20X and digital zoom 4X 24 mains optical zoom 20X and digital zoom 5X 25 mains optical zoom 20X and digital zoom 6X 26 mains optical zoom 20X and digital zoom 7X 27 mains optical zoom 20X and digital zoom 8X 28 mains optical zoom 20X and digital zoom 9X 29 mains optical zoom 20X and digital zoom 10X 30 mains optical zoom 20X and digital zoom 11X 31 mains optical zoom 20X and digital zoom 12X 

move_optical_zoom  An Integer(1~20)  Move optical zoom to move_optical_zoom 

move_digital_zoom  An Integer(1~20)  Move digital zoom to move_digital_zoom When move_optical_zoom is 20 or set_zoom is 20,   move_digital_zoom can be effective. 

move_tilt  An integer(1~90)  move tilt to angle value # 

set_tilt  An integer(1~90), now 

Change tilt angle  when set_tilt=now, device will set current tilt angle for auto‐scan 

speed  An integer(1~6)  auto scan speed 

act  setL, toL, setR, toR, swap show save clean 

Scan setting commands.  setL, to set the LEFT limit angle for angle scan toL, to go to the set LEFT limit angle setR, to set the RIGHT limit angle for angle scan toR, to go to the set RIGHT limit angle swap, to exchange the LEFT/RIGHT limit angle show, pre‐run the scan move save, to save all the settings related to Auto Scan clean, to clean those temporary unsaved data during configuration. 

set_optical_zoom  An integer(1~20)  Set optical zoom ratio for SCAN 

set_digital_zoom  An integer(1~12)  Set digital zoom ratio for SCAN when set_optical_zoom is 20 or zoom is 20, set_digital_zoom can be effective. 

 response: 

Name  Value  Description type  circle, 

point Auto Scan type.  circle: 360 degree scan point : customized angle scan 

zoom  An integer(1~31)  Current zoom ratio   

tilt  An integer(0~90)  

Current tilt angle  

speed  An integer(1~6)  Current auto scan speed 

Convision Systems GmbH

44

optical_zoom  An integer(1~20)  Optical zoom ratio 

digital_zoom  An integer(1~12)  Digital zoom ratio 

 

5.1.10 set absolute PTZ position  

request: GET /config/ptz_degree.cgi 

 parameters: 

 

Name  Value  Description act  move 

set_zero_pan move: to move to the absolute PTZ position assigned Set_zero_pan: to set a relative 0 degree according to the absolute pan degree by now. 

p  An integer(0~1439)  pan degrees 0~3601 means one‐fourth degree

t  An integer(0~339)  tilt degrees 0~92 1 means one‐fourth degree 

z  An integer(4~124)  zoom ratio 1X~20X 1 means one‐fourth magnification 

optical_zoom  An integer(4~80)  Set optical zoom 

digital_zoom  An integer(4~48)  Set digital zoom; When optical_zoom is 20 or z is 20, digital_zoom can be effective. 

 response: 

Name  Value  Description p  An integer(0~1439)  pan degrees 0~360 

1 means one‐fourth degree 

t  An integer(0~339)  tilt degrees 0~851 means one‐fourth degree

z  An integer(4~124)  zoom ratio 1X~20X 1 means one‐fourth magnification 

zero_pan_position  An integer(0~1439)   

optical_zoom  An integer(4~80)  Optical zoom ratio 

digital_zoom  An integer(4~48)  Digital zoom ratio 

 

5.1.11 get auto focus mode request: 

GET /config/ptz_autofocus.cgi  

parameters:  

Name  Value  Description autofocus  yes,no,no_device  enable ,disable the auto focus or no device 

 

5.1.12 Set Zoom Limitation request: 

GET /config/ZoomLimit.cgi  

parameters:  

Convision Systems GmbH

45

Name  Value  Description DigitalZoomEnable  yes,no  Enable digital zoom feature 

 response: 

see above table  

5.2 Via RS‐485  5.2.1 send serial command 

request: GET /config/send_cmd.cgi  

parameters:  

Name  Value  description cmd  A Hex String    Sand serial command (ex:06444f) 

  response: 

   Name  Value  description 

result  yes, fail  the result of send serial command   

 5.2.2 get serial data 

request: GET /config/get_serial.cgi  

response: It will show all available events or status, then send only changed events or status. It will show keep_alive       every 30 seconds.  

Name  Value  description data  A Hex String  the serial data 

 

6 Notification API  

6.1.1 get the notification stream  request: GET /config/notify_stream.cgi  response: It will show all available events or status, then send only changed events or status. It will show keep_alive every 5 seconds.  

Name  Value  Description 

input1  on/off  event input # is triggered or not. 

md#  #=1~3, on/off  event motion detection # is triggered or not 

sd  invalid, ready, write_protected  status for SD card 

vsignal1  on/off  status of video signal is on or lost 

night  on/off  night mode status notification for pc client(on=night mode, off = day mode) 

Convision Systems GmbH

46

reboot  An Integer 

A timestamp integer which show the reboot time of system. This event is only showed in the first notification of the connection, the rest notification would not show this event 

.  

7 RTSP API  

The Real‐Time Streaming Protocol (RTSP) is a protocol to get audio and video streaming data provided by a media server. An IP camera can act as a media server and stream the real time audio and video . By RTSP request, a client application can get streaming data from an IP camera.    The format can be found in section 4.1.2. For additional details about the RTSP protocol please refer to RFC 2326.  

 8 I/O Ports API  

Network cameras and video encoders have integrated digital input and output ports which enable connection to external devices such as detectors, lights, switches and alarm relays. The number of I/O ports is product dependent. In some products, each I/O port can be configured to act as input or output.   

  

Convision Systems GmbH

47

 

9 Appendix    

9.1 Time zone ID  Time zone 

1  (GMT‐12:00) International Date Line West 2  (GMT‐11:00) Midway Island, Samoa 3  (GMT‐10:00) Hawaii 4  (GMT‐09:00) Alaska 5  (GMT‐08:00) Pacific Time (US & Canada) 6  (GMT‐08:00) Tijuana, Baja California 7  (GMT‐07:00) Chihuahua, La Paz, Mazatlan 8  (GMT‐07:00) Mountain Time (US & Canada) 9  (GMT‐07:00) Arizona 10  (GMT‐06:00) Central America 11  (GMT‐06:00) Guadalajara, Mexico City, Monterrey 12  (GMT‐06:00) Saskatchewan 13  (GMT‐06:00) Central Time (US & Canada) 14  (GMT‐05:00) Bogota, Lima, Quito, Rio Branco 15  (GMT‐05:00) Eastern Time (US & Canada) 16  (GMT‐05:00) Indiana (East) 17  (GMT‐04:00) Caracas, La Paz 18  (GMT‐04:00) Atlantic Time (Canada) 19  (GMT‐04:00) Santiago 20  (GMT‐04:00) Manaus 21  (GMT‐03:30) Newfoundland 22  (GMT‐03:00) Buenos Aires, Georgetown 23  (GMT‐03:00) Brasilia 24  (GMT‐03:00) Greenland 25  (GMT‐03:00) Montevideo 26  (GMT‐02:00) Mid‐Atlantic 27  (GMT‐01:00) Azores 28  (GMT‐01:00) Cape Verde Is. 29  (GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London 30  (GMT) Casablanca, Monrovia, Reykjavik 31  (GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague 32  (GMT+01:00) West Central Africa 33  (GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb 34  (GMT+01:00) Brussels, Copenhagen, Madrid, Paris 35  (GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna 36  (GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius 37  (GMT+02:00) Athens, Bucharest, Istanbul 38  (GMT+02:00) Beirut 39  (GMT+02:00) Harare, Pretoria 40  (GMT+02:00) Cairo 41  (GMT+02:00) Minsk 42  (GMT+02:00) Amman 43  (GMT+02:00) Windhoek 44  (GMT+02:00) Jerusalem 45  (GMT+03:00) Baghdad 46  (GMT+03:00) Moscow, St. Petersburg, Volgograd 

Convision Systems GmbH

48

 ID  Time zone 

47  (GMT+03:00) Tbilisi 48  (GMT+03:00) Nairobi 49  (GMT+03:00) Kuwait, Riyadh 50  (GMT+03:30) Tehran 51  (GMT+04:00) Baku 52  (GMT+04:00) Abu Dhabi, Muscat 53  (GMT+04:00) Yerevan 54  (GMT+04:30) Kabul 55  (GMT+05:00) Ekaterinburg 56  (GMT+05:00) Islamabad, Karachi, Tashkent 57  (GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi 58  (GMT+05:30) Sri Jayawardenepura 59  (GMT+05:45) Kathmandu 60  (GMT+06:00) Astana, Dhaka 61  (GMT+06:00) Almaty, Novosibirsk 62  (GMT+06:30) Yangon (Rangoon) 63