For HE4K-01 / HE4K-R4 / MVE-150 / MVE-100R / SME-01 / DME-02/03/04 use Z3-TI-http_api

For firmware version 5.X and higher

To read configuration variable, simply perform an HTTP GET to the URL

http://server_address/cgi-bin/control.cgi

with the body as given below.

The reponse will be in JSON format, giving the value of each variable.
To read global configuration variables, GET with this body:

ctrl=sys&chn=null

To read encoder channel configuration variables for channel 1, GET with this body:

ctrl=enc&chn=1

Python example code for reading configuration:

import requests, json, sys

server_url='http://192.168.0.120/cgi-bin/control.cgi'

global_cfg = requests.get(server_url, params='ctrl=sys&chn=null')
print global_cfg.json()

enc_cfg = requests.get(server_url, params='ctrl=enc&chn=1' )
print enc_cfg.json()

Sample output:

>>> print global_cfg.json()
{u'ipmtu': 1500, u'vid_port': u'microhdmi', u'macaddr': u'40:cd:3a:04:f0:c3', u'logo_enable': u'off', u'wifi_exists': True,
u'processor_id': u'QCS605', u'ddns_password': u'', u'model_enable': u'off', u'enc_current_preset': u'encoder',
u'default_gw': u'192.168.0.1', u'disp_std': u'auto', u'session_id': u'---', u'ddns_provider': u'freedns',
u'ptp_role': u'auto', u'timezone': u'CST6CDT,M3.2.0,M11.1.0', u'MODEL': u'Z3-Q603-HD', u'opstate': u'RUNNING',
u'hwversion': u'Z3-Q603-HD', u'ddns_enable': u'off', u'disp_input': u'primary', u'board_id': u'0xFF10',
u'termserve_remote_enable': u'on', u'hwserial': u'30010110194010011', u'console_enable': u'on', u'enable_ptp': u'false',
u'camera2_if_type': u'Unused', u'local_netmask': u'255.255.255.0', u'ret': u'0', u'logo_width': 319, u'MIC_analog_gain_db': 5,
u'camera1_if_type': u'Sony_LVDS', u'opmode': u'encoder', u'syspassword': u'', u'local_dnsip2': u'0.0.0.0',
u'ddns_hostname': u'', u'use_dhcp': u'0', u'enc_vivpss_mode_enable': u'off', u'pe3': u'', u'z3_termsrv': u'enabled',
u'MICL_analog_gain_db': -20, u'preview_auto_start': u'1', u'pe7': u'', u'logo_height': 156,
u'sensor_serial': u'30010310194010011\n', u'ddns_username': u'', u'eth_speed': u'AUTO', u'nfs_enable': u'off',
u'nfs_server': u'192.168.1.6', u'z3_avmux': u'enabled', u'nmea_enable': u'off', u'z3_sntp': u'enabled',
u'eth_duplex': u'AUTO', u'z3_fec_enc': u'enabled', u'z3_webproxy': u'enabled', u'enc_adv_setting': u'off',
u'do_autostart': 1, u'enc_channels': u'1', u'pe8': u'', u'local_dnsip': u'192.168.0.1', u'local_ip': u'192.168.0.14',
u'pe4': u'', u'pe5': u'', u'pe6': u'', u'diff_serve': 0, u'pe0': u'encoder', u'pe1': u'', u'pe2': u'',
u'nfs_server_root': u'/c/media', u'enable_snmp': u'false', u'fpgafileglob': u'', u'enable_sntp': u'true',
u'sysdevicename': u'Z3-Q603-HD', u'sntp_servers': u'pool.ntp.org', u'zfinder_enable': u'on', u'model_name': u'Z3-Encoder',
u'hw50serial': u'50010110194010011', u'visca_present': u'true'}

print enc_cfg.json()
{u'vmulticastdest': u'225.1.2.3', u'tslowlat': u'on', u'klvmuxmethod': u'sync', u'srt_destAddr': u'192.168.0.6',
u'vcrop_height': 1080, u'zixifecblock': u'50', u'telopcharsize': u'32', u'source_status_str': u'+CAMERA 1920x1080p 60.00 fps\n',
u'vratectrl': u'cbr', u'rotate_angle': 0, u'zixisession': u'test', u'asource': u'CAMERA', u'aport': u'8700', u'pmtpid': 31,
u'authonoff': u'off', u'srt_encrypt': 0, u'vcodec': u'h265', u'klvmode': u'sdi', u'auxonoff': u'off', u'channel': 1,
u'mounts': u'', u'vcrop_width': 1920, u'vcrop_x': 0, u'vcrop_y': 0, u'amulticastdest': u'225.1.2.3', u'vprofile': u'high',
u'klvsrc': u'/dev/gv7601.0', u'auth_passwd': u'password', u'teloplocation': u'top_left', u'gps_overlay_device': u'/dev/ttyAMA0',
u'ret': u'0', u'klvserialbaud': u'115200', u'rtsp_auth_password': u'admin', u'zixirateadjen': u'on', u'zixiauthen': u'off',
 u'vinterlacemode': u'combine', u'vgopsize': 60, u'mmulticastdest': u'225.1.2.3', u'vcrop_enable': u'off', u'klvenable': u'off',
u'preset': u'actv_preset', u'mport': u'8800', u'auth_user': u'user', u'gps_overlay_enable': u'off', u'zixioverhead': u'15',
u'tsrate': u'5000K', u'enc_status': u'RUNNING', u'pcrinterval': 50, u'aptspcr': 250, u'filesize': u'1024M', u'klvbrate': u'1000',
u'acodec': u'fdk_aaclc', u'lowdelay_opt': u'off', u'apid': 120, u'zixilatency': u'500', u'rtsp_auth_enable': u'off', u'srt_mode': 0,
u'klvpid': u'35', u'nfstrength': u'0', u'vbitrate': u'4M', u'rtsp_auth_username': u'admin', u'zixiuser': u'user',
u'gps_overlay_location': u'top_right', u'vprotocol': u'rtsp', u'feconoff': u'off', u'vdelay': 1000, u'vsource': u'CAMERA',
u'fprefix': u'MOV1_%C', u'telopenable': u'off', u'teloptext': u'Z3-Q603-HD', u'storage': u'/media/sda1', u'vquality': u'balanced',
u'asamplerate': u'1', u'vgdr': u'off', u'rotate_enable': u'off', u'avmux_index': u'streaming', u'abitrate': u'128000', u'vpid': 221,
u'feccol': 5, u'gps_overlay_char_size': u'32', u'vframeratediv': 1, u'pipenable': u'off', u'vres': u'follow_input', u'pcrpid': 521,
u'aenable': u'off', u'apair': 0, u'piplocation': u'top_right', u'rtmp265_enable': u'off', u'srt_pass': u'password1234',
u'vdest': u'192.168.0.6:8600', u'fecrow': 1}

Description: Enable audio channel

Possible values: yes, no

Description: Audio encoder algorithm selection

Possible values: dsp_aaclc, fdk_aaclc, fdk_aache, fdk_aache_v2

Description: Audio encode bitrate

Possible values: Depends on codec; in units of bits per second

Description: Audio sample rate

Possible values: 48000, 44100

Description: Select audio input

Possible values: MICL (microphone, line input levels)

               MIC    (unpowered microphone levels)
               HDMI   (microHDMI input, for HE4K-DCK/FV4K-13A only)
               HD-SDI (SDI input, for DME-10/FSDI-DCK/FSDI-13A only)

Description: Audio PID for transport stream.

Possible values: 32 to 8191 - must not conflict with other PID assignments.

Description: Destination UDP port for RTP audio

Description: For transport stream modes only – intial PTS to PCR offset for audio, in milliseconds

Possible values: 100 to 2000

Description: Password for RTMP authentication.

Description: Username for RTMP authentication.

Description: Enable or disable RTMP authentication. Default: off Possible values: on, off

Description: Encoder channel number

Possible values: 1, 2, 3

Description: Column count for ProMPEG.

Possible values: integer greater than 1

Description: Enable ProMPEG if supported.

Possible values: on, off

Description: Row count for ProMPEG.

Possible values: integer greater than 1

Description: Size of TSFILE or AUX file recording, in bytes.

A “K” suffix indicates kilobytes (thousands of bytes/second).

A “M” suffix indicates megabytes (millions of bytes/second).

Description: Relative filename for TSFILE or AUX file recording. Note that “fprefix” does NOT include the absolute media path – the “storage” parameter is the proper place to specify the absolute media path.

Absolute path to mounted media device (e.g. /media/sda1/)

For MP4 recording only. Possible values: normal, streaming

normal means MOOV atom at the end of file.

streaming means MOOF atoms interspersed throughout the file, which is more tolerant of errors and truncated files.

streaming is recommended for most recording scenarios. Only select “normal” if you want conventional MOOV atom at the end of file, if some legacy tool or decoder requires it.

OSD overlay text character size in pixels

Possible values: 16, 32, or 64

Enable or disable telop (i.e. OSD overlay of text).

Possible values: on, off

Where to overlay text in the encoded video

Possible values: top_left top_right top_center bottom_left bottom_right bottom_center

Text string for OSD overlay

Description: Distance between I frames (key frames) in GOP sequence

Possible values: 1 through 240

Description: Video bitrate in bits per second.

Possible values: A “K” suffix indicates kilobits (thousands of bits/second).

A “M” suffix indicates megabits (millions of bits/second).

Note: In UDP transport stream case, the tsrate should be set

higher than the vbitrate, with at least 15% margin.

Description: Video maximum burst size in milliseconds.

Possible values: 100 to 2000

Description: Destination URL address for encoded bitstream. May be interpreted differently depending on “vprotocol” setting.

For UDP and RTP transports:

client_ip:client_port

For RTMP transport:

 server_ip[:server_port]/application/streamname

Description: Divide video input frame rate by this number to get encode frame rate.
The encoder will discard (frameratediv-1) out of (frameratediv) frames.

Possible values: 1, 2, 3, 4, 5, 6

Description: Enable or disable Gradual Data Refresh. Reduces I-frame size (reduces latency). At lower bitrates, a horizontal rolling artifact may be visible.

Possible values: on, off

Description: Specifiec which codec to encode with.

Possible values: h265, h264, mjpeg

Description: H.264 profile (see https://en.wikipedia.org/wiki/H.264/MPEG-4_AVC#Profiles​ for full description)

Possible values: baseline, main, high

Description: Protocol used to transport the encoded bitstream.

Possible values: rtp, rtmp, udp, asi, tsfile, mts, tsrtp

Description: Set balance between low latency, and higher quality+bitrate compliance.

Possible values: lowlat, balanced, high

Description: Rate control mode for encoder.

Possible values: cbr, vbr

vbr mode may be burstier than cbr.

Description: Video resolution

Possible values: follow_input preserve video source resolution, no resize

               WxH           resize to width W and height H

Description: Video input from which encoder will source its video

Possible values: Board-dependent

Description: Enable PIP of channel 2 on channel 1 encode. Only available on FV4K/FV2K/FSDI

Possible values: on, off

Description: Sets the location of the PIP on channel one. Only available on FV4K/FV2K/FSDI

Possible values: top_left, top_right, bottom_left, bottom_right

Description: Sets the interlaced mode for the video input

Possible values: combined, separated (H265 only)

Description: video multicast destination for RTSP. Used by ONVIF StartMulticast/StopMulticast functions

Possible values: valid multicast addresses

Description: audio multicast destination for RTSP. Used by ONVIF StartMulticast/StopMulticast functions

Possible values: valid multicast addresses

Description: enables/disables rtsp authorization for stream

Possible values: on, off

Description: username for rtsp authorization

Possible values: alpha numeric string

Description: password for rtsp authorization

Possible values: *

The following parameters only apply to transport stream encoding (transport is set to udp, asi, tsfile, mts, or tsrtp).

Description: Video PID for transport stream.

Possible values: 32 to 8191 – must not conflict with other PID assignments

Description: Audio PID for transport stream.

Possible values: 32 to 8191 – must not conflict with other PID assignments

Description: PCR PID for transport stream.

Possible values: 32 to 8191 – must not conflict with other PID assignments

Description: PMT PID for transport stream.

Possible values: 16 to 31 – must not conflict with other PID assignments

Description: Transport stream total transport rate in bits per second.

Possible values: The 'K' suffix indicates kilobits (thousands of bits/second). The 'M' suffix indicates megabits (millions of bits/second).

Note: In UDP transport stream case, the tsrate should be set higher than the vbitrate, with at least 15% margin.

Description: Low latency transport stream mode (VBR).

Possible values: off, on

Describe: Enable AUXillary file recording in UDP mode – allows simultaneous UDP streaming and TS file recording on the same channel. Only valid if transport is UDP and tslowlat is off

The path to storage is set by the “storage” parameter.

The filename is set by the “fprefix” parameter. The default value is “MOV1_%F_%T”. The “%F” specifier inserts a date stamp, and the “%T” specifier inserts a time stamp.

The recording file size is set by the “filesize” parameter. When the file reaches this size, a new file will be created.

Description: Bitrate to allocate in transport stream for KLV data.

Description: Enable KLV capture from SDI, UART or debug file, if supported.

Possible values: off, on

Description: Type of KLV source device, whose path is specified in klvsrc

Possible values: sdi, serial, file

Description: If klv_mode is serial, specify the baud rate

Possible values: 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200

Description: Select synchronous or asynchronous transport stream KLV multiplexing, as specified in MISB ST 1402

Possible values: sync, async

Description: PID for KLV data in transport stream

Description: Source device for KLV metadata

Description: Interval between PCR packets in milliseconds.

Possible values: 30 - 100

Python example code for starting/stopping all channels:

import requests, json
import sys, getopt

actionname='StartChannel'

server_url='http://192.168.0.120'

control_cgi_url = server_url + '/cgi-bin/control.cgi'

payload = 'ctrl=sys&chn=null'
sysctrl = requests.get(control_cgi_url, params=payload)

j = sysctrl.json()
print j

enc_channels_string = j['enc_channels']
opmode       = j['opmode']

enc_channels = enc_channels_string.split( ',' )

print 'enc_channels', enc_channels, 'opmode', opmode

channel_list = enc_channels

for channel in channel_list :
    # Remove leading C
    if channel[0:0] == 'C':
        channel = channel[1:]
    print actionname, ' ', opmode, 'channel', channel
    payload = 'action='+actionname+'&'+ 'chn=' +channel+'&' + 'loadfromdb=true';
    headers={'Content-Type':'application/x-www-form-urlencoded; charset=UTF-8'}
    r = requests.post(control_cgi_url, data=payload, headers=headers)

    print r.text

The “loadfromdb=true” parameter will load the current settings from the database.

If you omit the loadfromdb parameter, *none* of the database settings will be used – any parameters you do not supply, will be set to default values.

For example, this is what a StartChannel request from the web server looks like:

action=StartChannel&chn=1&vsource=&vres=follow_input&vcodec=h265&vgdr=on&vprofile=high&vratectrl=cbr&vbitrate=2M&vframeratediv=1&vgopsize=60&vprotocol=rtsp&vdest=192.168.0.6:8600&storage=&fprefix=MOV1_%F_%T_&vpid=221&vdelay=1000&pcrpid=521&pcrinterval=50&pmtpid=31&tsrate=3000K&tslowlat=on&feconoff=off&fecrow=1&feccol=5&zixioverhead=15&zixiauthen=off&zixisession=test&zixiuser=user&aenable=on&asource=MICL&acodec=fdk_aaclc&abitrate=128000&asamplerate=48000&aport=8700&apid=120&aptspcr=250&klvenable=off&klvmode=sdi&klvsrc=/dev/gv7601.0&klvpid=35&klvbrate=1000&authonoff=off&auth_user=user&auth_passwd=password&auxonoff=off&filesize=1024M&telopenable=off&teloptext=ENCDEV&teloplocation=top_left&telopcharsize=32&vquality=balanced

Pan to the left at half speed

  action=PtzContinuousMove&data={"PanTilt":{"x":-0.5,"y":0},"idx":0}

Pan to the right at half speed

  action=PtzContinuousMove&data={"PanTilt":{"x":0.5,"y":0},"idx":0}

Tilt down at max speed

  action=PtzContinuousMove&data={"PanTilt":{"x":0,"y":1},"idx":0}

Stop pan and tilt

  action=PtzStop&data={"mode":1,"idx":0}

Add a channel. Check the channel number is valid or not. Based on it, update the channel number and preseting values in the Database.

enc_channels Channel number Possible values: 1 to 4.

Returns:

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the channel number and URL as an input and update this value along with the index in the database.

channel channel number.

histidx Index of the channel.

url URL of the channel.

Returns:

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Read vendor and model info from the visca command.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

cam_index Read the camera index value. Possible values: 1 = Camera 1, 2 = Camera 2.

function

Returns:

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Send control commands to camera.

Only one command can be sent at a time; the list below are the only supported VISCA commands through the HTTP API. To use VISCA commands that are not listed, usage of the TCP socket can be used to send those VISCA commands.

API Format:

action=CameraControl&interface=Visca&command=visca_command&cam_index=1

interface possible values: Visca, Tamarisk, Tau2, Boson, Genlock (default: Visca)

example:

Commands without value assignments

action=CameraControl&command=dzoom_off&cam_index=1

Commands with value assignments

action=CameraControl&command=set_monitor_mode 1080p-59.94&cam_index=1

The Visca commands use the same syntax as the serial menu “V” command, as shown below

For the most current list of VISCA commands supported press “V” from the Serial/SSH session of the Serial Menu.

auto_icr_disable
auto_icr_enable
cam_control_inquiry
cam_custom_recall
cam_custom_reset
cam_custom_set
chroma_get_suppress
chroma_suppress      Set Chroma Suppression  (0=none, 1 to 3=chroma supression strength)
clear_if
color_gain           Set Color gain (0=60%, 14=200%)
color_get_gain
color_get_hue
color_hue            Set Color hue (0=-14 degrees, 14=+14 degrees)
debug_rx
dzoom_combine_mode
dzoom_direct         D-Zoom Position (0x00 to 0xeb)
                     * Enabled during Separate mode
dzoom_off
dzoom_on
dzoom_separate_mode
dzoom_stop
dzoom_super_res
dzoom_tele_var       p = 0 (Low) .. 7 (High)
                     * Enabled during Separate Mode
dzoom_wide_var       p = 0 (Low) .. 7 (High)
                     * Enabled during Separate Mode
dzoom_x1_max
eflip_off
eflip_on
ext1_func_inquiry
ext2_func_inquiry
ext3_func_inquiry
focus_auto
focus_direct         focus pos
                     Min. 0x1000 Over Inf
                     0x2000 10m
                     0x3000 5m
                     0x4000 3.3m
                     0x5000 2.5m
                     0x6000 2m
                     0x7000 1.7m
                     0x8000 1.5m
                     0x9000 1m
                     0xa000 50cm
                     0xb000 30cm
                     0xc000 15cm
                     0xd000 6cm
                     0xe000 1cm
focus_get_mode
focus_get_pos
focus_manual
focus_near_limit     focus near limit
                     Min. 0x1000 Over Inf
                     0x2000 10m
                     0x3000 5m
                     0x4000 3.3m
                     0x5000 2.5m
                     0x6000 2m
                     0x7000 1.7m
                     0x8000 1.5m
                     0x9000 1m
                     0xa000 50cm
                     0xb000 30cm
                     0xc000 15cm
                     0xd000 6cm
                     0xe000 1cm
focus_stop
focus_tele_std
focus_tele_var       p = 0 (Low) .. 7 (High)
focus_toggle
focus_wide_std
focus_wide_var       p (0 (Low) .. 7 (High))
get_low_delay_mode   Get low delay mode: 0 - normal, 1 - low delay
get_monitor_mode     get_monitor_mode: Get video mode of camera output
help
high_sensitivity_off
high_sensitivity_on
icr_mode             modes:
                     auto
                     on
                     off
                     threshold [0-255]
lens_control_inquiry
lens_get_temp
lr_reverse_off
lr_reverse_on
other_inquiry
power_inquiry
power_off
power_on
register_read        Read internal register.
register_write       Write internal register.
                     * Note: To make register changes effective, run power_off and power_on
set_address
set_low_delay_mode   Set low delay mode: 0 - normal, 1 - low delay
set_monitor_mode     Set monitor mode.
                     List of modes: 1080p-25
                     720p-50
                     720p-59.94
                     2160p-25
                     2160p-29.97
                     1080p-29.97
                     1080p-59.94
                     1080p-50
slow_shutter         modes:
                     on
                     off
limit [0-255]
trace                enable (0=off, 1=on)
version_inquiry
wb_auto_mode
wb_autotrace_mode
wb_get_bgain
wb_get_mode
wb_get_mode_name
wb_get_rgain
wb_indoor_mode
wb_manual_bgain_direct Set Manual WB BGain (0..255)
                       * Enabled during Manual WB mode
wb_manual_bgain_reset
wb_manual_mode
wb_manual_rgain_direct Set Manual WB RGain (0..255)
                       * Enabled during Manual WB mode
wb_manual_rgain_reset
wb_onepush_mode
wb_onepush_trigger
wb_outdoor_auto_mode
wb_outdoor_mode
wb_sodium_lamp_auto_mode
wb_sodium_lamp_fixed_mode
wb_sodium_lamp_outdoor_mode
zoom_direct          pos
                     Min. 0x0000
                     Max. 0x4000 (In Separate mode)
                     Max. 0x4000 (In Combine mode and DZoom=Off)
                     Max. 0x59C0 (In Combine mode, DZoom=Super Resolution Zoom, and monitoring mode QFHD)
                     Max. 0x6000h (In Combine mode, DZoom=Super Resolution Zoom, and monitoring mode FHD or less)
                     Max. 0x7AC0h (In Combine mode and DZoom=On)
zoom_get_pos
zoom_stop
zoom_tele_std
zoom_tele_var        p = 0 (Low) .. 7 (High)
zoom_wide_std
zoom_wide_var        p (0 (Low) .. 7 (High))

With dual VISCA camera supported added we need to tell the API which camera we want to talk to. this is done with cam_index

The values accepted are either 1 or 2

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Delete the decoder history for the channel number and update in the database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

Returns:

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Clear the channel deatils in the database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

Returns:

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the row as an input and delete the row information in the database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

Opmode operation mode. Possible values: Encoder or Decoder

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Disconnect the wifi network and stop the wifi process id.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Dynamic instance for the channel number and update the preseting values in the database

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

var Read the nfstrength value

val rotate_angle value.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Safely eject the removable storage media from the device.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

dev Removable device mount point

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Delete the preseting values from the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

mode Get the operation mode. The default mode is encoder. Possible values : Encoder , Decoder.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Create a new database and export the preseting values from the currernt database to the new database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

mode Get the operation mode. The default mode is encoder. Possible values : Encoder , Decoder.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Remove the opt/config folder from the device and set up the default ip address, net mask, gateway, primary dnsip, dhcp in the device.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

reset_ip Get the reset value. Possible values: 1, 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Format the removable storage media in FAT filesystem format and mount it.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

mnt_point removable storage media node path which needs to be formated.

file_system File system type to be used with mkfs.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the value of color table using the system call and pixel format from the fpga.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

color_table Color table. Possible values: 0 , 1.

pxl_format Pixel format.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the camera tab index and camera type. Provide the html file

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

tab_index Get the camera tab index. Possible values: 1 = Camera 1, 2 = Camera 2.

type Get the camera type. Possible values: Visca,

html Provide the html file. Default html file is visca.html. Possible html file: visca.html, flexio.html.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Read the encoder status.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

status The encoder status can be RUNNING/ STOPPED/ IDLE/ Couldn't deduct input on camera.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the sensor id and read the video inputs from the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

sensorid Sensor ID.

vport video port is Camera source. Possible values: 1 = Camera 1, 2 = Camera 2.

friendly_name name of the video source.

vdevice Video device. Possible values: MIPI, SONYLVDS, LT6911

input_index input device. Possible values: 0, 1.

bus device address. Default NULL

enabled Video input enabled or disabled. Default is 1. Possible values: 0, 1.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the Wifi password.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

ssid Read the service set identifier

psk Provide the wifi password.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Querry the PTZ values for the angle.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Read the json table and retrieve the index and querry type. Possible querry are YawAngle, PitchAngle, RollAngle, All.

YawAngle provide the yaw angle value from the PTZ.

PitchAngle provide the pitch angle value from the PTZ.

RollAngle provide the roll angle value from the PTZ.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Load the active preset value from the Database and update in the state table database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

enc_current_preset Get the preset row and check the opermation mode. The operation modes are encoder / decoder.

cur_preset Provide the current presetting values.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the password for the login user.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Logout from the system and update in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

Authorization Get the permission level.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Add/Update the overlay values in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

rgn_idx Index to map overlay to.

​type Type of overlay to be used possible values: text or png.

source In the case of text overlay this would be the source text for png overlay this is the path to the png on the encoder. Images must be uploaded to board to be used.

location This is the location of the overlay. Possible values: 'top_left', 'top_right', 'top_center', 'bottom_left', 'bottom_right', 'bottom_center', 'x,y' (negative numbers not supported for x or y).

char_size For text overlay this is the character size. Possible values: 16,32,64, 128.

layer This will set the layer for the overly higher numbers will overlay over lower numbers if overlapping.

alpha Sets the transparency of the text. Possible values: 0-255.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Stop overlay.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

rgn_idx ​Index of overly for this channel.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Send absolute move command to the PTZ.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position and speed value. The mode values can be PanTilt / Zoom / Both.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Send PTZ auxiliary value to the PTZ.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position and speed value.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Remove the Ptz preset values for the user.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position and speed value. The mode values can be PanTilt / Zoom / Both.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Send continous move command to the PTZ.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Send preset value to PTZ.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the new tour spot and update in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout, profile token.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Move the Ptz to the input position

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout, profile token.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Preset the Ptz based on the value.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout, profile token.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the ptz status and degree value from the ptz

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout, profile token.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Remove the ptz tour spot

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout, profile token.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the preseting value in the PTZ

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout, profile token.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Start the PTZ tour

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout, profile token.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Stop the PTZ

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the mode, position, speed value, ptz_timeout, profile token.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Delete the schedule jobs from the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

purgelist List of schedule jobs to be removed.

rowcnt Number of rows.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Read the operation mode. Whether its encoding / decoding. Stop the channel encoding and restart the board

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Saving the camera settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

zoom_direct_value Zoom value. Possible values: 0 (wide) to 0x7ac0 (full zoom)

white_balance_mode White balance mode. Default value is auto. Possible values: auto / manual / indoor/ one-push / auto trace / sodium lamp auto / sodium lamp fixed / sodium lamp outdoor.

color_gain color gain. Default value is 4. Possible values: Range from 0 (60%) to 14 (200%)

color_hue color hue. Default value is 7. Possible values: Range from 0 (60%) to 14 (200%)

chroma_suppress Chroma suppress. Default value is 1. Possible values: 0=none, 1, 2, 3

wb_manual_rgain_direct white balance manual red gain. Default value is 190. Possible values: 0 to 255

wb_manual_bgain_direct white balance manual blue gain. Default value is 190. Possible values: 0 to 255

optical_zoom_only optical zoom only. Default value is 0. Possible values: 0, 1

focus_direct_value focus direct value. Default value is 4096. Possible values: 0x1000 to 0xf000

manual_focus Manual focus. Default value is auto. Possible values: auto, manual

exposure_mode Exposure mode. Default value is 0. Possible values: 0 - Auto, 10 - Shutter Priority, 11 - Iris -Priority, 3 - Manual.

shutter Shutter. Default value is 7.

iris Iris. Default value is 0.

gain Gain. Default value is 0.

high_sensitivity high sensitivity value. Default value is 3. Possible values 0, 1.

hlc_level hlc level. Default value is 0. Possible values in range 0 to 3.

hlc_level_mask mask value of hlc level. Default value is 0. Possible values 0, 1.

stable_zoom stable zoom on or off. Default value is off.

eflip Default value is 5. Possible values 0, 1.

lr_reverse Default value is 0. Possible values 0, 1.

monitor_mode Default value is 1080p-59.94.

genlock_source Default value is 2.

zoom_step_size Default value is 4. Possible values in range (1 - 7).

focus_step_size Default value is 1. Possible values in range (0 - 7).

manual_icr Default value is Off. Possible values: On, Off, Auto, Auto Color

img_freeze Default value is 0. Possible values: 0, 1.

hr_mode High resolution mode. Default value is 0. Possible values: 0, 1.

img_stabilizer Default value is 0. Possible values 0, 1.

img_bw Image black white. Default value is 0. Possible values 0, 1.

nr_2d_level Default value is 5. Possible values in range (0 - 5).

nr_3d_level Default value is 4. Possible values in range (0 - 5).

icr_threshold Default value is 14. Possible values in range (0-255 for 4K camera, 0-28 for HD camera).

slow_shutter Default value is 0. Possible values: 0, 1.

slow_shutter_limit Default value is 4. Possible values in range: (1 to 6)

flicker_reduction Default value is 0. Possible values: 0, 1.

img_stabilizer_level Default value is 0. Possible values: 0, 2.

wide_dynamic_range Default value is 3.

ve_brightness Default value is 3. Possible values in range: 0, 6.

ve_compensation_type Default value is 2. Possible values in range: 0, 3.

ve_compensation_level Default value is 1. Possible values in range: 0, 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save color pallete settings of boson camera in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

color_pallette Color pallete. Default value is whitehot.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save color pallete settings of DRS Tamarisk camera in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

color_pallette Color pallete. Default value is whitehot.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Saving camera link settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

pxl_format Pixel format. Default value is 1.

color_table Color table. Default value is whitehot.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Saving camera Lx settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

SONY_ExposureMode Exposure Mode. Default value is 32852. Possible values: 32848 (Program Auto), 32849 (Aperture Priority), 32850 (Shutter Priority), 32851 (Manual Exposure), 32852 (Intelligent Auto).

SONY_ShutterSpeed Shutter speed. Defualt value is NULL.

SONY_ISO ISO. Defualt value is NULL.

SONY_ExposureComp Exposure comp. Defualt value is NULL.

SONY_WhiteBalance White balance. Defualt value is NULL.

SONY_ColorTemp Color temperature. Defualt value is NULL.

SONY_APS_C APS_C. Defualt value is NULL.

SONY_NtscPalSelect NTSC / PAL selection. Defualt value is NULL.

SONY_MovieSteadyMode Movie steady mode. Defualt value is NULL.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Saving camera TAU settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

color_table color table value .

is_active Active/Deactive. Default value is 0.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save the schedule jobs in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the schedule activities..

rowcnt Get the number of row count.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Check the operation mode whether its in encoder or decoder. Save the preseting value of the mode in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

dec_current_preset Save the decoder current preseting values.

enc_current_preset Save the encoder current preseting values.

preset Settings for encoder or decoder.

enc_channels Number of channels. Maximum number of channels is 2 for decoder and 4 for encoder.

opmode Operation mode. Default is Encoder. Possible values: Encoder / Decoder.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save the state, preset, encoder/decoder settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

enc_current_preset Get the encoder preseting values for the current channel.

dec_current_preset Get the decoder preseting values for the current channel.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save the encoder advance settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

enc_adv_setting Get the encoder advance setting values.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the wifi and its password.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

passwd Get the wifi password

passwden Get wifi enable / disable. Default value is disable.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save the audio input settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

aport Get the audio port. Default value is MIC. Possible values are MIC , MICL

analog_gain_db Get the analog gain decibal value. Default value is 0. The value ranges are -97 to 30.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save the color table and pixel format values in the Database and set the color table and pixel format in the fpga.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

val Get the value for color table and pixel format.

opt The options are color table and pixel format.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the console value as ttyAMA0 or none.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

console_enable Get console value is enabled / disabled.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the Dynamic Domain Name System settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

ddns_enable Get the ddns enable value. Default value is Off. Possible values; (On, Off)

ddns_provider Get the ddns provider. Default value is freedns. Possible values: (freedns, freemyip, dyn, domains.google.com, duckdns.org, no-ip.com, tunnelbroker.net, dynv6.com, cloudxnv.net, dnspod.cn, cloudflare.com).

ddns_username Provide the username.

ddns_password Provide the password.

ddns_hostname Hostname for DDNS login.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the logging level. The setting is persistent.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

sysdebuglevel Get the system debug level. Possible values 0=None, 1=Error, 2=Information, 3=Diagnostics, 4=Codeflow, 5=Dataflow.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the device name in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

sysdevicename Get the system device name.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Controls composite output (passthru video from camera).

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

disp_std Get display standard for encoder. Default value is Auto.

disp_input Get display input for encoder. Default value is MACRO_DEFAULT_DISP_INPUT.

save_only Possible values: (True / False)

disp_layout Display layout for decoder. Default value is 1×1.

disp_mode Display mode for decoder. Default value is UltraHD.

disp_std2 Display standard for decoder. Default value is auto.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the DSCP configuration settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

diff_serve Get the DSCP configuration value. Default value is 0x00. Possible values are ( 0x00, 0xB8, 0x88, 0x90, 0x98, 0x80, 0x68, 0x70, 0x78, 0x60, 0x48, 0x50, 0x58, 0x28, 0x30, 0x38, 0x01).

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the fpga settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

fpgafileglob Get fpga value. Possible values are (boson / cvbs / tamarisk / tau2).

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Control networking settings of the Z3 device such as local IPv4 IP address, netmask, etc. Additionally control Encoder Auto-Start after boot-up and enable/disable showing of advanced WebUI settings.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

do_autostart Control automatic stream start after bootup. Possible values: 1 = do autostart 0 = do not autostart.

enc_adv_setting Control appearance of advanced settings on WebUI. Possible values: off, on.

ipmtu Control Ethernet IP Maximum Transmission Unit (MTU) size in bytes. Possible values: 576 to 1500.

eth_speed Control Gigabit Ethernet auto-negotiation allowed speeds. Possible values: AUTO, AUTO-100, 1000, 100, 10.

eth_duplex Control Ethernet auto-negotiation allowed duplex. Possible values: AUTO, FULL, HALF.

local_ip IPv4 address.

local_netmask IPv4 netmask.

default_gw IPv4 default gateway.

local_dnsip DNS server primary.

local_dnsip2 DNS server secondary.

use_dhcp Controls use of DHCP or static IP. Possible values: 1 (DHCP enabled), 0 (DHCP disabled, use static IP).

local_hostname Network hostname.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the login limit settings in the Database

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

maxlogin mximum number of login limit. Possible value in range (3 to 99 ).

login_window Login window period, the value are considered in seconds. Possible value in range (60 to 32768).

lockout_interval Lockout interval values are mentioned in seconds, which is used when maximum number of login limit is reached. Possible value in range (-1 to 32768)

login_timeout Login timeout

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the NFS settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

nfs_enable Enable/Disable nfs

nfs_server Get the nfs server ip address. Default is 192.168.1.6

nfs_server_root Get the server root path / location.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set SNTP (Simple Network Time Protocol) settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

enable Enable/Disable SNTP. Possible value: true, false. Default value true.

servers NTP server or list of NTP servers.

timezone Linux TZ database value for Timezone.

timezone_name Name for a time zone. Default is America/Chicago.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the SNMP settings in the database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

power_trap_en Enable/Disable power trap.

input_loss_trap_en Enable/Disable input loss trap.

input_recover_trap_en Enable/Disable input recover trap.

temp_high_trap_en Enable/Disable temp high trap.

temp_recover_trap_en Enable/Disable temperature recover trap.

trap_hosts Trap hosts ipaddress. Default ip address value is 192.168.0.6.

high_temp_suppress hiigh temperature. Default value is 30.

nominal_temp_suppress nominal temperature default value is 30.

snmp_v3_en Enable/Disable SNMP

snmp_v3_encrypt SNMP v3 encrypt value.

snmp_v3_user z3user.

snmp_v3_passwd z3password.

snmp_v3_usrpro snmp v3 usrpro default value is md5.

snmp_v3_encrypt_passwd z3password.

snmp_v3_encpro decrypt value.

snmp_v3_engineid Default value for engineid is 0.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save the GPS NMEA enable/disable value in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

nmea_enable Enable/Disable the NMEA. Possible value: on, off.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save the ONVIF settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

fixed_profile_max Get the Maximum ONVIF profiles to allow (1 or 2).

en_persistent_audio Enable/Disable ONVIF persistent audio channel.

onvif_enable Enable/Disable ONVIF.

list_all_video_sources List all the video source.

ptz_timeout Get the PTZ timeout values.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save the ONVIF video motion detection and too darkness settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

vmd_enable Enable/Disable video motion detection.

vmd_sens sensitivity value required for vmd. Possible value in range: (1 to 100).

vmd_zone_modify Enable/Disable video motion and too darkness zone coordinates.

vmd_vcrop_width crop width of the coordinates.

vmd_vcrop_height crop height for VMD and too_darkness.

vmd_vcrop_x crop startx for VMD and too_darkness.

vmd_vcrop_y crop starty for VMD and too_darkness.

td_enable Enable/Disable too darkness.

td_thresh Threshold value for too darkness. Possible values in range: 1 to 100.

vmd_td_channel Get the channel number. Possible values: 1, 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the RTSP settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

rtspd_port Get rtsp port. Default value is 554.

rtspd_timeout Timeout value required for the rtsp connection.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Sett the term server value in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

termserve_remote_enable Enable/Disable remote access to terminal server. Possible values are : on, off.

termserve_shared_enable Enable/Disable shared access to terminal server. Possible values are : on, off.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the video group configuration settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

group Video config groups. Default value 0.

nr_enable Enable / Disable NR. Default value is on. Possible value: on/off.

crop_enable Enabled / Disable the crop.

crop_x Crop x coordinates.

crop_y Crop y coordinates.

crop_width Crop width

crop_height Crop height

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the view port for the decoder and update in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

viewport viewport settings. The default value is fit.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the ViVpss mode settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

enc_vivpss_mode_enable Enable/Disable the vivpss mode. Default value is off. Possible values: on, off.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Set the wifi network settings in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

ssid Get the Wifi service set identifier value.

psk Get the Wifi password.

wifi_client_local_ip Local IP addres.

wifi_client_local_local_netmask Subnet mask for Wifi network.

wifi_client_default_gw Default Gateway be used for Wifi Network.

wifi_client_use_dhcp DHCP server used with Wifi network for DNS resolutions.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Save ZFinder enable / disable in the Databse.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

zfinder_enable Get ZFinder enable/disable value. Possible values: off, on

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Start the encoder channel and update the state as running in the Database. Once you start the channel, it will not transmit data until the video input is detected.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

actv_preset

vsource video source. Default value is Camera1. Possible values: Camera1 / Camer2 / HDMI1.

vres video resolution. Default value is Follow Input. Possible values: Follow Input, 3840 x 2160, 1920 x 1080, 1440 x 1080, 1280 x 1024, 1280 x 720, 1024 x 768, 960 x 720, 1024 x 576.

vcodec video codec. Default value is H265. Possible values: H265, H264, MJPEG, none.

vgdr video gradual data refresh. Default value is on. Possible value on, off.

vprofile video profile. Default value is high. Possible value high, main, baseline.

vratectrl video rate control. Default value is cbr. Possible value cbr, vbr.

vbitrate video bit rate.

vframeratediv video frame rate. Default value is 1. Possible values: 1 (Full), 2 (Half), 4 (Quarter), 6 (Sixth).

vgopsize video group of picture size. Default value is 60. Possible values: 1 (1 Frame Only), 5 (5 Frames), 8 (8 Frames), 10 (10 Frames), 12 (12 Frames), 15 (15 Frames), 25 (25 Frames), 30 (30 Frames), 50 (50 Frames), 60 (60 Frames), 90 (90 Frames), 100 (100 Frames), 120 (120 Frames), 200 (200 Frames), 240 (240 Frames).

vprotocol video protocol.

vdest video destination port.

vpid video packet identifier. Default value is 221.

vdelay video delay. Default value is 300.

pcrpid PCR packet identifier. Default value is 521.

pcrinterval Default value is 50.

pmtpid program map table packet identifier. Default value is 31.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Start the MTS.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Stop the encoder channel and update the state in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Stop the MTS.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the current temperature status for CPU and lense.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Update/Change whether web login credential required or not in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

require Required web login value. Possible values: 1 or 0

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Update the PTZ value in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the PTZ values.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Update the PTZ preset value in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the PTZ preset values.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Update the PTZ tour spots value in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the PTZ tour spots values.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Control serial port terminal server for VISCA

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the terminal server values.

term_mode Possible values: client, server

term_protocol Possible values: clearchannel, telnet

term_localport Local TCP port (for server mode)

term_servaddr Remote IP address (for client mode only)

term_servport Remote TCP port (for client mode only)

term_data_bits number of data bits.

term_parity Possible values: None, Odd, Even, Mark, Space

term_stop_bits Stop bits sent at the end of every character.

term_baudrate Possible values: 9600, 19200, 38400, 57600, 115200

term_devicefile device fine name

term_function functionality

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Add a new user in the Database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

Name Get new user name

Level Get the level of permission for the new user name. Possible value: 0 to 7.

Password Get the password for the new user name.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Remove the user from the database.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the user name.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Update/change the level of permission to the given user name.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the user name and level of the permission.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Update/change the password to the given user name.

chn Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

data Parse the JSON formatted data and retrieve the user name and password.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, 1 on failure.

status String describing the failure when ret is 1. “OK” on success.

Get the exthernet 802x information from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

interface TEXT,

enable TEXT.

eap TEXT.

anonymous_identity TEXT.

identity TEXT.

password TEXT.

private_key_password TEXT.

Get the schedule job from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

enable INTEGER,

cron TEXT.

func TEXT.

func_args TEXT.

type TEXT.

minutes INTEGER.

hours INTEGER.

day INTEGER.

month INTEGER.

cron TEXT.

Get the Network File Sharing mounted infromation from the device.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

mounted TEXT,

Get the video resolution for the current channel from the Database and calculate the aspect ratio.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

numerator INTEGER,

denominator INTEGER.

Get the board and model information from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

logo_enable TEXT,

logo_filename TEXT.

logo_width INTEGER.

logo_height INTEGER.

logo_blob BLOB.

ico_blob BLOB.

model_enable TEXT.

model_name TEXT.

Get the current camera state information from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

preset TEXT,

enc_channels TEXT.

opmode TEXT.

enc_current_preset TEXT.

dec_current_preset TEXT.

Get the current camera settings from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

zoom_direct_value INTEGER.

white_balance_mode TEXT.

color_gain INTEGER.

color_hue INTEGER.

chroma_suppress INTEGER.

wb_manual_rgain_direct INTEGER.

wb_manual_bgain_direct INTEGER.

visca_localport TEXT.

optical_zoom_only BOOL. 0 or 1.

focus_direct_value INTEGER.

manual_focus TEXT.

flexio_localport TEXT.

exposure_mode INTEGER.

shutter INTEGER.

iris INTEGER.

gain INTEGER.

high_sensitivity INTEGER.

hlc_level INTEGER.

hlc_level_mask INTEGER.

stable_zoom INTEGER.

eflip INTEGER.

lr_reverse INTEGER.

monitor_mode TEXT.

genlock_source INTEGER.

manual_icr TEXT.

zoom_step_size INTEGER.

focus_step_size INTEGER.

img_freeze INTEGER.

hr_mode INTEGER.

img_stabilizer INTEGER.

img_bw INTEGER.

nr_2d_level INTEGER.

nr_3d_level INTEGER.

icr_threshold INTEGER.

slow_shutter BOOL. 0 or 1.

slow_shutter_limit INTEGER.

flicker_reduction BOOL. 0 or 1.

img_stabilizer_level INTEGER.

wide_dynamic_range TEXT.

ve_brightness TEXT.

ve_compensation_type TEXT.

ve_compensation_level TEXT.

tab_index TEXT.

imgvflip INTEGER.

imghflip INTEGER.

imgrotate INTEGER.

Get the current camera exposure values from the visca command.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

ae_mode TEXT,

shutter TEXT.

iris TEXT.

gain_inquiry TEXT.

sensitivity TEXT.

hls_inquiry TEXT.

min_shutter INTEGER.

max_shutter INTEGER.

shutter_label TEXT.

min_iris INTEGER.

max_iris INTEGER.

iris_label TEXT.

min_gain INTEGER.

max_gain INTEGER.

gain_label TEXT.

Get the current camera monitor mode values from the visca command.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

modes TEXT.

current_mode TEXT.

Get the current decoder settings from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

preset TEXT.

channel INTEGER.

url TEXT.

aenable TEXT.

viewport TEXT.

latency_mode TEXT.

max_latency_ms TEXT.

srt_mode TEXT.

srt_latency TEXT.

srt_decrypt TEXT.

srt_pass TEXT.

zixi_fec TEXT.

zixi_fecoverhead TEXT.

zixi_fecblock TEXT.

zixi_latency TEXT.

zixi_decrypt TEXT.

zixi_pass TEXT.

rtsp_flags TEXT.

Get the downloaded file information from the removable storage media.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

job Optional. The job from the schedule tab.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

FileName TEXT.

FileSize TEXT.

LastModified TEXT.

Get the camera model of drs tamarisk settings fromt the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

job Optional. The job from the schedule tab.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

color_pallette TEXT.

tab_index TEXT.

color_pallette_disabled TEXT.

Get the current channel encoder settings from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

preset TEXT,

channel INTEGER.

vbitrate TEXT.

vframeratediv INTEGER.

vsource TEXT.

vcodec TEXT.

vprofile TEXT.

vprotocol TEXT.

avmux_index TEXT.

vgdr TEXT.

vdest TEXT.

aenable TEXT.

acodec TEXT.

abitrate TEXT.

asamplerate TEXT.

aport TEXT.

apair INTEGER.

vres TEXT.

vgopsize INTEGER.

vpid INTEGER.

apid INTEGER.

zixiauthen TEXT.

zixisession TEXT.

zixiuser TEXT.

zixioverhead TEXT.

zixifecblock TEXT.

zixilatency TEXT.

zixirateadjen TEXT.

fecrow INTEGER.

feccol INTEGER.

feconoff TEXT.

aptspcr INTEGER.

tslowlat TEXT.

tsrate TEXT.

pcrpid INTEGER.

pcrinterval INTEGER.

pmtpid INTEGER.

klvenable TEXT.

klvmode TEXT.

klvmuxmethod TEXT.

klvsrc TEXT.

klvbrate TEXT.

klvserialbaud TEXT.

klvpid TEXT.

vratectrl TEXT.

vdelay INTEGER.

storage TEXT.

fprefix TEXT.

asource TEXT.

authonoff TEXT.

auth_user TEXT.

auth_passwd TEXT.

auxonoff TEXT.

filesize TEXT.

nfstrength TEXT.

telopenable TEXT.

teloptext TEXT.

teloplocation TEXT.

telopcharsize TEXT.

teloptextcolor TEXT.

telopoutlineenable TEXT.

telopoutlinecolor TEXT.

gps_overlay_enable TEXT.

gps_overlay_device TEXT.

gps_overlay_location TEXT.

gps_overlay_char_size TEXT.

pipenable TEXT.

piplocation TEXT.

vquality TEXT.

vinterlacemode TEXT.

vmulticastdest TEXT.

amulticastdest TEXT.

rtsp_auth_enable TEXT.

rtsp_auth_username TEXT.

rtsp_auth_password TEXT.

rtsp_transport_mode TEXT.

lowdelay_opt TEXT.

vcropaspect TEXT.

vcrop_enable TEXT.

vcrop_width INTEGER.

vcrop_height INTEGER.

vcrop_x INTEGER.

vcrop_y INTEGER.

rotate_enable INTEGER.

rotate_angle INTEGER.

rtmp265_enable TEXT.

srt_pass TEXT.

srt_encrypt INTEGER.

srt_mode INTEGER.

srt_destAddr TEXT.

mmulticastdest TEXT.

mport TEXT.

frame_loss_mode TEXT.

frame_loss_gap INTEGER.

frame_loss_overshot INTEGER.

mounts TEXT.

source_status_str TEXT.

Get the file type and its information from the removable storage media.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

filepicker_filename TEXT,

filepicker_size INTEGER.

filepicker_lastmodified TEXT.

Get the removable storage infromation from the device using fdisk command.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

mounts TEXT,

Get the current camera focus step values from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

focus_step_size INTEGER,

Get the current fpga information from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

fpgafileglob TEXT,

options TEXT.

Get the decoder history infromation from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

channel TEXT,

histidx TEXT.

url TEXT.

Get the internet protocol infromation from the board.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

local_ip TEXT,

local_netmask TEXT.

default_gw TEXT.

ipmtu TEXT.

eth_speed TEXT.

eth_duplex TEXT.

do_autostart BOOLEAN.

Get the ONVIF miscallenous settings from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

list_all_video_sources INTEGER,

dns_from_dhcp INTEGER,

ntp_from_dhcp INTEGER,

ntp_enable INTEGER,

daylightsaving INTEGER,

timezone TEXT.

http_enable INTEGER,

http_port INTEGER,

https_enable INTEGER,

https_port INTEGER,

rtsp_enable INTEGER,

rtsp_port INTEGER,

discoverable INTEGER,

ntp TEXT.

dns_search TEXT.

ptz_timeout TEXT.

primary fixed_profile_max INTEGER,

secondary fixed_profile_max INTEGER,

en_persistent_audio TEXT.

onvif_enable BOOLEAN.

vmd_enable BOOLEAN.

Get the ONVIF video motion detection and too darkness settings from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

vmd_sens INTEGER,

vmd_zone_modify TEXT.

vmd_vcrop_width INTEGER.

vmd_vcrop_height INTEGER.

vmd_vcrop_x INTEGER.

vmd_vcrop_y INTEGER.

td_enable TEXT.

td_thresh INTEGER.

vmd_td_channel TEXT.

Get the current permission settings for admin, operators, and users from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

username TEXT,

userlevel TEXT.

api_command TEXT.

superadmin TEXT.

admin TEXT.

operator1 TEXT.

operator2 TEXT.

user1 TEXT.

user2 TEXT.

user3 TEXT.

anonymous TEXT.

Get the current PTZ settings from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

token TEXT,

node TEXT.

name TEXT.

enabled BOOLEAN.

pelcoaddr INTEGER.

tcpport INTEGER.

ptztype TEXT.

flip TEXT.

pos TEXT.

maxtilt INTEGER.

Get the PTZ preseting values from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

profiletoken TEXT,

token TEXT.

name TEXT.

pan FLOAT.

tilt FLOAT.

zoom FLOAT.

Get the PTZ tour information from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

ProfileToken TEXT,

PresetTourToken TEXT.

name TEXT.

autostart BOOLEAN.

RecurringTime INTEGER.

RecurringDuration TEXT.

PresetTourDirection INTEGER.

RandomPresetOrder BOOLEAN.

ProfileToken TEXT.

PresetTourToken TEXT.

RowIndex INTEGER.

PresetDetailToken TEXT.

PresetDetailHome BOOLEAN.

StayTime TEXT.

pan FLOAT.

tilt FLOAT.

zoom FLOAT.

pspeed FLOAT.

tspeed FLOAT.

zspeed FLOAT.

Get the Simple Network Management Protocol values from the Database

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

power_trap_en INTEGER,

input_loss_trap_en INTEGER.

input_recover_trap_en INTEGER.

temp_high_trap_en INTEGER.

temp_recover_trap_en INTEGER.

high_temp INTEGER.

nominal_temp INTEGER.

high_temp_suppress INTEGER.

nominal_temp_suppress INTEGER.

trap_hosts INTEGER.

snmp_v3_en INTEGER.

snmp_v3_user TEXT.

snmp_v3_passwd TEXT.

snmp_v3_usrpro TEXT.

snmp_v3_encrypt INTEGER.

snmp_v3_encrypt_passwd TEXT.

snmp_v3_encpro TEXT.

snmp_v3_engineid TEXT.

Get the Secure Socket Layer settings from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

https_enable TEXT,

http_enable TEXT.

https_port INTEGER.

http_port INTEGER.

cert_status TEXT.

key_status TEXT.

Get the available memory infromation from the device.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

mem_free_kb TEXT,

Get the current system settings from the Database and the ip information from the device.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

local_ip TEXT,

local_netmask TEXT.

preset TEXT.

enc_channels TEXT.

opmode TEXT.

username TEXT.

userlevel TEXT.

do_autostart BOOLEAN.

syspassword TEXT.

session_id TEXT.

disp_std TEXT.

disp_std2 TEXT.

disp_input TEXT.

disp_mode TEXT.

disp_layout TEXT.

enc_adv_setting TEXT.

enc_vivpss_mode_enable TEXT.

enable_sntp TEXT.

sntp_servers TEXT.

enable_snmp TEXT.

sysdevicename TEXT.

timezone TEXT.

timezone_name TEXT.

termserve_remote_enable TEXT.

termserve_shared_enable TEXT.

zfinder_enable TEXT.

diff_serve INTEGER.

enable_ptp TEXT.

ptp_role TEXT.

nmea_enable TEXT.

nfs_enable TEXT.

nfs_server TEXT.

nfs_server_root TEXT.

ddns_enable TEXT.

ddns_provider TEXT.

ddns_username TEXT.

ddns_password TEXT.

rtspd_port INTEGER.

rtspd_timeout INTEGER.

maxlogin INTEGER.

login_window INTEGER.

lockout_interval INTEGER.

login_timeout INTEGER.

require_web_login BOOLEAN.

Get the remote terminal information from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

term_mode TEXT,

term_protocol TEXT.

term_localport TEXT.

term_servaddr TEXT.

term_servport TEXT.

term_data_bits TEXT.

term_parity TEXT.

term_stop_bits TEXT.

term_baudrate TEXT.

term_devicefile TEXT.

term_function TEXT.

Get the ONVIF user information and the permission level from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

Name TEXT,

Level INTEGER.

Password TEXT.

Password_MD5 TEXT.

Password_SHA256 TEXT.

Password_SHA512_256 TEXT.

Get the current video group settings from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

vgroup INTEGER.

crop_enable TEXT.

crop_width INTEGER.

crop_height INTEGER.

crop_x INTEGER.

crop_y INTEGER.

nr_enable TEXT.

Get the Wifi details from the device and wifi client information from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

networks TEXT,

cur_network TEXT,

cur_pass TEXT,

ap_pass TEXT,

ap_pass_en BOOLEAN.

ap_ssid TEXT,

wifi_client_local_ip TEXT,

wifi_client_local_netmask TEXT.

wifi_client_default_gw TEXT.

wifi_client_use_dhcp BOOLEAN.

Get the current camera zoom step values from the Database.

chn Optional. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.

JSON formatted table with values below

ret Custom return code of the HTTP POST request. 0 on success, -1 on failure.

zoom_step_size INTEGER,

Write encoder settings to active preset. See Python example code for Seting Configuration below

Requests an update to encoder_status_str variable.

To read the result, you need to POST the “stats” control as shown\ in the Python example code below.

Requests an update to stream_status_str variable.

To read the result, you need to POST the “stats” control as shown\ in the Python example code below.

Requests an update to astream_status_str variable.

To read the result, you need to POST the “stats” control as shown\ in the Python example code below.

Requests an update to source_status_str variable.

To read the result, you need to POST the “stats” control as shown\ in the Python example code below.

To set the encode configuration per channel the SetEncoder action is used with a post. All variables should be present or they will be replaced with a defualt that may not be valid for your application. More than one channel can be set per command. It is recommended you first read the current settings from the encoder then modify them and send the new settings back as in the Python example below:

import requests, json, sys

server_url='http://192.168.0.120/cgi-bin/control.cgi'
channel = 1

enc_cfg = requests.get(server_url, params='ctrl=enc&chn={}'.format(channel))
print enc_cfg.json()

enc_cfg_json=enc_cfg.json()
enc_cfg_json['vframeratediv'] = 2 #set frame rate divider to 2
new_cfg = {}
new_cfg['action'] = 'SetEncoder'
for key, value in enc_cfg_json.iteritems():
   print "key = {} value = {}".format(key,value)
   new_idx = "enc_{}_{}".format(channel,key)
   print "setting {} to {}".format(new_idx,value)
   new_cfg[new_idx] = value

print new_cfg
requests.post(server_url, data=new_cfg)

http://<ENCODER_IP>/snapshot.cgi?size=3840x2160&quality=100

http://<ENCODER_IP>/snapshot.cgi?chn=1&size=1280x720&quality=80

valid options are:

• *size =[any supported valid resolution]

chn =[1,2]

  quality** =[0-100] supported resolutions are: 4K Models Only 3840×2160 \\
  2560×1440 4K and HD Models 1920×1080 \\
  1440×1080 \\
  1280×1024 \\
  1280×720 \\
  1024×768 \\
  960×720 \\
  1024×576 \\
  800×600 \\
  720×576 \\
  704×576 \\
  720×480 \\
  640×512 \\
  640×480 \\
  640×360 \\
  352×576 \\
  420×380 \\
  352×288 \\
  352×240 \\
  336×256 \\
  320×240 \\
  320×180 **

Python example of updating and reading encoder statistics:

import requests, json, sys
server_url='http://192.168.0.120/cgi-bin/control.cgi'

requests.post(server_url, {'action': 'EncoderStatus'} )
requests.post(server_url, {'action': 'StreamStatus'}  )
requests.post(server_url, {'action': 'AStreamStatus'} )
requests.post(server_url, {'action': 'SourceStatus'}  )
requests.post(server_url, {'action': 'TempStatus'}    )

print requests.get(server_url, params='ctrl=stats&chn=null').json()

Example output:

{u'status': u'OK',
 u'astream_status_str': u'\tChannel 6 Codec fdk_aaclc Samplerate 48000 Input MICL Frames 32287820  OK',
 u'temp_status_str': u' LENS 29  CPU 78.700  FPGA 89.8  OK',
 u'ret': u'0',
 u'encoder_status_str': u'   *** Encode Bitstream Received Statistics ***    CH | Bitrate (Kbps) | Actual Bitrate | FPS  | Actual FPS | Key-frame FPS | Width | Height   ------------------------------------------------------------------------------------------------------------
                       1 |        4000.00 |        4092.18 | 60.0 |     59.8 |           1.0 |  1920 |   1080  |  OK',
 u'source_status_str': u' CAMERA 1920x1080p 60.00 fps\n',
 u'stream_status_str': u'Channel 1 URL rtsp Frames 12883581  OK'}

By default, no authentication is required to access the HTTP API.

To enable authentication, go to the “System” tab “Device Management” section. Click on the “Set Password” button.

The username will be “admin” The authentication method is HTTP Digest authentication. HTTP Basic authentication is not supported.

import requests,json, sys
from requests.auth import HTTPDigestAuth

auth=HTTPDigestAuth('admin','mypassword')

print requests.get(server_url, params='ctrl=stats&chn=null', auth=auth).json()