Cameras

Camera is a basic building block of Robopipe. It represent a single Luxonis device that can be manipulated through our API. Each camera corresponds to a real camera device and is independent of other devices. Camera can be connected via USB or Ethernet interface, the API doesn't make any distinctions regarding this matter. Camera is always addressed by its unique MXID.

API Reference

List Cameras

get
Responses
200
Successful Response
application/json
get
GET /cameras/ HTTP/1.1
Host: robopipe-1.local
Accept: */*
200

Successful Response

[
  {
    "mxid": "text",
    "name": "text",
    "camera_name": "text",
    "platform": "X_LINK_ANY_PLATFORM",
    "protocol": "X_LINK_ANY_PROTOCOL",
    "state": "X_LINK_ANY_STATE",
    "status": "text"
  }
]

Get Camera

get
Path parameters
mxidstringRequiredPattern: [A-Z0-9]+
Responses
200
Successful Response
application/json
get
GET /cameras/{mxid}/ HTTP/1.1
Host: robopipe-1.local
Accept: */*
{
  "mxid": "text",
  "name": "text",
  "camera_name": "text",
  "platform": "X_LINK_ANY_PLATFORM",
  "protocol": "X_LINK_ANY_PROTOCOL",
  "state": "X_LINK_ANY_STATE",
  "status": "text"
}

Create Camera

post
Path parameters
mxidstringRequiredPattern: [A-Z0-9]+
Responses
200
Successful Response
application/json
post
POST /cameras/{mxid}/ HTTP/1.1
Host: robopipe-1.local
Accept: */*
{
  "mxid": "text",
  "name": "text",
  "camera_name": "text",
  "platform": "X_LINK_ANY_PLATFORM",
  "protocol": "X_LINK_ANY_PROTOCOL",
  "state": "X_LINK_ANY_STATE",
  "status": "text"
}

Delete Camera

delete
Path parameters
mxidstringRequiredPattern: [A-Z0-9]+
Responses
200
Successful Response
application/json
delete
DELETE /cameras/{mxid}/ HTTP/1.1
Host: robopipe-1.local
Accept: */*
{
  "mxid": "text",
  "name": "text",
  "camera_name": "text",
  "platform": "X_LINK_ANY_PLATFORM",
  "protocol": "X_LINK_ANY_PROTOCOL",
  "state": "X_LINK_ANY_STATE",
  "status": "text"
}

Get Camera Stats

get
Path parameters
mxidstringRequiredPattern: [A-Z0-9]+
Responses
200
Successful Response
application/json
get
GET /cameras/{mxid}/stats HTTP/1.1
Host: robopipe-1.local
Accept: */*
{
  "chip_temperature": {
    "average": 1,
    "css": 1,
    "dss": 1,
    "mss": 1,
    "upa": 1
  },
  "cmx_memory_usage": {
    "total": 1,
    "used": 1,
    "remaining": 1
  },
  "ddr_memory_usage": {
    "total": 1,
    "used": 1,
    "remaining": 1
  }
}

Get Infrared Config

get
Path parameters
mxidstringRequiredPattern: [A-Z0-9]+
Responses
200
Successful Response
application/json
Responseany of
or
nullOptional
get
GET /cameras/{mxid}/ir HTTP/1.1
Host: robopipe-1.local
Accept: */*
{
  "flood_light": 0,
  "dot_projector": 0
}

Set Infrared Config

post
Path parameters
mxidstringRequiredPattern: [A-Z0-9]+
Body
flood_lightnumber · max: 1Optional

IR LED intensity. Value must be between 0.0 and 1.0

Default: 0
dot_projectornumber · max: 1Optional

Dot projector intensity. Value must be between 0.0 and 1.0

Default: 0
Responses
200
Successful Response
application/json
Responseany of
or
nullOptional
post
POST /cameras/{mxid}/ir HTTP/1.1
Host: robopipe-1.local
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "flood_light": 0,
  "dot_projector": 0
}
{
  "flood_light": 0,
  "dot_projector": 0
}

IR Perception

The PRO line-up of Luxonis devices has notch IR filters at 940nm on the stereo camera pair, which allows both visible light and IR light from illumination LED/laser dot projector to be perceived by the camera.

RGB cameras do not perceive IR light, only monochromatic sensors have IR perception.

Dot Projector

A laser dot projector emits numerous tiny dots in front of the device, aiding in disparity matching, particularly on surfaces with low visual features or texture, such as walls or floors. This method, known as ASV (Active Stereo Vision), functions similarly to passive stereo vision but incorporates active depth enhancement.

Flood IR (Led)

LED lighting enables visibility in environments with minimal or no light. It allows you to execute AI or computer vision (CV) tasks on frames illuminated by the infrared (IR) LED.

Get Infrared Config

get
Path parameters
mxidstringRequiredPattern: [A-Z0-9]+
Responses
200
Successful Response
application/json
Responseany of
or
nullOptional
get
GET /cameras/{mxid}/ir HTTP/1.1
Host: robopipe-1.local
Accept: */*
{
  "flood_light": 0,
  "dot_projector": 0
}

Set Infrared Config

post
Path parameters
mxidstringRequiredPattern: [A-Z0-9]+
Body
flood_lightnumber · max: 1Optional

IR LED intensity. Value must be between 0.0 and 1.0

Default: 0
dot_projectornumber · max: 1Optional

Dot projector intensity. Value must be between 0.0 and 1.0

Default: 0
Responses
200
Successful Response
application/json
Responseany of
or
nullOptional
post
POST /cameras/{mxid}/ir HTTP/1.1
Host: robopipe-1.local
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "flood_light": 0,
  "dot_projector": 0
}
{
  "flood_light": 0,
  "dot_projector": 0
}

Last updated