MOBOTIX Online Help

The HTTP API

The HTTP API (Application Programming Interface) is a software interface to the camera and allows to conveniently integrate the camera into a centralized management system. The interface consists of two CGI scripts that can be called with parameters and values using HTTP commands. By means of these scripts, you can modify the settings of the Setup submenus and execute certain camera functions.

Using the HTTP command http://10.160.139.50/control/control, you can modify the settings of the Setup menu.

Executing Camera Functions

Using the HTTP command http://10.160.139.50/control/rcontrol, you can execute certain camera functions.

Command Conventions

Command With one Instruction

If you would like to use the list instruction with the control command, you need to separate the instruction from the command using a ?:
   http://10.160.139.50/control/control?list

Command With one Instruction and a Parameter/Value Pair

In order to execute an instruction with a parameter, the instruction needs to be separated from the parameter by an ampersand &. The parameter value is separated by a = sign.
   http://10.160.139.50/control/control?list&section=action

Command With one Instruction and Several Parameter/Value Pairs

If you would like to use multiple parameters, separate them using an ampersand &:
    http://10.160.139.50/control/rcontrol?action=ledson&time=5

Several Values for one Parameter

For some parameters you need to enter two values in order to address both lenses. These parameters are shown as having two default values (e.g. 0 0). In the http command, you will need to separate these values using a + sign :
   http://10.160.139.50/control/control?set&section=general&sharpen=0+0

Newline characters in commands

If you would to use one or more newline characters in a command (e.g. to set several video motion window definitions), you need to replace the newline characters using the CGI replacement string %0A.    http://10.160.139.50/control/control?set&section=general&
    coverimage_area=0,540,380,200,200,2%0A1,320,100,100,150,2

Special Characters in Commands

In order to display the CGI formatting strings themselves (newline, blank, umlauts, ...), enter the URL-encoded characters. To do this, enter a % sign followed by the hex value of the character you would like to display. The following table contains a list of the most common characters:

Table of Color Values

You may specify color values for certain parameters. These values correspond to the hex values of the red, green and blue (RGB) values of a specific color. Two characters each represent on color, 00 represents the lowest value (no color), FF represents the highest value (full color). As the colors are mixed additively, 0x000000 will be black and 0XFFFFFF will be white.

Example:

The control Command

First of all, you need to tell the camera which instructions are to be performed.

Instructions for the control Command

List of Available Sections

The sections shown in the following tables correspond to all dialogs that you can control remotely using the control command. Click on one of the following links to go to the corresponding section.

The imagecontrol section
The eventcontrol section
The exposurecontrol section
The general section
The exposure section
The color section
The jpeg section
The text section
The settings section
The event section
The eventfilter section
The eventlogic section
The recording section
The action section
The message section
The message2 section
The signalout section
The mxpegparam section
The quickcontrol section
The quickcontrolreset section
The imageprogram section
The audio section
The banksecurity section

Parameters for the imagecontrol Section

Enter the following command to see all parameters for this section:
http://10.160.139.50/control/control?list&section=imagecontrol