Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOcleaCam

notexported

See type declaration

4k UHD Camera

Hierarchy

Index

Properties

Properties

Optional brightness

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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "531A1CB52223": {
                "model": 13,
                "cameras": {
                    "9B731F9F1A84": {
                        "model": 206,
                        "brightness": 45
                    }
                }
            }
        }
    }
}

minimum

0

maximum

100

Optional contrast

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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "11F4B934D7D7": {
                "model": 13,
                "cameras": {
                    "D687116BCEEE": {
                        "model": 206,
                        "contrast": 45
                    }
                }
            }
        }
    }
}

minimum

0

maximum

100

Optional cpuTemp

cpuTemp?: number

CPU Temperature

description

The current temperature of the CPU in degrees Celsius.

readonly

Optional dptz

dptz?: OcleaDptz

Digital pan/tilt/zoom control

Optional exposure

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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "BE0C7A75DA04": {
                "model": 13,
                "cameras": {
                    "1BFF4F2C1691": {
                        "model": 206,
                        "exposure": {
                            "auto": true,
                            "autoExposureCompensation": 0,
                            "sensorGain": 0,
                            "shutterTime": "1/1"
                        }
                    }
                }
            }
        }
    }
}
Revolution at Manual Exposure

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/exposure/revolutionOcleaCamManualExposureSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "6682C8A39EB7": {
                "model": 13,
                "cameras": {
                    "9E1FA3FC790A": {
                        "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}$

Optional ip

ip?: string

IP address

model

model: OcleaCam

Optional osd

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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6E3B4A2F4668": {
                "model": 20,
                "cameras": {
                    "DD856AD66192": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "ABA5E318F4BB": {
                "model": 20,
                "cameras": {
                    "3AB4FCDB95FF": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DD709730A74D": {
                "model": 20,
                "cameras": {
                    "C89A5EC1466E": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "010B240181C4": {
                "model": 19,
                "cameras": {
                    "EC71A247C6D3": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "562B98318411": {
                "model": 19,
                "cameras": {
                    "7312A130A020": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "72091F9F3BEE": {
                "model": 19,
                "cameras": {
                    "BC3FD9B92C59": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "85CC39EF9735": {
                "model": 20,
                "cameras": {
                    "E2B92A681005": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BD147192FE1A": {
                "model": 20,
                "cameras": {
                    "6AE1FB747DFA": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DB61E2B0426C": {
                "model": 20,
                "cameras": {
                    "17C493062EDC": {
                        "model": 240,
                        "osd": {
                            "enabled": false
                        }
                    }
                }
            }
        }
    }
}

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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F57B6A04DB0D": {
                "model": 19,
                "cameras": {
                    "816D43594489": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "5A0E5FC16D7F": {
                "model": 19,
                "cameras": {
                    "C0D4F49C79C5": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A5266A8689A7": {
                "model": 19,
                "cameras": {
                    "C6934AFE25AD": {
                        "model": 240,
                        "osd": {
                            "enabled": false
                        }
                    }
                }
            }
        }
    }
}


Optional saturation

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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "FEA8B59B302F": {
                "model": 13,
                "cameras": {
                    "9EA75B99A7D4": {
                        "model": 206,
                        "saturation": 45
                    }
                }
            }
        }
    }
}

minimum

0

maximum

100

Optional streamMode

streamMode?: StreamMode

Camera streaming mode information.

Optional streams

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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "02A242E6D137": {
                "model": 20,
                "cameras": {
                    "853706EAF7EA": {
                        "model": 5,
                        "streams": {
                            "AD970D3BAC74": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "920BC7F9A809": {
                "model": 20,
                "cameras": {
                    "C55E83A3B125": {
                        "model": 5,
                        "streams": {
                            "D975D6A2E817": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "B82759BC44CE": {
                "model": 20,
                "cameras": {
                    "C8CBEEE99EF6": {
                        "model": 5,
                        "streams": {
                            "D912C7C5735F": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "D7D76D10BCCC": {
                "model": 20,
                "cameras": {
                    "F7B8C4439B3B": {
                        "model": 5,
                        "streams": {
                            "C26BEFD87967": {
                                "active": true,
                                "resolution": {
                                    "width": 76,
                                    "height": 47
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "D989BE9855C1": {
                "model": 19,
                "cameras": {
                    "64B9BEAA8E2F": {
                        "model": 5,
                        "streams": {
                            "1033ACA2195F": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "7A434548096D": {
                "model": 19,
                "cameras": {
                    "3969735F5639": {
                        "model": 5,
                        "streams": {
                            "F7EE49F5DB42": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "BE024437095C": {
                "model": 19,
                "cameras": {
                    "9F8B47442D37": {
                        "model": 5,
                        "streams": {
                            "0E2ECF5FFDD4": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "7257A26BB085": {
                "model": 19,
                "cameras": {
                    "0EC22BB59AF4": {
                        "model": 5,
                        "streams": {
                            "AD8831D038A4": {
                                "active": true,
                                "resolution": {
                                    "width": 28,
                                    "height": 51
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "A5D1DC9B35C0": {
                "model": 20,
                "cameras": {
                    "7A45ABA54821": {
                        "model": 240,
                        "streams": {
                            "9EF49E200502": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "BE04F7860503": {
                "model": 20,
                "cameras": {
                    "3D0E7C0106C5": {
                        "model": 240,
                        "streams": {
                            "6B4E4CA44A82": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "1E4459EBDFA1": {
                "model": 20,
                "cameras": {
                    "88C940520A6B": {
                        "model": 240,
                        "streams": {
                            "0D6F5F9587F6": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "C93ADC3FB610": {
                "model": 20,
                "cameras": {
                    "69CF6E13F7C1": {
                        "model": 240,
                        "streams": {
                            "F089D24C7FEA": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "52494F234768": {
                "model": 20,
                "cameras": {
                    "E081F990D645": {
                        "model": 240,
                        "streams": {
                            "2997079707AF": {
                                "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.57.4",
    "method": "DELETE",
    "payload": {
        "devices": {
            "91D9F34FBC2D": {
                "model": 20,
                "cameras": {
                    "ED912C3D8F29": {
                        "model": 240,
                        "streams": {
                            "65F3750A2EBE": {
                                "active": true,
                                "resolution": {
                                    "width": 18,
                                    "height": 50
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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


Optional type

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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "89EA172B6773": {
                "model": 20,
                "cameras": {
                    "A92C1C78DD0A": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7067C7590EDF": {
                "model": 20,
                "cameras": {
                    "DE9C6ABA930F": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "488640805061": {
                "model": 19,
                "cameras": {
                    "B2280133B455": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3A29623DE71C": {
                "model": 19,
                "cameras": {
                    "7C1953B18B69": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9CA6B6DA7566": {
                "model": 20,
                "cameras": {
                    "2E10EBEE48F0": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FCD7FD1561BB": {
                "model": 20,
                "cameras": {
                    "2A764A32581C": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4A2274F1D83F": {
                "model": 19,
                "cameras": {
                    "45B7871E7002": {
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "788B4897D00A": {
                "model": 19,
                "cameras": {
                    "5EF1C326D242": {
                        "model": 240,
                        "type": "AUX"
                    }
                }
            }
        }
    }
}


Optional version

version?: DeviceVersion

Version

Optional whiteBalance

whiteBalance?: { auto?: boolean; blue?: number; red?: number }

White Balance

White Balance Sample (Revolution/Pivot)
Auto White Balance

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/ocleaCam/whiteBalance/revolutionOcleaCamAutoWhiteBalanceSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "2861DD07E39D": {
                "model": 13,
                "cameras": {
                    "C0D0697B0C61": {
                        "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "87B3FC5019CF": {
                "model": 18,
                "cameras": {
                    "7695870540F1": {
                        "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "0891531C2FB9": {
                "model": 13,
                "cameras": {
                    "5AE885977D2E": {
                        "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "58090CBF1DC3": {
                "model": 18,
                "cameras": {
                    "DB405BABDEE6": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": true,
                            "red": 50,
                            "blue": 71
                        }
                    }
                }
            }
        }
    }
}

Type declaration

  • Optional auto?: boolean

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

  • Optional blue?: number

    Blue Control

    minimum

    0

    maximum

    100

  • Optional red?: number

    Red Control

    minimum

    0

    maximum

    100