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.56.4",
"method": "SET",
"payload": {
"devices": {
"5F8C70A6F7FB": {
"model": 13,
"cameras": {
"5F8993B8D282": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"20272FA4FA81": {
"model": 13,
"cameras": {
"24DC3DE67846": {
"model": 206,
"contrast": 45
}
}
}
}
}
}

minimum

0

maximum

100

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.56.4",
"method": "SET",
"payload": {
"devices": {
"519A2D45D93A": {
"model": 13,
"cameras": {
"3B74C5C524DD": {
"model": 206,
"exposure": {
"auto": true,
"autoExposureCompensation": 0,
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"4B66ECEE0E6D": {
"model": 13,
"cameras": {
"F1DF0F5AF93A": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"BE089EEC3F65": {
"model": 20,
"cameras": {
"9C86D2538DF2": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"7D2EE64AAFFF": {
"model": 20,
"cameras": {
"5EC89A4263AB": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"D6805A5FCE2E": {
"model": 20,
"cameras": {
"5880C74D972D": {
"model": 5,
"osd": {
"enabled": false
}
}
}
}
}
}
}

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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"C8AF3B4FAD0B": {
"model": 19,
"cameras": {
"1E5B5812E52C": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"69C712466B03": {
"model": 19,
"cameras": {
"2900068E3148": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"0C6B253B6B24": {
"model": 19,
"cameras": {
"DD0634FE903F": {
"model": 5,
"osd": {
"enabled": false
}
}
}
}
}
}
}

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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"61D145068637": {
"model": 20,
"cameras": {
"30430D9D8DDF": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"079FA6B653AD": {
"model": 20,
"cameras": {
"A2771A13655C": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"6650919941AF": {
"model": 20,
"cameras": {
"A31DB3729143": {
"model": 240,
"osd": {
"enabled": true
}
}
}
}
}
}
}

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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"F1445B9F3CE1": {
"model": 19,
"cameras": {
"C00B150BCFF4": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"BAE03115B0D7": {
"model": 19,
"cameras": {
"2B1003B154B1": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"2DD5189F8452": {
"model": 19,
"cameras": {
"DDC88977E946": {
"model": 240,
"osd": {
"enabled": false
}
}
}
}
}
}
}


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.56.4",
"method": "SET",
"payload": {
"devices": {
"1ECEC0AC8B9C": {
"model": 13,
"cameras": {
"AA51387473FA": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"170ECFF59F1A": {
"model": 20,
"cameras": {
"1ED8CB7B589B": {
"model": 5,
"streams": {
"C3C6D48D7CC7": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"7FDF681E84F7": {
"model": 20,
"cameras": {
"EA2AD4C7DB9A": {
"model": 5,
"streams": {
"4DB0D7475F2F": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"E1CB0D98B4E7": {
"model": 20,
"cameras": {
"EF0D9B7A962D": {
"model": 5,
"streams": {
"D362871C562B": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"F10E7442FDEE": {
"model": 20,
"cameras": {
"3FB91050C605": {
"model": 5,
"streams": {
"6251537478AB": {
"active": true,
"resolution": {
"width": 100,
"height": 38
}
}
}
}
}
}
}
}
}

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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"5B4AC62FBCD6": {
"model": 19,
"cameras": {
"1C165C85D6A5": {
"model": 5,
"streams": {
"91691B36011B": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"B2E942A15860": {
"model": 19,
"cameras": {
"7F4D587308B8": {
"model": 5,
"streams": {
"6D13121DAD5F": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"D8A87A39AEBD": {
"model": 19,
"cameras": {
"0E5638473BF3": {
"model": 5,
"streams": {
"DC7757F7D3A0": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"45DB4C0778BA": {
"model": 19,
"cameras": {
"0A3EDB4A7B3C": {
"model": 5,
"streams": {
"C8B042F36D98": {
"active": true,
"resolution": {
"width": 25,
"height": 54
}
}
}
}
}
}
}
}
}

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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"0E924D76C0F1": {
"model": 20,
"cameras": {
"B84AB9973901": {
"model": 240,
"streams": {
"A5720D935D3E": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"2D363BBA21BE": {
"model": 20,
"cameras": {
"F3C14E4E7F61": {
"model": 240,
"streams": {
"91E9A0B87965": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"F6F930BE4C1A": {
"model": 20,
"cameras": {
"474B717C4F98": {
"model": 240,
"streams": {
"1A2D5B7977D0": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"D9470A07C90F": {
"model": 20,
"cameras": {
"9B77D6A95C8E": {
"model": 240,
"streams": {
"3D0C3A3C024A": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"243D646EFD29": {
"model": 20,
"cameras": {
"E544A32A38F2": {
"model": 240,
"streams": {
"A2FB186D789F": {
"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.56.4",
"method": "DELETE",
"payload": {
"devices": {
"A9BF84951E86": {
"model": 20,
"cameras": {
"03863CEB64B2": {
"model": 240,
"streams": {
"796B615BA4D4": {
"active": true,
"resolution": {
"width": 75,
"height": 54
}
}
}
}
}
}
}
}
}

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.56.4",
"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.56.4",
"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.56.4",
"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.56.4",
"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.56.4",
"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.56.4",
"method": "DELETE",
"payload": {}
}


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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"8523131C9269": {
"model": 20,
"cameras": {
"C00D906A888A": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"6CA665234C6B": {
"model": 20,
"cameras": {
"A5946D4D944C": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"EB127B5D309D": {
"model": 19,
"cameras": {
"46B45B52F8F6": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"BAB7763E104A": {
"model": 19,
"cameras": {
"DDB553DE1E9A": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"BA025CC39189": {
"model": 20,
"cameras": {
"6497227F142A": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"8288945964FA": {
"model": 20,
"cameras": {
"8D83B15C4963": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"0393FC33EE25": {
"model": 19,
"cameras": {
"03548AF4E741": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"EA21E963FA3D": {
"model": 19,
"cameras": {
"05904FFD317A": {
"model": 240,
"type": "AUX"
}
}
}
}
}
}


version?: DeviceVersion

Version

whiteBalance?: { auto?: boolean; 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.56.4",
"method": "SET",
"payload": {
"devices": {
"B06E19272CC7": {
"model": 13,
"cameras": {
"B0C71338FFF5": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"D34B05687E5B": {
"model": 18,
"cameras": {
"25B54FDA43A7": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"2390A94D43A9": {
"model": 13,
"cameras": {
"E2E7AF1385BC": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"930B814B90E0": {
"model": 18,
"cameras": {
"C1C72243525A": {
"model": 206,
"whiteBalance": {
"auto": true,
"red": 46,
"blue": 100
}
}
}
}
}
}
}

Type declaration

  • Optional auto?: boolean

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

  • Optional blue?: number

    Blue Control

    minimum

    0

    maximum

    100

  • Optional red?: number

    Red Control

    minimum

    0

    maximum

    100