IOcleaCam | Deep Trekker BRIDGE API

notexported

See type declaration

4k UHD Camera

Hierarchy

OcleaCam
- IOcleaCam

Index

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.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "ECC4920D9CE0": {
                "model": 13,
                "cameras": {
                    "41E8491179E5": {
                        "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.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "7CDD5C78E13D": {
                "model": 13,
                "cameras": {
                    "017D207D4929": {
                        "model": 206,
                        "contrast": 45
                    }
                }
            }
        }
    }
}

minimum: 0
maximum: 100

Optional cpuTemp

cpuTemp?: number

Camera cpu temperature in 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.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "3EAE549C6F07": {
                "model": 13,
                "cameras": {
                    "E6A9D331E9D9": {
                        "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.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "87F3BA71AF24": {
                "model": 13,
                "cameras": {
                    "2FECF11166C5": {
                        "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.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "07934D7BD954": {
                "model": 20,
                "cameras": {
                    "CF47B39D3100": {
                        "model": 5,
                        "osd": {
                            "enabled": true
                        }
                    }
                }
            }
        }
    }
}

A150 with Osd Disabled

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdDisabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "ACEDCAFE14A1": {
                "model": 20,
                "cameras": {
                    "659EB84B0151": {
                        "model": 5,
                        "osd": {
                            "enabled": false
                        }
                    }
                }
            }
        }
    }
}

A150 with Random Osd

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/osd/a150DTCamOsdRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9367B038D02F": {
                "model": 20,
                "cameras": {
                    "44E37912F3EF": {
                        "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.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F55D632B9F13": {
                "model": 19,
                "cameras": {
                    "E03E7C878B4C": {
                        "model": 5,
                        "osd": {
                            "enabled": true
                        }
                    }
                }
            }
        }
    }
}

A200 with Osd Disabled

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdDisabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "815FA48088C2": {
                "model": 19,
                "cameras": {
                    "1FC71BC8AAE5": {
                        "model": 5,
                        "osd": {
                            "enabled": false
                        }
                    }
                }
            }
        }
    }
}

A200 with Random Osd

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/osd/a200DTCamOsdRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "67F68F295400": {
                "model": 19,
                "cameras": {
                    "D831BC08ACDA": {
                        "model": 5,
                        "osd": {
                            "enabled": false
                        }
                    }
                }
            }
        }
    }
}

Example Payload (Tamron Harrier Zoom Camera)

Osd Samples (A150)

A150 with Osd Enabled

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdEnabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6F6B7A7647CB": {
                "model": 20,
                "cameras": {
                    "3B2C701687AA": {
                        "model": 240,
                        "osd": {
                            "enabled": true
                        }
                    }
                }
            }
        }
    }
}

A150 with Osd Disabled

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdDisabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "5947A3FCBD75": {
                "model": 20,
                "cameras": {
                    "B815DABB4DBB": {
                        "model": 240,
                        "osd": {
                            "enabled": false
                        }
                    }
                }
            }
        }
    }
}

A150 with Random Osd

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/osd/a150TamronHarrierZoomCameraOsdRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "1175FFA4750D": {
                "model": 20,
                "cameras": {
                    "5CD3B08511D1": {
                        "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.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BAD36825C249": {
                "model": 19,
                "cameras": {
                    "041ADA80F8D6": {
                        "model": 240,
                        "osd": {
                            "enabled": true
                        }
                    }
                }
            }
        }
    }
}

A200 with Osd Disabled

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdDisabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B47948E4FA66": {
                "model": 19,
                "cameras": {
                    "25433F425EBD": {
                        "model": 240,
                        "osd": {
                            "enabled": false
                        }
                    }
                }
            }
        }
    }
}

A200 with Random Osd

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/osd/a200TamronHarrierZoomCameraOsdRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8C0B00DD72C0": {
                "model": 19,
                "cameras": {
                    "19B1E4DD72E5": {
                        "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.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "E7C2279B78B2": {
                "model": 13,
                "cameras": {
                    "AF9B85E77AD0": {
                        "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.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "C464065F7A5D": {
                "model": 20,
                "cameras": {
                    "318FAC6E5F4B": {
                        "model": 5,
                        "streams": {
                            "CFEFE9C4194F": {
                                "active": true,
                                "resolution": {
                                    "width": 854,
                                    "height": 480
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A150 with a 720p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/streams/a150DTCamStream720pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "483AB5C56190": {
                "model": 20,
                "cameras": {
                    "ECB4198DE83E": {
                        "model": 5,
                        "streams": {
                            "EA7B2864B4ED": {
                                "active": true,
                                "resolution": {
                                    "width": 1280,
                                    "height": 720
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A150 with a 1080p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/streams/a150DTCamStream1080pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "016134A62B98": {
                "model": 20,
                "cameras": {
                    "546BA9D4B336": {
                        "model": 5,
                        "streams": {
                            "2B3071AC0053": {
                                "active": true
                            }
                        }
                    }
                }
            }
        }
    }
}

A150 with a random stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/streams/a150DTCamStreamRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "3894BFC44A84": {
                "model": 20,
                "cameras": {
                    "1D5851FF1016": {
                        "model": 5,
                        "streams": {
                            "57B300FCBD0E": {
                                "active": true,
                                "resolution": {
                                    "width": 18,
                                    "height": 45
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Camera Stream Samples (A200)

A200 with a 480p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/streams/a200DTCamStream480pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "41D82321C244": {
                "model": 19,
                "cameras": {
                    "8522BD625F4C": {
                        "model": 5,
                        "streams": {
                            "27D564F0517F": {
                                "active": true,
                                "resolution": {
                                    "width": 854,
                                    "height": 480
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A200 with a 720p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/streams/a200DTCamStream720pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "6BD7BD874036": {
                "model": 19,
                "cameras": {
                    "F816594B9A66": {
                        "model": 5,
                        "streams": {
                            "6439D82E8F86": {
                                "active": true,
                                "resolution": {
                                    "width": 1280,
                                    "height": 720
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A200 with a 1080p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/streams/a200DTCamStream1080pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "447749B8E4A2": {
                "model": 19,
                "cameras": {
                    "3FEE3EEA9DCB": {
                        "model": 5,
                        "streams": {
                            "2E084BCF6981": {
                                "active": true,
                                "resolution": {
                                    "width": 1920,
                                    "height": 1080
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A200 with a random stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/streams/a200DTCamStreamRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "89DAE992604D": {
                "model": 19,
                "cameras": {
                    "DB5042C6E7D8": {
                        "model": 5,
                        "streams": {
                            "DCC5BFD3D5FF": {
                                "active": true,
                                "resolution": {
                                    "width": 25,
                                    "height": 95
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Example Payload (Tamron Harrier Zoom Camera)

Camera Stream Samples (A150)

A150 with a 480p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream480pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "53D66045799E": {
                "model": 20,
                "cameras": {
                    "C743E3211305": {
                        "model": 240,
                        "streams": {
                            "F9C3CF0297A0": {
                                "active": true,
                                "resolution": {
                                    "width": 854,
                                    "height": 480
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A150 with a 720p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream720pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "69BF98F3AE45": {
                "model": 20,
                "cameras": {
                    "509D6ECA71D8": {
                        "model": 240,
                        "streams": {
                            "E977578FF65D": {
                                "active": true,
                                "resolution": {
                                    "width": 1280,
                                    "height": 720
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A150 with a 1080p stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream1080pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "6E1303683BA9": {
                "model": 20,
                "cameras": {
                    "05C20277BD28": {
                        "model": 240,
                        "streams": {
                            "C06B8C5D1D2B": {
                                "active": true
                            }
                        }
                    }
                }
            }
        }
    }
}

A150 with a 2k stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream2kSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "4A994D83DDE6": {
                "model": 20,
                "cameras": {
                    "04D7A028896E": {
                        "model": 240,
                        "streams": {
                            "42DCAB16A1D4": {
                                "active": true,
                                "resolution": {
                                    "width": 2560,
                                    "height": 1440
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A150 with a 4k stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStream4kSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "F19F418AA710": {
                "model": 20,
                "cameras": {
                    "0DD9C6ECCFDB": {
                        "model": 240,
                        "streams": {
                            "03CC409F0925": {
                                "active": true,
                                "resolution": {
                                    "width": 3840,
                                    "height": 2160
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

A150 with a random stream

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/streams/a150TamronHarrierZoomCameraStreamRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "8F6D06D06BD4": {
                "model": 20,
                "cameras": {
                    "5CF7F5D8CD27": {
                        "model": 240,
                        "streams": {
                            "1164F364D205": {
                                "active": true,
                                "resolution": {
                                    "width": 17,
                                    "height": 95
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Camera Stream Samples (A200)

A200 with a 480p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream480pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {}
}

A200 with a 720p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream720pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {}
}

A200 with a 1080p stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream1080pSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {}
}

A200 with a 2k stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream2kSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {}
}

A200 with a 4k stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStream4kSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {}
}

A200 with a random stream

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/streams/a200TamronHarrierZoomCameraStreamRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {}
}

Optional turbidityFilter

turbidityFilter?: TurbidityFilter

Turbidity filter settings for supported oclea versions

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.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7EE603EA83E8": {
                "model": 20,
                "cameras": {
                    "0508B47B9A2E": {
                        "model": 5,
                        "type": "MAIN"
                    }
                }
            }
        }
    }
}

A150 Aux Camera Type

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/dtCam/type/a150DTCamTypeAuxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6F8A6D70C432": {
                "model": 20,
                "cameras": {
                    "169D0B54B6AB": {
                        "model": 5,
                        "type": "AUX"
                    }
                }
            }
        }
    }
}

Camera Type Samples (A200)

A200 Main Camera Type

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/type/a200DTCamTypeMainSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D9C7673D24E8": {
                "model": 19,
                "cameras": {
                    "D9C144D30A24": {
                        "model": 5,
                        "type": "MAIN"
                    }
                }
            }
        }
    }
}

A200 Aux Camera Type

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/dtCam/type/a200DTCamTypeAuxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "393FBD556674": {
                "model": 19,
                "cameras": {
                    "662671F1F784": {
                        "model": 5,
                        "type": "AUX"
                    }
                }
            }
        }
    }
}

Example Payload (Tamron Harrier Zoom Camera)

Camera Type Samples (A150)

A150 Main Camera Type

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/type/a150TamronHarrierZoomCameraTypeMainSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0866C1E3557B": {
                "model": 20,
                "cameras": {
                    "5278ADBA7C78": {
                        "model": 240,
                        "type": "MAIN"
                    }
                }
            }
        }
    }
}

A150 Aux Camera Type

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/tamronHarrierZoomCamera/type/a150TamronHarrierZoomCameraTypeAuxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "702BBC12CF13": {
                "model": 20,
                "cameras": {
                    "2459B6F89767": {
                        "model": 240,
                        "type": "AUX"
                    }
                }
            }
        }
    }
}

Camera Type Samples (A200)

A200 Main Camera Type

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/type/a200TamronHarrierZoomCameraTypeMainSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "19F06B70302D": {
                "model": 19,
                "cameras": {
                    "CCDE0F4DB6DA": {
                        "model": 240,
                        "type": "MAIN"
                    }
                }
            }
        }
    }
}

A200 Aux Camera Type

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/tamronHarrierZoomCamera/type/a200TamronHarrierZoomCameraTypeAuxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "46B8CDD3F505": {
                "model": 19,
                "cameras": {
                    "1B844E1D70EC": {
                        "model": 240,
                        "type": "AUX"
                    }
                }
            }
        }
    }
}

Optional version

version?: DeviceVersion

Version

Optional whiteBalance

whiteBalance?: { auto?: boolean; awbMode?: string; awbModeOptions?: string[]; blue?: number; red?: number }

White Balance

White Balance Sample (Revolution/Pivot)

Auto White Balance

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "BD2E544E8155": {
                "model": 13,
                "cameras": {
                    "B26FE2F78297": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": true,
                            "red": 0,
                            "blue": 0
                        }
                    }
                }
            }
        }
    }
}

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamAutoWhiteBalanceSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "C15FDE00BD47": {
                "model": 18,
                "cameras": {
                    "7C1E82F7DC6F": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": true,
                            "red": 0,
                            "blue": 0
                        }
                    }
                }
            }
        }
    }
}

Manual White Balance

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "4D72729DB1FC": {
                "model": 13,
                "cameras": {
                    "21A594CF9A98": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": false,
                            "red": 50,
                            "blue": 45
                        }
                    }
                }
            }
        }
    }
}

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamManualWhiteBalanceSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "3F07B46E3056": {
                "model": 18,
                "cameras": {
                    "BE08CB16D1FB": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": true,
                            "red": 42,
                            "blue": 0
                        }
                    }
                }
            }
        }
    }
}

Auto WB Mode samples

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamAutoWhiteBalanceAirModeSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "E376086E4D82": {
                "model": 18,
                "cameras": {
                    "0D5991721913": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": true,
                            "awbMode": "air"
                        }
                    }
                }
            }
        }
    }
}

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "210456F65FE3": {
                "model": 13,
                "cameras": {
                    "75CE00207BDD": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": true,
                            "awbMode": "air"
                        }
                    }
                }
            }
        }
    }
}

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/ocleaCam/whiteBalance/pivotOcleaCamAutoWhiteBalanceUnderwaterModeSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "84F36DC8698C": {
                "model": 18,
                "cameras": {
                    "8F1BC0CCAA1F": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": true,
                            "awbMode": "underwater"
                        }
                    }
                }
            }
        }
    }
}

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "50DD039C45AB": {
                "model": 13,
                "cameras": {
                    "EFD5B2FC714D": {
                        "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

Hierarchy

Index

Properties

Properties

Optional brightness

Brightness Sample (Revolution/Pivot)

Optional contrast

Contrast Sample (Revolution/Pivot)

Optional cpuTemp

Optional dptz

Optional exposure

Exposure Example Payload (4k UHD Camera)

Revolution at Auto Exposure

Revolution at Manual Exposure

Type declaration

Optional auto?: boolean

Optional autoExposureCompensation?: number

Optional sensorGain?: number

Optional shutterTime?: string

Optional ip

model

Optional osd

Example Payload (Standard 1080p Camera)

Osd Samples (A150)

A150 with Osd Enabled

A150 with Osd Disabled

A150 with Random Osd

Osd Samples (A200)

A200 with Osd Enabled

A200 with Osd Disabled

A200 with Random Osd

Example Payload (Tamron Harrier Zoom Camera)

Osd Samples (A150)

A150 with Osd Enabled

A150 with Osd Disabled

A150 with Random Osd

Osd Samples (A200)

A200 with Osd Enabled

A200 with Osd Disabled

A200 with Random Osd

Optional saturation

Saturation Sample (Revolution/Pivot)

Optional streamMode

Optional streams

Example Payload (Standard 1080p Camera)

Camera Stream Samples (A150)

A150 with a 480p stream

A150 with a 720p stream

A150 with a 1080p stream

A150 with a random stream

Camera Stream Samples (A200)

A200 with a 480p stream

A200 with a 720p stream

A200 with a 1080p stream

A200 with a random stream

Example Payload (Tamron Harrier Zoom Camera)

Camera Stream Samples (A150)

A150 with a 480p stream

A150 with a 720p stream

A150 with a 1080p stream

A150 with a 2k stream

A150 with a 4k stream

A150 with a random stream

Camera Stream Samples (A200)

A200 with a 480p stream

A200 with a 720p stream

A200 with a 1080p stream

A200 with a 2k stream

A200 with a 4k stream

A200 with a random stream

Optional turbidityFilter

Optional type

Example Payload (Standard 1080p Camera)

Camera Type Samples (A150)

A150 Main Camera Type

A150 Aux Camera Type

Camera Type Samples (A200)

A200 Main Camera Type

A200 Aux Camera Type

Example Payload (Tamron Harrier Zoom Camera)