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.59.0",
"method": "SET",
"payload": {
"devices": {
"238F1CA67C17": {
"model": 13,
"cameras": {
"7ECC76867C96": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"717A589542E5": {
"model": 13,
"cameras": {
"419B3B0D08F2": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"24B2F77E3BB4": {
"model": 13,
"cameras": {
"6B837BF85A9B": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"99D297BD42A2": {
"model": 13,
"cameras": {
"03B50687D622": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"4BDA8835394D": {
"model": 20,
"cameras": {
"27F84A065DA4": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"388DF6E5699A": {
"model": 20,
"cameras": {
"27068D6ABABD": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"63BD0110D846": {
"model": 20,
"cameras": {
"E8135C6588A9": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"95B8BB76FA8C": {
"model": 19,
"cameras": {
"5E62EF347B64": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"1F461AEF3B3A": {
"model": 19,
"cameras": {
"A665C2152F34": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"DC46F2095FB7": {
"model": 19,
"cameras": {
"AC06307BB01A": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"957B607CB55A": {
"model": 20,
"cameras": {
"C5A73FA10705": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"E7BE4DF3F33B": {
"model": 20,
"cameras": {
"0748CCC11A7C": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"3906756054C4": {
"model": 20,
"cameras": {
"FC948A516054": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"74FA5F6D48AF": {
"model": 19,
"cameras": {
"5F8C8CD69EC1": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"A4AC04627115": {
"model": 19,
"cameras": {
"6C989B2DCE67": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"FE09A6B3C8C5": {
"model": 19,
"cameras": {
"6940113C814A": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"98233CE719FE": {
"model": 13,
"cameras": {
"DC2035B31478": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"AB390708C93F": {
"model": 20,
"cameras": {
"ECACBD752332": {
"model": 5,
"streams": {
"1C99FDA601F9": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"6D47327E91DA": {
"model": 20,
"cameras": {
"5F2F4A93B540": {
"model": 5,
"streams": {
"3745326C425E": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"BD1F43AE6CFC": {
"model": 20,
"cameras": {
"93AC23C1A361": {
"model": 5,
"streams": {
"02040F290CA8": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"7280776809D5": {
"model": 20,
"cameras": {
"F839EF7294B2": {
"model": 5,
"streams": {
"5BE8F65D4F76": {
"active": true,
"resolution": {
"width": 44,
"height": 68
}
}
}
}
}
}
}
}
}

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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"DC7820A01490": {
"model": 19,
"cameras": {
"4A2CB8FDB89B": {
"model": 5,
"streams": {
"57BEC7885959": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"7A9BF5E47DB2": {
"model": 19,
"cameras": {
"20261BD14096": {
"model": 5,
"streams": {
"173D2513449C": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"5E534355CA78": {
"model": 19,
"cameras": {
"8C8A8D51D38F": {
"model": 5,
"streams": {
"64AD525BA3D7": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"2D87ED10CB4E": {
"model": 19,
"cameras": {
"16D5BCA4B59A": {
"model": 5,
"streams": {
"6D6BD89B41AB": {
"active": true,
"resolution": {
"width": 42,
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"AA2FCF9C0811": {
"model": 20,
"cameras": {
"FB9FEB476A03": {
"model": 240,
"streams": {
"F01D649264C9": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"E84CF7E7C3B2": {
"model": 20,
"cameras": {
"A3DD292E2BCD": {
"model": 240,
"streams": {
"5EA5065077E1": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"DBD1AF22D172": {
"model": 20,
"cameras": {
"29EFDD682C64": {
"model": 240,
"streams": {
"E28CC2E73742": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"DCE2A1F556C9": {
"model": 20,
"cameras": {
"9C678483E924": {
"model": 240,
"streams": {
"251455E026A6": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"09368BD0A010": {
"model": 20,
"cameras": {
"E968CF88D9CE": {
"model": 240,
"streams": {
"D364F06EE8E5": {
"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.59.0",
"method": "DELETE",
"payload": {
"devices": {
"991AB0D196FB": {
"model": 20,
"cameras": {
"C7EDB90DC235": {
"model": 240,
"streams": {
"0A6C68CC236E": {
"active": true,
"resolution": {
"width": 91,
"height": 4
}
}
}
}
}
}
}
}
}

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.59.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.59.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.59.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.59.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.59.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.59.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.59.0",
"method": "SET",
"payload": {
"devices": {
"9F4B63B8234A": {
"model": 13,
"cameras": {
"A6E88E592A6B": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"F03DD2647581": {
"model": 13,
"cameras": {
"DDF3B99CCDE0": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"386E268F0033": {
"model": 13,
"cameras": {
"982D055F09AC": {
"model": 206,
"turbidityFilter": {
"strength": 28
}
}
}
}
}
}
}
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.59.0",
"method": "SET",
"payload": {
"devices": {
"7321585DFFDB": {
"model": 18,
"cameras": {
"DAE005F024AC": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"BBB4C7EAB2C2": {
"model": 18,
"cameras": {
"34F6CF4412ED": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"1D0405B4A9ED": {
"model": 18,
"cameras": {
"0E2E53E5E6BB": {
"model": 206,
"turbidityFilter": {
"strength": 11
}
}
}
}
}
}
}

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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"7A0C7FA8B661": {
"model": 20,
"cameras": {
"CE43843CE9CF": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"419A728CC897": {
"model": 20,
"cameras": {
"A1F88826D6E9": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"F488DC30A737": {
"model": 19,
"cameras": {
"54F9934534A9": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"45AA21AF7CAC": {
"model": 19,
"cameras": {
"58EBA14E1B4A": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"B8EBE88D251C": {
"model": 20,
"cameras": {
"13585C2D33EB": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"91C6306CE855": {
"model": 20,
"cameras": {
"C47F25A66280": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"E3E6658C720F": {
"model": 19,
"cameras": {
"2AB6EC190059": {
"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.59.0",
"method": "UPDATE",
"payload": {
"devices": {
"8002675030D4": {
"model": 19,
"cameras": {
"FCF6F5146649": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"A1B65356DBD6": {
"model": 13,
"cameras": {
"AA984BE617D8": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"A3AB9E165B45": {
"model": 18,
"cameras": {
"09635F564567": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"4D303023573C": {
"model": 13,
"cameras": {
"6E32D8848A5A": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"A115325E6716": {
"model": 18,
"cameras": {
"20BCD3BF1119": {
"model": 206,
"whiteBalance": {
"auto": true,
"red": 58,
"blue": 95
}
}
}
}
}
}
}
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.59.0",
"method": "SET",
"payload": {
"devices": {
"2E5A74B3FBDF": {
"model": 18,
"cameras": {
"91808170F496": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"65359CEDC794": {
"model": 13,
"cameras": {
"B1ED939A3A90": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"68B1B38F0868": {
"model": 18,
"cameras": {
"98DF0781430C": {
"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.59.0",
"method": "SET",
"payload": {
"devices": {
"993CE390D782": {
"model": 13,
"cameras": {
"CF17F95A902F": {
"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