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.60.4",
"method": "SET",
"payload": {
"devices": {
"B6889B1544AF": {
"model": 13,
"cameras": {
"2AF6130F872A": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"C317B57229D6": {
"model": 13,
"cameras": {
"1A9F5DDBB8EF": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"1EDC5F015851": {
"model": 13,
"cameras": {
"0D9F55B3CE90": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"3DF8F66F2C23": {
"model": 13,
"cameras": {
"4E2F25AB24F3": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"1F281D9526CD": {
"model": 20,
"cameras": {
"E9B3347BEC0C": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"7E20B9B86927": {
"model": 20,
"cameras": {
"937FF03524D3": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"EED6CC796C9B": {
"model": 20,
"cameras": {
"D081120FE6C1": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"869808DFB3A7": {
"model": 19,
"cameras": {
"9CE04D53B7CA": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"4B74FADFDB9E": {
"model": 19,
"cameras": {
"49FFE961F108": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"C375AB771A6D": {
"model": 19,
"cameras": {
"F9362ADC8C5E": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"72D472AC3C80": {
"model": 20,
"cameras": {
"1595A4FF9098": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"090033D1F8D0": {
"model": 20,
"cameras": {
"C3185DC23BE5": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"97D891683F1A": {
"model": 20,
"cameras": {
"89F79F744118": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"CC9FD8EFCE4C": {
"model": 19,
"cameras": {
"F1E786620684": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"1C30A575E1FC": {
"model": 19,
"cameras": {
"C42789E02A5B": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"2835F4B18A63": {
"model": 19,
"cameras": {
"E98448F942D7": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"E286940F33F6": {
"model": 13,
"cameras": {
"BC07F4478A40": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"DCFC0E78B6FC": {
"model": 20,
"cameras": {
"F596CC756C7D": {
"model": 5,
"streams": {
"2CAEB08B84E1": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"605B397DCC75": {
"model": 20,
"cameras": {
"7BC9B73E6129": {
"model": 5,
"streams": {
"A5BF64D3A6CE": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"3692C22FCC15": {
"model": 20,
"cameras": {
"2750F841ED70": {
"model": 5,
"streams": {
"EA851B0F7483": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"7D573482BFB7": {
"model": 20,
"cameras": {
"174D82E419C1": {
"model": 5,
"streams": {
"C5DA68D69658": {
"active": true,
"resolution": {
"width": 59,
"height": 78
}
}
}
}
}
}
}
}
}

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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"9BD08AEDDBCE": {
"model": 19,
"cameras": {
"7CA046BD7514": {
"model": 5,
"streams": {
"E2EE0E257A2A": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"B11FF5250B14": {
"model": 19,
"cameras": {
"21AEF4CED2A9": {
"model": 5,
"streams": {
"73DFAB750757": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"9054BDA70027": {
"model": 19,
"cameras": {
"721FA5CEBF0A": {
"model": 5,
"streams": {
"5A84618AD3FC": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"235E88122829": {
"model": 19,
"cameras": {
"662B414D4858": {
"model": 5,
"streams": {
"AED395528D6C": {
"active": true,
"resolution": {
"width": 7,
"height": 14
}
}
}
}
}
}
}
}
}

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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"86924983F6DF": {
"model": 20,
"cameras": {
"322D3FD3FC57": {
"model": 240,
"streams": {
"C4EB69ED53C2": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"19283BF719BE": {
"model": 20,
"cameras": {
"EEB5E049A2F4": {
"model": 240,
"streams": {
"2D6D2ACEFB31": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"DCC3F1B1FE1D": {
"model": 20,
"cameras": {
"EB5FB89551DA": {
"model": 240,
"streams": {
"1D01B53E0241": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"89FACD7978BA": {
"model": 20,
"cameras": {
"84A62FDB08B5": {
"model": 240,
"streams": {
"711C79A587A5": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"A6EFF20B7F87": {
"model": 20,
"cameras": {
"FC93DB4E36D2": {
"model": 240,
"streams": {
"6809A824C7C1": {
"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.60.4",
"method": "DELETE",
"payload": {
"devices": {
"96201917EC6D": {
"model": 20,
"cameras": {
"6A5F15BDC48C": {
"model": 240,
"streams": {
"DFB2753B5E45": {
"active": true,
"resolution": {
"width": 97,
"height": 7
}
}
}
}
}
}
}
}
}

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.60.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.60.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.60.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.60.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.60.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.60.4",
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"7AE992A3C487": {
"model": 13,
"cameras": {
"C2DB970923E6": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"FFAD303C7203": {
"model": 13,
"cameras": {
"D2A20183AA40": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"205F89F8F1B2": {
"model": 13,
"cameras": {
"DBCB10D2C672": {
"model": 206,
"turbidityFilter": {
"strength": 17
}
}
}
}
}
}
}
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.60.4",
"method": "SET",
"payload": {
"devices": {
"E7A3D6E34F55": {
"model": 18,
"cameras": {
"A1A3F3E83A4C": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"3F0BD4D503DE": {
"model": 18,
"cameras": {
"B66139371053": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"71891E2F7B8C": {
"model": 18,
"cameras": {
"A2A909F5A3A0": {
"model": 206,
"turbidityFilter": {
"strength": 10
}
}
}
}
}
}
}

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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"E8035D13646F": {
"model": 20,
"cameras": {
"FF301A8D2685": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"5F75C5C9D8FB": {
"model": 20,
"cameras": {
"9848A6EA55AA": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"6DE4109079B1": {
"model": 19,
"cameras": {
"3BDEC70FC2F1": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"D5AFC78CE291": {
"model": 19,
"cameras": {
"21A98C6A4C9E": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"C01ABAE85E07": {
"model": 20,
"cameras": {
"6EDAA225CCBF": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"14E16E302F87": {
"model": 20,
"cameras": {
"32CFD537A5B1": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"211AD92C1F1D": {
"model": 19,
"cameras": {
"B5E31F438C65": {
"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.60.4",
"method": "UPDATE",
"payload": {
"devices": {
"2E3C4ABBFE92": {
"model": 19,
"cameras": {
"2D637F88C67B": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"9A413BCB40B1": {
"model": 13,
"cameras": {
"2612CE239D25": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"23F88A64D2AF": {
"model": 18,
"cameras": {
"3AE18F4FE616": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"022B86E982BA": {
"model": 13,
"cameras": {
"57B069CFE9C1": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"0F2F7921CD72": {
"model": 18,
"cameras": {
"8718928845E7": {
"model": 206,
"whiteBalance": {
"auto": false,
"red": 59,
"blue": 62
}
}
}
}
}
}
}
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.60.4",
"method": "SET",
"payload": {
"devices": {
"B5F25D44D9E4": {
"model": 18,
"cameras": {
"A11E5FDBA653": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"495EE8BD1123": {
"model": 13,
"cameras": {
"E729DF773FDF": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"03578DF0946C": {
"model": 18,
"cameras": {
"825494CAA269": {
"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.60.4",
"method": "SET",
"payload": {
"devices": {
"852E0B825990": {
"model": 13,
"cameras": {
"AF875AC4BD12": {
"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