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.10",
"method": "SET",
"payload": {
"devices": {
"6050E7663659": {
"model": 13,
"cameras": {
"8A0F297E2FEE": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"F394CBAAD6CE": {
"model": 13,
"cameras": {
"6221F08AFE1F": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"C71A460B35F3": {
"model": 13,
"cameras": {
"F582626E040D": {
"model": 206,
"exposure": {
"auto": true,
"autoExposureCompensation": 1,
"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.10",
"method": "SET",
"payload": {
"devices": {
"D43F45911D68": {
"model": 13,
"cameras": {
"69822C5052CB": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"8742B9DCAD9A": {
"model": 20,
"cameras": {
"B411A15148C4": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"7A9D7D8D918B": {
"model": 20,
"cameras": {
"155667D77A90": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"E9BCF097580A": {
"model": 20,
"cameras": {
"B657D9F04EA9": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"C0E84E26BDE1": {
"model": 19,
"cameras": {
"535BB549012F": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"D2AD9D1F9990": {
"model": 19,
"cameras": {
"F84D0C54E6F7": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"5BEDC7C8445D": {
"model": 19,
"cameras": {
"A13785772B73": {
"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.58.10",
"method": "UPDATE",
"payload": {
"devices": {
"FB1D39EAB765": {
"model": 20,
"cameras": {
"1F1ED670D4C4": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"85455D7BE4A7": {
"model": 20,
"cameras": {
"4904644FC33D": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"DB43884D04DB": {
"model": 20,
"cameras": {
"F850FA35B2DA": {
"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.58.10",
"method": "UPDATE",
"payload": {
"devices": {
"64DE9ED65743": {
"model": 19,
"cameras": {
"D673470B4947": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"ABAF100CF19D": {
"model": 19,
"cameras": {
"13EA267BCDBC": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"F0400DDB130B": {
"model": 19,
"cameras": {
"CE9E7B9210C6": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"3D4F811DA748": {
"model": 13,
"cameras": {
"0899400D5CAE": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"22B3DC817D53": {
"model": 20,
"cameras": {
"1637875D9204": {
"model": 5,
"streams": {
"4F92091158AD": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"A7CB9AE3CBF2": {
"model": 20,
"cameras": {
"8A6264B3C87A": {
"model": 5,
"streams": {
"0D5BA2A69EC9": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"FA4F8087E51C": {
"model": 20,
"cameras": {
"498D8282B228": {
"model": 5,
"streams": {
"3DB4D5EF8222": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"78019B05BCC9": {
"model": 20,
"cameras": {
"96102EC9A0D9": {
"model": 5,
"streams": {
"D8A8708CCE8D": {
"active": true,
"resolution": {
"width": 75,
"height": 92
}
}
}
}
}
}
}
}
}

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.10",
"method": "DELETE",
"payload": {
"devices": {
"8542344BF0D1": {
"model": 19,
"cameras": {
"D6D3A548B88F": {
"model": 5,
"streams": {
"228E3B747BDA": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"0518FC6A4534": {
"model": 19,
"cameras": {
"F25D35A0C59A": {
"model": 5,
"streams": {
"312E948009FD": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"45775A14D399": {
"model": 19,
"cameras": {
"F50E9457EFD9": {
"model": 5,
"streams": {
"7B2F4A847144": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"CFDBE7A37C99": {
"model": 19,
"cameras": {
"D2BAEF9C7623": {
"model": 5,
"streams": {
"4F29F6051DAF": {
"active": true,
"resolution": {
"width": 37,
"height": 3
}
}
}
}
}
}
}
}
}

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.10",
"method": "DELETE",
"payload": {
"devices": {
"50F3B9677453": {
"model": 20,
"cameras": {
"3FB3007295CE": {
"model": 240,
"streams": {
"BB5B25102773": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"5232FCF17D6A": {
"model": 20,
"cameras": {
"1B41D3AB787E": {
"model": 240,
"streams": {
"984F8BC76E0E": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"E72470DC1575": {
"model": 20,
"cameras": {
"96DE56EA4555": {
"model": 240,
"streams": {
"C760BF0B1FEB": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"95FBA9AE9957": {
"model": 20,
"cameras": {
"B0949B7B6660": {
"model": 240,
"streams": {
"ECFE1126B4A5": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"5B11306200E6": {
"model": 20,
"cameras": {
"1CBDBD1E4EA5": {
"model": 240,
"streams": {
"AE7B71E4BC10": {
"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.10",
"method": "DELETE",
"payload": {
"devices": {
"6E1115356B3A": {
"model": 20,
"cameras": {
"F3E9C0A125EC": {
"model": 240,
"streams": {
"E77AEA6EED66": {
"active": true,
"resolution": {
"width": 51,
"height": 2
}
}
}
}
}
}
}
}
}

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.10",
"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.10",
"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.10",
"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.10",
"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.10",
"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.10",
"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.10",
"method": "SET",
"payload": {
"devices": {
"F503802D80A7": {
"model": 13,
"cameras": {
"26EDE137C563": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"2A1CED63A4D2": {
"model": 13,
"cameras": {
"D747AF6C6130": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"E463299260B4": {
"model": 13,
"cameras": {
"55A1699E6636": {
"model": 206,
"turbidityFilter": {
"strength": 24
}
}
}
}
}
}
}
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.10",
"method": "SET",
"payload": {
"devices": {
"31D72526708E": {
"model": 18,
"cameras": {
"8C80DB778C04": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"DCC950E66B51": {
"model": 18,
"cameras": {
"92C509D27966": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"9A9B534A054F": {
"model": 18,
"cameras": {
"E08CBE8529BE": {
"model": 206,
"turbidityFilter": {
"strength": 16
}
}
}
}
}
}
}

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.10",
"method": "UPDATE",
"payload": {
"devices": {
"95226E475D60": {
"model": 20,
"cameras": {
"590944615A43": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"B521578E72EA": {
"model": 20,
"cameras": {
"0A81CFA605B0": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"5C8D5977A434": {
"model": 19,
"cameras": {
"6D50A35FF241": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"0469171FC4B5": {
"model": 19,
"cameras": {
"A02164ACF5F2": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"C47AF2972135": {
"model": 20,
"cameras": {
"BF24ADF105BB": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"FE9BB3652613": {
"model": 20,
"cameras": {
"B61B292A88F9": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"550F53570D67": {
"model": 19,
"cameras": {
"E6D3DBFF6472": {
"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.10",
"method": "UPDATE",
"payload": {
"devices": {
"174A24F694DF": {
"model": 19,
"cameras": {
"85D4F3D4105E": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"9A0F3E11A758": {
"model": 13,
"cameras": {
"40DCD35FA2E6": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"1D19845801AC": {
"model": 18,
"cameras": {
"CC697C4DD31B": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"EF9CA95E7848": {
"model": 13,
"cameras": {
"43606C4E66F1": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"DE7DE9BB9712": {
"model": 18,
"cameras": {
"F6D4B5086660": {
"model": 206,
"whiteBalance": {
"auto": false,
"red": 12,
"blue": 100
}
}
}
}
}
}
}
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.10",
"method": "SET",
"payload": {
"devices": {
"36BE465A97B7": {
"model": 18,
"cameras": {
"2F778DF31804": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"BD78D12D2BDD": {
"model": 13,
"cameras": {
"1E0B65BAB185": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"165A5DBDFB28": {
"model": 18,
"cameras": {
"EF1A8409F3E4": {
"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.10",
"method": "SET",
"payload": {
"devices": {
"7DFF8F6E329F": {
"model": 13,
"cameras": {
"4D2C0410D01B": {
"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