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.61.0",
"method": "SET",
"payload": {
"devices": {
"98720E512B85": {
"model": 13,
"cameras": {
"009FE9C538FE": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"F3CA7D9C8E28": {
"model": 13,
"cameras": {
"142978E30F00": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"7DE723E60BA1": {
"model": 13,
"cameras": {
"DE936910D811": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"1EF6E4327AAE": {
"model": 13,
"cameras": {
"85814760EFA8": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"297966BCD6E1": {
"model": 20,
"cameras": {
"31D3256637A8": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"FAAA735DD5D2": {
"model": 20,
"cameras": {
"0BAFB24D1702": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"7920D3E799E5": {
"model": 20,
"cameras": {
"6A4385F35F87": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"EF7F2B605C3C": {
"model": 19,
"cameras": {
"42F8A5286473": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"7C9DC72A0978": {
"model": 19,
"cameras": {
"9EC6D6875302": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"79904245115C": {
"model": 19,
"cameras": {
"36AECD8EBFB2": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"E1C27F64E1D9": {
"model": 20,
"cameras": {
"E58BC5BB1862": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"9CAA6408035B": {
"model": 20,
"cameras": {
"796896D716CF": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"1A24A19D29A9": {
"model": 20,
"cameras": {
"6E2B49F7AF9F": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"241961357A54": {
"model": 19,
"cameras": {
"19F576E16E32": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"3EB818F9ADF3": {
"model": 19,
"cameras": {
"52FF03E1C8D9": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"C9F258E792AF": {
"model": 19,
"cameras": {
"56F96D36989D": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"16117B53D942": {
"model": 13,
"cameras": {
"05B41E7BB552": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"83243B00B4C7": {
"model": 20,
"cameras": {
"E354324A167D": {
"model": 5,
"streams": {
"0ABB7FB084A0": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"70BF7A496A26": {
"model": 20,
"cameras": {
"E01CA4EF49A0": {
"model": 5,
"streams": {
"D74F4D5D0688": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"67CC9DF9DB6A": {
"model": 20,
"cameras": {
"BAF41A7BB53E": {
"model": 5,
"streams": {
"F17E33995487": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"50F563FA2113": {
"model": 20,
"cameras": {
"F97A030544EE": {
"model": 5,
"streams": {
"43FAF23E97F0": {
"active": true,
"resolution": {
"width": 46,
"height": 74
}
}
}
}
}
}
}
}
}

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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"83FF97B1FD45": {
"model": 19,
"cameras": {
"3047C39B687E": {
"model": 5,
"streams": {
"D702ED5CE2E2": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"DA3B358032D6": {
"model": 19,
"cameras": {
"49688701F4A0": {
"model": 5,
"streams": {
"8C40D29206A1": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"25D24E11ECE2": {
"model": 19,
"cameras": {
"688BBE9CF3F5": {
"model": 5,
"streams": {
"59BFD42CCF21": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"1E20CB98F3CA": {
"model": 19,
"cameras": {
"26782DFF2503": {
"model": 5,
"streams": {
"0BB3CC5B7002": {
"active": true,
"resolution": {
"width": 96,
"height": 97
}
}
}
}
}
}
}
}
}

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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"BA413E722223": {
"model": 20,
"cameras": {
"6F1636660DC3": {
"model": 240,
"streams": {
"438FE0127963": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"E9F915C40A51": {
"model": 20,
"cameras": {
"1B2BA2ED8BD1": {
"model": 240,
"streams": {
"0F7AF20CF84B": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"1C4A728274C4": {
"model": 20,
"cameras": {
"3A0655B19F8A": {
"model": 240,
"streams": {
"FEA01988F377": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"1CABEEE10AD8": {
"model": 20,
"cameras": {
"51B968FCD846": {
"model": 240,
"streams": {
"01BF1DF15E34": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"4EBDB760A844": {
"model": 20,
"cameras": {
"AE15F362498D": {
"model": 240,
"streams": {
"2B1C96BECAD8": {
"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.61.0",
"method": "DELETE",
"payload": {
"devices": {
"9CF46D0CDDD2": {
"model": 20,
"cameras": {
"A15CC6A45147": {
"model": 240,
"streams": {
"31037308A21C": {
"active": true,
"resolution": {
"width": 6,
"height": 51
}
}
}
}
}
}
}
}
}

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.61.0",
"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.61.0",
"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.61.0",
"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.61.0",
"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.61.0",
"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.61.0",
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"4139B0F0721D": {
"model": 13,
"cameras": {
"DA96A59EFEBB": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"F637810A6200": {
"model": 13,
"cameras": {
"9C6EE3F26D34": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"7DC53BDEEF1B": {
"model": 13,
"cameras": {
"0927FD171B64": {
"model": 206,
"turbidityFilter": {
"strength": 26
}
}
}
}
}
}
}
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.61.0",
"method": "SET",
"payload": {
"devices": {
"6E9F6AC32F44": {
"model": 18,
"cameras": {
"682795EFA24B": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"4AD3A77B42EF": {
"model": 18,
"cameras": {
"408ACB35C717": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"015A664F2576": {
"model": 18,
"cameras": {
"9DA17B358908": {
"model": 206,
"turbidityFilter": {
"strength": 27
}
}
}
}
}
}
}

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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"4BA6549C81AE": {
"model": 20,
"cameras": {
"E0C0FA753C95": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"E6B9A8AE1E3E": {
"model": 20,
"cameras": {
"DAE81D8C6A5B": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"166C4075F6F4": {
"model": 19,
"cameras": {
"D92E57FACEAF": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"4FEDBF62D291": {
"model": 19,
"cameras": {
"36AE5271DC9E": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"03E33A6C169D": {
"model": 20,
"cameras": {
"D0978AB4424B": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"CDB706A3141B": {
"model": 20,
"cameras": {
"019D84197282": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"BEB011323651": {
"model": 19,
"cameras": {
"9C113BEAB41A": {
"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.61.0",
"method": "UPDATE",
"payload": {
"devices": {
"B2C0A4D90C8A": {
"model": 19,
"cameras": {
"A60D37CC1DEB": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"5C8EAE6CD2E4": {
"model": 13,
"cameras": {
"24D2631F5872": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"91AE5DA4954F": {
"model": 18,
"cameras": {
"3E4A21A7EF93": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"5014D753E184": {
"model": 13,
"cameras": {
"A5A5C941DC4C": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"B8D33B7D8A64": {
"model": 18,
"cameras": {
"F1DDD4E1DEC4": {
"model": 206,
"whiteBalance": {
"auto": true,
"red": 23,
"blue": 12
}
}
}
}
}
}
}
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.61.0",
"method": "SET",
"payload": {
"devices": {
"4EC5AEC33264": {
"model": 18,
"cameras": {
"A327B37B30CF": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"B8E65939116C": {
"model": 13,
"cameras": {
"77750C92D85A": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"05AC2A335BD8": {
"model": 18,
"cameras": {
"9F788851293A": {
"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.61.0",
"method": "SET",
"payload": {
"devices": {
"786A8C19C811": {
"model": 13,
"cameras": {
"21916D951FB7": {
"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