Powered by Redocly

SetUp

Set up re-calibrate

Request camera recalibration between DMS and ADAS.

Securityapi key and Authorization
Request
path Parameters
serial_number
required
string

serial number or cid(certificate id)

Responses
200

OK

post/V2/device/{serial_number}/setup/re-calibrate
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": {
    }
}

Set up camera height

Used to set the camera height.

Securityapi key and Authorization
Request
path Parameters
serial_number
required
string

serial number or cid(certificate id)

Request Body schema:
camera_height
required
integer <int32> [ 120 .. 300 ]
Responses
200

OK

post/V2/device/{serial_number}/setup/camera-height
Request samples
{
  • "camera_height": 120
}
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": {
    }
}

Set up installation location

This API allows users to specify the installation position of a dashcam. The location can be set for left-hand drive vehicles, right-hand drive vehicles.

• Left：The dashcam is installed on the left side of the vehicle, suitable for left-hand drive vehicles.

• Right：The dashcam is installed on the right side of the vehicle, suitable for right-hand drive vehicles.

Securityapi key and Authorization
Request
path Parameters
serial_number
required
string

serial number or cid(certificate id)

Request Body schema:
location
required
string (LocationEnum)

Left

Right

Enum: "Left" "Right"
Responses
200

OK

post/V2/device/{serial_number}/setup/install-location
Request samples
{
  • "location": "Left"
}
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": {
    }
}

Set up DMS Camera

Specifies the type and installation location of the DMS camera.

Securityapi key and Authorization
Request
path Parameters
serial_number
required
string

serial number or cid(certificate id)

Request Body schema:
facing
required
string non-empty

Specifies the type of the DMS camera.
Enum:

  • Embedded
  • UVC
location
string or null
Default: "Center"

Specifies the installation location of the DMS camera. Enum:

  • Center

This parameter is only applicable when facing is set to UVC.
If facing is set to Embedded, this value will be ignored and automatically replaced with the one defined in [Set up installation location] (/tag/SetUp#operation/SetUpInstallLocation).

When facing is Embedded, this value will always be equal to install_position.

Requires Camera App version 11.2.24.30 or above.

Responses
200

OK

post/V2/device/{serial_number}/setup/dms-camera
Request samples
{
  • "facing": "string",
  • "location": "Center"
}
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": {
    }
}

Set up Device and DMS Camera

Set up both the device installation location and the DMS camera at the same time.
This endpoint is only available for devices running Camera App version 11.2.24.30 or above.
Devices with an older version will not be able to access this API.

Securityapi key and Authorization
Request
path Parameters
device
required
string

serial number or cid(certificate id)

Request Body schema:
device_location
required
string non-empty

Specifies the installation location of the device. Supported values:

  • Left
  • Right
dms_camera_type
required
string non-empty

Specifies the type of the DMS camera. Supported values:

  • Embedded
  • UVC

The Embedded type is only available for devices equipped with front and rear (dual) cameras.
The following device models support the Embedded option:

  • K245
  • K245C
  • K220
  • K265

For devices with only a single camera or models not listed above, only UVC is supported.

dms_camera_location
string or null

Specifies the installation location of the DMS camera. Enum:

  • Center

This parameter is required only when dms_camera_type is set to UVC.
When dms_camera_type is set to Embedded, this parameter is ignored.

When facing is Embedded, this value will always be equal to device_location.

Responses
200

OK

post/V2/device/{device}/setup/device-and-dms-camera
Request samples
{
  • "device_location": "string",
  • "dms_camera_type": "string",
  • "dms_camera_location": "string"
}
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": {
    }
}
➔ Next to SmartGo