Options
All
  • Public
  • Public/Protected
  • All
Menu
notexported

See type declaration

4k UHD Camera

Hierarchy

Index

Properties

brightness?: number

💡 Camera Brightness

Brightness Sample (Revolution/Pivot)

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/brightness/revolutionOcleaCamBrightnessSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"3AFD88334ABD": {
"model": 13,
"cameras": {
"212C31E9AD4E": {
"model": 206,
"brightness": 45
}
}
}
}
}
}

minimum

0

maximum

100

contrast?: number

Camera Contrast

Contrast Sample (Revolution/Pivot)

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/contrast/revolutionOcleaCamContrastSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"701F80AA3D1C": {
"model": 13,
"cameras": {
"04C223D01215": {
"model": 206,
"contrast": 45
}
}
}
}
}
}

minimum

0

maximum

100

cpuTemp?: number

Camera cpu temperature in Celsius

readonly
dptz?: OcleaDptz

Digital pan/tilt/zoom control

exposure?: { auto?: boolean; autoExposureCompensation?: number; sensorGain?: number; shutterTime?: string }

Auto/Manual exposure mode

Exposure Example Payload (4k UHD Camera)

Revolution at Auto Exposure

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/exposure/revolutionOcleaCamAutoExposureSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"B7C7ECE5BF85": {
"model": 13,
"cameras": {
"FBE2CD062FEC": {
"model": 206,
"exposure": {
"auto": true,
"autoExposureCompensation": 2,
"sensorGain": 0,
"shutterTime": "1/1"
}
}
}
}
}
}
}
Revolution at Manual Exposure

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/exposure/revolutionOcleaCamManualExposureSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"E55D6DDCDFA7": {
"model": 13,
"cameras": {
"50BA1896FD22": {
"model": 206,
"exposure": {
"auto": false,
"autoExposureCompensation": 0,
"sensorGain": 45,
"shutterTime": "1/60"
}
}
}
}
}
}
}

Type declaration

  • Optional auto?: boolean

    Auto Exposure enabled
    Toggle to false to enable manual exposure mode.

    default

    false

  • Optional autoExposureCompensation?: number

    Auto Exposure Compensation
    Compensation for auto-exposure, compared to default of 0. Negative is less exposed, positive is more exposed. Only operable in auto exposure mode.

    minimum

    -2

    maximum

    2

    default

    0

  • Optional sensorGain?: number

    Sensor gain, in dB. Only operable in manual exposure mode.

    minimum

    0

    maximum

    64

  • Optional shutterTime?: string

    Shutter time, in seconds. Must be in fraction string i.e. "1/n". The range is between 1/30 to 1/6000. Only operable in manual exposure mode.
    *

    pattern

    ^1/\d{1,4}$

ip?: string

IP address

model: OcleaCam
osd?: Osd

On screen display

Modify osd settings

Example Payload (Standard 1080p Camera)

Osd Samples (A150)

A150 with Osd Enabled

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdEnabledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"461C9E36CFBE": {
"model": 20,
"cameras": {
"F0B7EB88DE28": {
"model": 5,
"osd": {
"enabled": true
}
}
}
}
}
}
}
A150 with Osd Disabled

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdDisabledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"44E43204A4F8": {
"model": 20,
"cameras": {
"EA771650C580": {
"model": 5,
"osd": {
"enabled": false
}
}
}
}
}
}
}
A150 with Random Osd

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"E2521276E8F3": {
"model": 20,
"cameras": {
"FE9683859DAE": {
"model": 5,
"osd": {
"enabled": true
}
}
}
}
}
}
}

Osd Samples (A200)

A200 with Osd Enabled

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdEnabledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"5D6226151579": {
"model": 19,
"cameras": {
"21016C221FCE": {
"model": 5,
"osd": {
"enabled": true
}
}
}
}
}
}
}
A200 with Osd Disabled

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdDisabledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"A3EE0F077FF6": {
"model": 19,
"cameras": {
"A566E0BAB23C": {
"model": 5,
"osd": {
"enabled": false
}
}
}
}
}
}
}
A200 with Random Osd

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"25606203DC53": {
"model": 19,
"cameras": {
"6D79EC4160D7": {
"model": 5,
"osd": {
"enabled": true
}
}
}
}
}
}
}

Example Payload (Tamron Harrier Zoom Camera)

Osd Samples (A150)

A150 with Osd Enabled

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdEnabledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"3498C523FBF8": {
"model": 20,
"cameras": {
"37944F801D2C": {
"model": 240,
"osd": {
"enabled": true
}
}
}
}
}
}
}
A150 with Osd Disabled

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdDisabledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"E6B9B3D44780": {
"model": 20,
"cameras": {
"2952C2257268": {
"model": 240,
"osd": {
"enabled": false
}
}
}
}
}
}
}
A150 with Random Osd

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"7B7A4CB5186A": {
"model": 20,
"cameras": {
"B93748DD62FA": {
"model": 240,
"osd": {
"enabled": false
}
}
}
}
}
}
}

Osd Samples (A200)

A200 with Osd Enabled

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdEnabledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"A4E890B2A76A": {
"model": 19,
"cameras": {
"C62D4B6B2DD4": {
"model": 240,
"osd": {
"enabled": true
}
}
}
}
}
}
}
A200 with Osd Disabled

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdDisabledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"29E889F76479": {
"model": 19,
"cameras": {
"8460DA7C0DF6": {
"model": 240,
"osd": {
"enabled": false
}
}
}
}
}
}
}
A200 with Random Osd

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"E749D34D5169": {
"model": 19,
"cameras": {
"6F0DB8010397": {
"model": 240,
"osd": {
"enabled": true
}
}
}
}
}
}
}


saturation?: number

🎨 Camera Saturation

Saturation Sample (Revolution/Pivot)

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/saturation/revolutionOcleaCamSaturationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"F85DD29C12F5": {
"model": 13,
"cameras": {
"75E699DD95CB": {
"model": 206,
"saturation": 45
}
}
}
}
}
}

minimum

0

maximum

100

streamMode?: StreamMode

Camera streaming mode information.

streams?: Record<string, Stream>

Video Streams

Holds a list of available streams from the camera.

Example Payload (Standard 1080p Camera)

Camera Stream Samples (A150)

A150 with a 480p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/streams/a150DTCamStream480pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"CD2F6051C99F": {
"model": 20,
"cameras": {
"D452D71C8DFF": {
"model": 5,
"streams": {
"272ACC51BE4D": {
"active": true,
"resolution": {
"width": 854,
"height": 480
}
}
}
}
}
}
}
}
}
A150 with a 720p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/streams/a150DTCamStream720pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"944A7508564E": {
"model": 20,
"cameras": {
"F1D1482A6A12": {
"model": 5,
"streams": {
"E252E019ACC0": {
"active": true,
"resolution": {
"width": 1280,
"height": 720
}
}
}
}
}
}
}
}
}
A150 with a 1080p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/streams/a150DTCamStream1080pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"096F7AEA3E7D": {
"model": 20,
"cameras": {
"ED1D62E7ADBE": {
"model": 5,
"streams": {
"A20B54B94739": {
"active": true
}
}
}
}
}
}
}
}
A150 with a random stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/streams/a150DTCamStreamRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"9CAFD256E02F": {
"model": 20,
"cameras": {
"95941B827CF4": {
"model": 5,
"streams": {
"EF1BB82B980D": {
"active": true,
"resolution": {
"width": 48,
"height": 79
}
}
}
}
}
}
}
}
}

Camera Stream Samples (A200)

A200 with a 480p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/streams/a200DTCamStream480pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"BADE7BA6CFE2": {
"model": 19,
"cameras": {
"1DBF55CEF2DF": {
"model": 5,
"streams": {
"4B64407EA879": {
"active": true,
"resolution": {
"width": 854,
"height": 480
}
}
}
}
}
}
}
}
}
A200 with a 720p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/streams/a200DTCamStream720pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"3E901F2D5EA8": {
"model": 19,
"cameras": {
"0964786CF99A": {
"model": 5,
"streams": {
"3F34AD827ABB": {
"active": true,
"resolution": {
"width": 1280,
"height": 720
}
}
}
}
}
}
}
}
}
A200 with a 1080p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/streams/a200DTCamStream1080pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"7D9DC93C7F9E": {
"model": 19,
"cameras": {
"D8DC11CCF6F4": {
"model": 5,
"streams": {
"7DED2027BF5D": {
"active": true,
"resolution": {
"width": 1920,
"height": 1080
}
}
}
}
}
}
}
}
}
A200 with a random stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/streams/a200DTCamStreamRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"56AF2AC1825F": {
"model": 19,
"cameras": {
"8A2950738913": {
"model": 5,
"streams": {
"7D0C2C02C55D": {
"active": true,
"resolution": {
"width": 49,
"height": 45
}
}
}
}
}
}
}
}
}

Example Payload (Tamron Harrier Zoom Camera)

Camera Stream Samples (A150)

A150 with a 480p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream480pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"679A05038443": {
"model": 20,
"cameras": {
"85CA7C26B514": {
"model": 240,
"streams": {
"28A31C9EC853": {
"active": true,
"resolution": {
"width": 854,
"height": 480
}
}
}
}
}
}
}
}
}
A150 with a 720p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream720pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"77FBDE1AFC9B": {
"model": 20,
"cameras": {
"8BEDDE8B2CB5": {
"model": 240,
"streams": {
"DAD276C72E83": {
"active": true,
"resolution": {
"width": 1280,
"height": 720
}
}
}
}
}
}
}
}
}
A150 with a 1080p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream1080pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"85CD19B95002": {
"model": 20,
"cameras": {
"7B78A3A31233": {
"model": 240,
"streams": {
"89256D552658": {
"active": true
}
}
}
}
}
}
}
}
A150 with a 2k stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream2kSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"1D8D519A32CD": {
"model": 20,
"cameras": {
"594AE8B3DBD0": {
"model": 240,
"streams": {
"F022718F7B51": {
"active": true,
"resolution": {
"width": 2560,
"height": 1440
}
}
}
}
}
}
}
}
}
A150 with a 4k stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream4kSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"1E368EDE8D3F": {
"model": 20,
"cameras": {
"7C15264F556E": {
"model": 240,
"streams": {
"04D869CE62AB": {
"active": true,
"resolution": {
"width": 3840,
"height": 2160
}
}
}
}
}
}
}
}
}
A150 with a random stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStreamRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {
"devices": {
"8F138F85F69A": {
"model": 20,
"cameras": {
"E9AFC9C2F95A": {
"model": 240,
"streams": {
"932CF85B2F26": {
"active": true,
"resolution": {
"width": 60,
"height": 35
}
}
}
}
}
}
}
}
}

Camera Stream Samples (A200)

A200 with a 480p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream480pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {}
}
A200 with a 720p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream720pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {}
}
A200 with a 1080p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream1080pSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {}
}
A200 with a 2k stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream2kSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {}
}
A200 with a 4k stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream4kSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {}
}
A200 with a random stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStreamRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "DELETE",
"payload": {}
}


turbidityFilter?: TurbidityFilter

Turbidity filter settings for supported oclea versions

Turbidity filter Strength Example Payload (4k UHD Camera)

Revolution at MAX strength

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/OcleaCamera/turbidityStrength/revolutionOcleaCameraTurbidityStrengthMaxSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"43E503CB855E": {
"model": 13,
"cameras": {
"5EABCD042ED6": {
"model": 206,
"turbidityFilter": {
"strength": 30
}
}
}
}
}
}
}
Revolution at MIN strength

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/OcleaCamera/turbidityStrength/revolutionOcleaCameraTurbidityStrengthMinSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"5FDBA1F1624A": {
"model": 13,
"cameras": {
"004AD6B104D6": {
"model": 206,
"turbidityFilter": {
"strength": 1
}
}
}
}
}
}
}
Revolution at RANDOM strength

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/OcleaCamera/turbidityStrength/revolutionOcleaCameraTurbidityStrengthRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"B873FA90C7A5": {
"model": 13,
"cameras": {
"58A3D7D523D2": {
"model": 206,
"turbidityFilter": {
"strength": 18
}
}
}
}
}
}
}
Pivot at MAX strength

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/OcleaCamera/turbidityStrength/pivotOcleaCameraTurbidityStrengthMaxSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"B172F2D5A93D": {
"model": 18,
"cameras": {
"ABB0BAB79EAD": {
"model": 206,
"turbidityFilter": {
"strength": 30
}
}
}
}
}
}
}
Pivot at MIN strength

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/OcleaCamera/turbidityStrength/pivotOcleaCameraTurbidityStrengthMinSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"BCDE1409516E": {
"model": 18,
"cameras": {
"A3FB4B3AB3AA": {
"model": 206,
"turbidityFilter": {
"strength": 1
}
}
}
}
}
}
}
Pivot at RANDOM strength

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/OcleaCamera/turbidityStrength/pivotOcleaCameraTurbidityStrengthRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"39651EA005FA": {
"model": 18,
"cameras": {
"2BE5C4F915CE": {
"model": 206,
"turbidityFilter": {
"strength": 9
}
}
}
}
}
}
}

type?: CameraType

Camera Type

Used to determine which camera feed should get initiated first

Example Payload (Standard 1080p Camera)

Camera Type Samples (A150)

A150 Main Camera Type

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/type/a150DTCamTypeMainSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"7C1767883CB0": {
"model": 20,
"cameras": {
"B9A9E70F0952": {
"model": 5,
"type": "MAIN"
}
}
}
}
}
}
A150 Aux Camera Type

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/type/a150DTCamTypeAuxSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"788BDD258CCD": {
"model": 20,
"cameras": {
"10B3AD58A9D3": {
"model": 5,
"type": "AUX"
}
}
}
}
}
}

Camera Type Samples (A200)

A200 Main Camera Type

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/type/a200DTCamTypeMainSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"764C369B4A61": {
"model": 19,
"cameras": {
"8368EE6F2440": {
"model": 5,
"type": "MAIN"
}
}
}
}
}
}
A200 Aux Camera Type

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/type/a200DTCamTypeAuxSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"3F44CD2627FC": {
"model": 19,
"cameras": {
"F774205BBCDC": {
"model": 5,
"type": "AUX"
}
}
}
}
}
}

Example Payload (Tamron Harrier Zoom Camera)

Camera Type Samples (A150)

A150 Main Camera Type

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/type/a150TamronHarrierZoomCameraTypeMainSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"B3D70A7E73DD": {
"model": 20,
"cameras": {
"1CBA63CCEA79": {
"model": 240,
"type": "MAIN"
}
}
}
}
}
}
A150 Aux Camera Type

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/type/a150TamronHarrierZoomCameraTypeAuxSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"CC5BF2887A71": {
"model": 20,
"cameras": {
"F94C713611B4": {
"model": 240,
"type": "AUX"
}
}
}
}
}
}

Camera Type Samples (A200)

A200 Main Camera Type

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/type/a200TamronHarrierZoomCameraTypeMainSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"4D88740D3298": {
"model": 19,
"cameras": {
"BBBE95878DBF": {
"model": 240,
"type": "MAIN"
}
}
}
}
}
}
A200 Aux Camera Type

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/type/a200TamronHarrierZoomCameraTypeAuxSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"83EB9A436348": {
"model": 19,
"cameras": {
"6027D758B16A": {
"model": 240,
"type": "AUX"
}
}
}
}
}
}


version?: DeviceVersion

Version

whiteBalance?: { auto?: boolean; awbMode?: string; awbModeOptions?: string[]; blue?: number; red?: number }

White Balance

White Balance Sample (Revolution/Pivot)

Auto White Balance

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamAutoWhiteBalanceSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"6464D67E8C44": {
"model": 13,
"cameras": {
"8A9A5686413D": {
"model": 206,
"whiteBalance": {
"auto": true,
"red": 0,
"blue": 0
}
}
}
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamAutoWhiteBalanceSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"62088A795DF6": {
"model": 18,
"cameras": {
"34C64A8D8791": {
"model": 206,
"whiteBalance": {
"auto": true,
"red": 0,
"blue": 0
}
}
}
}
}
}
}
Manual White Balance

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamManualWhiteBalanceSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"17D8C0884711": {
"model": 13,
"cameras": {
"6ED44BB0E42B": {
"model": 206,
"whiteBalance": {
"auto": false,
"red": 50,
"blue": 45
}
}
}
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamManualWhiteBalanceSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"5BC626534A3B": {
"model": 18,
"cameras": {
"884388174D0B": {
"model": 206,
"whiteBalance": {
"auto": true,
"red": 91,
"blue": 33
}
}
}
}
}
}
}
Auto WB Mode samples

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamAutoWhiteBalanceAirModeSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"C1086A47BD56": {
"model": 18,
"cameras": {
"6549617CF743": {
"model": 206,
"whiteBalance": {
"auto": true,
"awbMode": "air"
}
}
}
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamAutoWhiteBalanceAirModeSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"D7B26DB79DE5": {
"model": 13,
"cameras": {
"70089C79622C": {
"model": 206,
"whiteBalance": {
"auto": true,
"awbMode": "air"
}
}
}
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamAutoWhiteBalanceUnderwaterModeSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"C665E8819077": {
"model": 18,
"cameras": {
"451BC70D62ED": {
"model": 206,
"whiteBalance": {
"auto": true,
"awbMode": "underwater"
}
}
}
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamAutoWhiteBalanceUnderwaterModeSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.14",
"method": "SET",
"payload": {
"devices": {
"3CCE7BF0D130": {
"model": 13,
"cameras": {
"FDE430A9559D": {
"model": 206,
"whiteBalance": {
"auto": true,
"awbMode": "underwater"
}
}
}
}
}
}
}

Type declaration

  • Optional auto?: boolean

    Enable/Disable auto white balance mode. 4K UHD only supports red & blue channels.

  • Optional awbMode?: string

    Auto White Balance mode select control

  • Optional awbModeOptions?: string[]

    Auto White Balance possible options list

  • Optional blue?: number

    Blue Control

    minimum

    0

    maximum

    100

  • Optional red?: number

    Red Control

    minimum

    0

    maximum

    100