Skip to content

Latest commit

 

History

History
136 lines (127 loc) · 3.72 KB

WebAPI.md

File metadata and controls

136 lines (127 loc) · 3.72 KB
Raw

Accessing camera from other applications (WEB API)

The streamed camera can be accessed not only from web browser, but also from any other application supporting MJPEG streams (like VLC media player, for example, or different applications for IP cameras monitoring). The URL format to access MJPEG stream is:

http://ip:port/camera/mjpeg

In the case an individual image is required, the next URL provides the latest camera snapshot:

http://ip:port/camera/jpeg

Camera information

To get some camera information, like device name, width, height, etc., an HTTP GET request should be sent the next URL:

http://ip:port/camera/info

It provides reply in JSON format, which may look like the one below:

{
  "status":"OK",
  "config":
  {
    "device":"RaspberryPi Camera",
    "title":"My home camera",
    "width":"640",
    "height":"480"
  }
}

Changing camera’s settings

http://ip:port/camera/config

To get current camera’ settings, an HTTP GET request is sent to the above URL, which provides all values as JSON reply:

{
  "status":"OK",
  "config":
  {
    "awb":"Auto",
    "brightness":"50",
    "contrast":"15",
    "effect":"None",
    "expmeteringmode":"Average",
    "expmode":"Auto",
    "hflip":"1",
    "saturation":"25",
    "sharpness":"100",
    "vflip":"1",
    "videostabilisation":"0"
  }
}

In the case if only some values are required, their names (separated with coma) can be passed as vars variable. For example:

http://ip:port/camera/config?vars=brightness,contrast

For setting camera’s properties, the same URL is used, but HTTP POST request must be used. The posted data must contain collection of variables to set encoded in JSON format.

{
  "brightness":"50",
  "contrast":"15"
}

On success, the reply JSON will have status variable set to "OK". Or it will contain failure reason otherwise.

Getting description of camera properties

Starting from version 1.1.0, the cam2web application provides description of all properties camera provides. This allows, for example, to have single WebUI code, which queries the list of available properties first and then does unified rendering. The properties description can be optained using the below URL:

http://ip:port/camera/properties

The JSON response provides name of all available properties, their default value, type, display name and order. For integer type properties, it also includes allowed minimum and maximum values. And for selection type properties, it provides all possible choices for the property.

{
  "status":"OK",
  "config":
  {
    "hflip":
    {
      "def":0,
      "type":"bool",
      "order":8,
      "name":"Horizontal Flip"
    },
    "brightness":
    {
      "min":0,
      "max":100,
      "def":50,
      "type":"int",
      "order":0,
      "name":"Brightness"
    },
    "awb":
    {
      "def":"Auto",
      "type":"select",
      "order":4,
      "name":"White Balance",
      "choices":
      [
        ["Off","Off"],
        ["Auto","Auto"],
        ["Sunlight","Sunlight"],
        ...
      ]
    },
    ...
  }
}

Getting version information

To get information about version of the cam2web application streaming the camera, the next URL is used

http://ip:port/version

Which provides information in the format below:

{
  "status":"OK",
  "config":
  {
    "platform":"RaspberryPi",
    "product":"cam2web",
    "version":"1.0.0"
  }
}

Access rights

Accessing JPEG, MJPEG and camera information URLs is available to those who can view the camera. Access to camera configuration URL is available to those who can configure it. The version URL is accessible to anyone. See Running cam2web for more information about access rights.