Convision Systems GmbH
Manual
CGI Application Programming Interface CONVISION CC-8xxx Cameras (NVSCGI API) Firmware v1.1.4 or above Version: 1.7b
Issue: December 2012
1
Convision Systems
Convision Systems GmbH
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
2
Convision Systems GmbH
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. 3
Convision Systems GmbH
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
4
Convision Systems GmbH
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 5
Convision Systems GmbH
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 6
Convision Systems GmbH
5
6 7 8 9
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 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 Notification API ................................................................................................................................... 45 6.1.1 get the notification stream............................................................................................... 45 RTSP API............................................................................................................................................... 46 I/O Ports API ........................................................................................................................................ 46 Appendix ............................................................................................................................................. 47 9.1 Time zone..................................................................................................................................... 47
7
Convision Systems GmbH
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.
8
Convision Systems GmbH
※
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)
9
Convision Systems GmbH
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.
10
Convision Systems GmbH
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 200
OK
HTTP text
400
Bad Request
401
Unauthorized
404 500
Not Found Internal Error
503
Service Unavailable
Description The request has succeeded, but an application error may occur, please refer to each CGI response. You used invalid or unsupported parameters or values for this IP camera. The request requires user authentication or the authorization was refused. This API is not supported for this IP camera. The IP camera encountered an internal error or the API can not get the correct status. 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.
11
Convision Systems GmbH
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 model A string product A string brand A string version A string build A string sn nipca A string name A string location A string macaddr A MAC address ipaddr An IP address netmask An IP address gateway An IP address wireless ptz
yes P, T, Z
inputs outputs speaker videoout dns dns1 hiddenmod
# # yes, no yes, no A string
Description model name product name of camera brand name version number firmware build number product serial no version number of NIPCA supported camera name camera location the MAC address IP address Subnet mask Default router/gateway used for connecting devices attached to different networks and networks segment. Only displayed if has wireless Only show supported Pan or Tilt or Zoom. For example, ptz=P,T The number of inputs The number of outputs Only displayed if the IP camera has speaker. Only displayed if the IP camera has video out connector DNS server address alternative DNS server address Display the model name mapped from.
3.1.2 get camera info request: GET /config/datetime.cgi
response: Name Name
Value A string
Camera name.
Description
3.1.3 get system date and time
request: GET /config/datetime.cgi
response: Name
Value
Description
12
Convision Systems GmbH method
0, 1
timeserver timezone date time dstenable dstauto offset
A host or IP address # A date A time no, yes no, yes A time
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
0: disable ntpd (manual sync) 1: enable ntpd NTP time server host name or IP address. time zone ID, see Time zone yyyy‐mm‐dd hh:mm:ss disable or enable the DST (Daylight Saving Time) set DST automatically The amount of time the clock should be turned back/forward (hh:mm), due to DST.
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 users …
Value
Description 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
13
Convision Systems GmbH
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 groups
Value An integer ,…
Response: If request parameters, Name groups privilege
Value Description An integer The total number of groups Ptz, outputs, video, config The permission list for this group
Description The total number of groups For example, admin=admin,root
3.2.5 query support privileges Request GET /config/privilege_info.cgi Response: Name privilege
Value Ptz, outputs, video, config Available privileges.
3.3 Video, Sensor, Audio 14
Description
Convision Systems GmbH
3.3.1 get stream config
Request: GET /config/stream.cgi
response: Name
Value Enable,Disable string Integer Integer Integer On,off String (ipv4 format) Integer Integer (1‐255) Integer (0‐20)
auth stream_name rtsp_port rtp_video_port rtp_audio_port multicast multicast_ip multicast_port multicast_ttl max_client
Description Stream auth Stream url name The port of rtsp The video port of rtp The audio port of rtp Stream Support multicast Multicast ip address Multicast port Multicast ttl number 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 sensor_mode
profile_id_ resolution
Value "5mp" ‐ 5MP mode "3mp" ‐ 3MP mode "1080p" ‐ 1080p mode "1mp" ‐ 1.3MP mode (A models) "720pb" ‐ Minilux 720p mode 1..4
Descriptio n Max resolution
The profile id Resolution list for different sensor mode.
bitrate
e.q. 1920x1080/ 640x480/ 320x240 An integer (1000‐12000)
codec
MPEG4,MJPEG,H264
a video codec
framerate
1 ... 30
a frame rate in fps
gopsize
the MPEG GOP size which means times of framerate. (1‐4 fps)
quality
e.q. 30/60/90/120 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
in kbit/s
15
Convision Systems GmbH
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 sensor_mode
Value
Description
resolution_p
"5mp" ‐ 5MP mode Max resolution "3mp" ‐ 3MP mode "1080p" ‐ 1080p mode "1mp" ‐ 1.3MP mode (A models) "720pb" ‐ Minilux 720p mode 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&a udioout_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.
16
Convision Systems GmbH sensor mode
5MP
3MP
Max resolution & frame rate 1 profile & 1st profile resolution list(@10fps) 2592x1920
2 profiles & 2nd profile/ resolution list(@10fps) 736x480(60Hz) / 736x576(50Hz)
1024x768
640x480
800x600
320x240
1 profile & 1st profile resolution list(@20fps) 2048x1536
160x120 2 profiles & 2nd profile/ resolution list(@20fps) 736x480(60Hz) / 736x576(50Hz)
1024x768
640x480
320x240
160x120 2 profiles & 2nd profile/ resolution list(@15fps) 736x480(60Hz) / 736x576(50Hz)
800x600 1st profile resolution list (30fps or 15 fps) one profile two profiles 1920x1080 @ 1920x1080 @ 1080p 30fps 15fps 1280x720 @ 1280x720 @ 30fps 15fps 1 profile & 1st profile resolution list(@30fps) 1mp 1280x1024 (A 1024x768 model) 800x600 1 profile & 1st profile resolution list(@30fps) 1280x720 720p
4 profiles' resolution(@10fps) 640x480 only
4 profiles' resolution(@20fps) 640x480 only
4 profiles' resolution(@20fps) 640x480 only
640x480
320x240
160x120 2 profiles & 2nd profile/ resolution list(@30fps) 736x480(60Hz) / 736x576(50Hz)
4 profiles' resolution(@20fps) 640x480 only
640x480
320x240
160x120 2 profiles & 2nd profile/ resolution list(@30fps) 736x480(60Hz) / 736x576(50Hz)
4 profiles' resolution(@20fps) 640x480 only
640x480
320x240
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 in
Value mic, line_in
Description mic: Microphone input line_in: Line input
17
Convision Systems GmbH
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 sensor_mode
Value "5mp" ‐ 5MP mode "3mp" ‐ 3MP mode "1080p" ‐ 1080p mode "1mp" ‐ 1.3MP mode (A models) "720pb" ‐ Minilux 720p mode A string A string
Description Sensor mode has been set.
profile_id_1 Valid resolution list for profile 1 profile_id_2 Valid resolution list for profile 2 ※ Once if the 4 profile (Video/amp-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
brightness contrast saturation sharpness max_exposure man_exposure max_gain man_gain autoexposurelimit
An integer An integer An integer An integer An integer An integer An integer An integer yes,no
limit_upper
An integer
limit_lower
An integer
blc defilicker whitebalance
An integer An integer auto,disabled
Description
the brightness (0…255) the contrast (0...255) the saturation (0...255) the sharpness (0...255) the max exposure value (0...4) the manual exposure value (0...12) the max gain value (0…6) the manual gain value (0…6) To limit the auto exposure range or not Once the autoexposurelimit is set to yes, limit_upper shoud be set between 0~+2EV (0…4) Once the autoexposurelimit is set to yes, limit_lower shoud be set between 0~ ‐2EV (0…4) the backlight compensation value (0…8) deflicker frequency value (50 or 60) enable or disable the auto white balance 18
Convision Systems GmbH
autoexposure autogaincontrol nf_mode nf_level dn_fps mirror flip ext_wdr
env_pos autoiris
yes,no yes,no auto,manual An integer An integer on,off on,off disable, low, medium, high indoor, outdoor yes,no
man_iris
yes,no
enable or disable the auto exposure enable or disable the auto gain control function noise reduction: auto or manual noise reduction level at manual mode (0…255) the night mode fps type (0…3) enable ,disable image mirror horizontally enable ,disable image flip vertically disable WDR mode, set low strength WDR mode, (not all models supported) set medium strength WDR mode, set high strength WDR mode, Location: indoor or outdoor enable or disable the auto iris Only for EV8280U. 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
brightness contrast saturation sharpness max_exposure man_exposure max_gain man_gain autoexposurelimit
An integer An integer An integer An integer An integer An integer An integer An integer yes,no
limit_upper
An integer
limit_lower
An integer
blc whitebalance autoexposure autogaincontrol nf_mode nf_level dn_fps mirror flip ext_wdr
An integer auto,disabled yes,no yes,no auto,manual An integer An integer on,off on,off disable, low,
Description
the brightness (0…255) the contrast (0...255) the saturation (0...255) the sharpness (0...255) the max exposure value (0...4) the manual exposure value (0...12) the max gain value (0…6) the manual gain value (0…6) To limit the auto exposure range or not Once the autoexposurelimit is set to yes, limit_upper shoud be set between 0~+2EV (0…4) Once the autoexposurelimit is set to yes, limit_lower shoud be set between 0~ ‐2EV (0…4) the backlight compensation value (0…8) enable or disable the auto white balance enable or disable the auto exposure enable or disable the auto gain control function noise reduction: auto or manual noise reduction level at manual mode (0…255) the night mode fps type (0…3) enable ,disable image mirror horizontally enable ,disable image flip vertically disable WDR mode, set low strength WDR mode, (not all models supported) 19
Convision Systems GmbH
env_pos autoiris
medium, high indoor, outdoor yes,no
man_iris
yes,no
set medium strength WDR mode, set high strength WDR mode, Location: indoor or outdoor enable or disable the auto iris Only for EV8280U. 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
dn_mode
dn_bw dn_status deflicker
Value
auto, day, night, di, extls, ae on,off day,night An integer
Description
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 enable ,disable night B/W mode day or night status 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
channel
1 (fixed)
the audio codec; “none” will mute the device. 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
20
Convision Systems GmbH
response: see the above table
3.3.16 get audio port from client to camera request: GET /config/audiopost.cgi
response: Name port
Value
An integer ( 1000~ 65530)
Description 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 i
Value
Description 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 0: pan right 0: tilt up 0: to tele angle 0: focus in 0: iris open
