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.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "D9F9D69266CC": {
                "model": 13,
                "cameras": {
                    "62A7FEBE48C8": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "21BB0BCB319B": {
                "model": 13,
                "cameras": {
                    "3AAEEADBE04E": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "BE52032BDA66": {
                "model": 13,
                "cameras": {
                    "6E3EA5C58529": {
                        "model": 206,
                        "exposure": {
                            "auto": true,
                            "autoExposureCompensation": 1,
                            "sensorGain": 0,
                            "shutterTime": "1/1"
                        }
                    }
                }
            }
        }
    }
}
Revolution at Manual Exposure

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "EBFF113C09EB": {
                "model": 13,
                "cameras": {
                    "798594EB7393": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8C6443E65D5F": {
                "model": 20,
                "cameras": {
                    "84BA8E4A9AC8": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "05B816103E52": {
                "model": 20,
                "cameras": {
                    "0F89851391AE": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A75C7D063E65": {
                "model": 20,
                "cameras": {
                    "CC07097129B2": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "07FA927823E0": {
                "model": 19,
                "cameras": {
                    "D557C2BACA1A": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7CB83C6EF8A1": {
                "model": 19,
                "cameras": {
                    "12DA0BF407C3": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B899CE322FCE": {
                "model": 19,
                "cameras": {
                    "6BBA63ABB942": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0C2C6B3805CC": {
                "model": 20,
                "cameras": {
                    "C2778DE4A70B": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FAF3B5388C2D": {
                "model": 20,
                "cameras": {
                    "1EAFA2006332": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E9B2F2CC618D": {
                "model": 20,
                "cameras": {
                    "6CC58F06B3FA": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "961DE557D410": {
                "model": 19,
                "cameras": {
                    "6D89A9DC3F5A": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BB418050A66C": {
                "model": 19,
                "cameras": {
                    "48B6CD18AEEA": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9B4CCFE85EB3": {
                "model": 19,
                "cameras": {
                    "F88716BD68F5": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "D85B2BD131FB": {
                "model": 13,
                "cameras": {
                    "3F48475508AC": {
                        "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "329CAC9DD10F": {
                "model": 20,
                "cameras": {
                    "1937C52DADE2": {
                        "model": 5,
                        "streams": {
                            "375D2A785DB3": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "ACE15B737E7F": {
                "model": 20,
                "cameras": {
                    "E7E73F2D639A": {
                        "model": 5,
                        "streams": {
                            "DE8D1F48D460": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "A174A2727E79": {
                "model": 20,
                "cameras": {
                    "0295F4CD5F4E": {
                        "model": 5,
                        "streams": {
                            "C9CC363BA676": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "654A757A125D": {
                "model": 20,
                "cameras": {
                    "7C1547B0F084": {
                        "model": 5,
                        "streams": {
                            "435CEFC2CAB1": {
                                "active": true,
                                "resolution": {
                                    "width": 93,
                                    "height": 92
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Camera Stream Samples (A200)
A200 with a 480p stream

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "A3496583AC9D": {
                "model": 19,
                "cameras": {
                    "CF0F5801F28A": {
                        "model": 5,
                        "streams": {
                            "C2C694D90E51": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "B3AF94E03C12": {
                "model": 19,
                "cameras": {
                    "522F3CA1B505": {
                        "model": 5,
                        "streams": {
                            "D13F5C605048": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "7E416A85F588": {
                "model": 19,
                "cameras": {
                    "707DEB0ABD84": {
                        "model": 5,
                        "streams": {
                            "62884FEB22A4": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "4528BEE1258C": {
                "model": 19,
                "cameras": {
                    "3E90922D1B2C": {
                        "model": 5,
                        "streams": {
                            "A413E1534C66": {
                                "active": true,
                                "resolution": {
                                    "width": 4,
                                    "height": 41
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "78EE944D281C": {
                "model": 20,
                "cameras": {
                    "17C7BA6C5142": {
                        "model": 240,
                        "streams": {
                            "4D445220626E": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "160012F674F5": {
                "model": 20,
                "cameras": {
                    "ECFC2D47B65F": {
                        "model": 240,
                        "streams": {
                            "6D4B14449138": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "D42AF098B547": {
                "model": 20,
                "cameras": {
                    "ABA75CEE4863": {
                        "model": 240,
                        "streams": {
                            "4DF1731A851D": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "FDD74AACFF2C": {
                "model": 20,
                "cameras": {
                    "E622ED690025": {
                        "model": 240,
                        "streams": {
                            "756255AF201A": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "053D9BE9866B": {
                "model": 20,
                "cameras": {
                    "A6B1678320CE": {
                        "model": 240,
                        "streams": {
                            "FB810217DE15": {
                                "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.9",
    "method": "DELETE",
    "payload": {
        "devices": {
            "32A6CFCCB05B": {
                "model": 20,
                "cameras": {
                    "2067D396C86B": {
                        "model": 240,
                        "streams": {
                            "9DA0F32EF7E8": {
                                "active": true,
                                "resolution": {
                                    "width": 69,
                                    "height": 92
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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


Optional turbidityFilter

turbidityFilter?: TurbidityFilter

Turbidity filter settings for supported oclea versions

Turbidity filter Strength Example Payload (4k UHD Camera)
Revolution at MAX strength

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/OcleaCamera/turbidityStrength/revolutionOcleaCameraTurbidityStrengthMaxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "E5513F6AE2AC": {
                "model": 13,
                "cameras": {
                    "BCE6F73D5077": {
                        "model": 206,
                        "turbidityFilter": {
                            "strength": 30
                        }
                    }
                }
            }
        }
    }
}
Revolution at MIN strength

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/OcleaCamera/turbidityStrength/revolutionOcleaCameraTurbidityStrengthMinSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "4CC41E66C55F": {
                "model": 13,
                "cameras": {
                    "D7AB46F92C8C": {
                        "model": 206,
                        "turbidityFilter": {
                            "strength": 1
                        }
                    }
                }
            }
        }
    }
}
Revolution at RANDOM strength

From ./dist/samples/json/requests/devices/vehicles/revolution/cameras/OcleaCamera/turbidityStrength/revolutionOcleaCameraTurbidityStrengthRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "03E42E4F96A2": {
                "model": 13,
                "cameras": {
                    "A49F4F1F1A34": {
                        "model": 206,
                        "turbidityFilter": {
                            "strength": 14
                        }
                    }
                }
            }
        }
    }
}
Pivot at MAX strength

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/OcleaCamera/turbidityStrength/pivotOcleaCameraTurbidityStrengthMaxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "94FE135CB8DA": {
                "model": 18,
                "cameras": {
                    "664C67A91004": {
                        "model": 206,
                        "turbidityFilter": {
                            "strength": 30
                        }
                    }
                }
            }
        }
    }
}
Pivot at MIN strength

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/OcleaCamera/turbidityStrength/pivotOcleaCameraTurbidityStrengthMinSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "D64F27D33EC5": {
                "model": 18,
                "cameras": {
                    "4581C4723232": {
                        "model": 206,
                        "turbidityFilter": {
                            "strength": 1
                        }
                    }
                }
            }
        }
    }
}
Pivot at RANDOM strength

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/OcleaCamera/turbidityStrength/pivotOcleaCameraTurbidityStrengthRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "B25A41B1FE3A": {
                "model": 18,
                "cameras": {
                    "9EA0A0A7CA9B": {
                        "model": 206,
                        "turbidityFilter": {
                            "strength": 7
                        }
                    }
                }
            }
        }
    }
}

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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "44ACE2AB4995": {
                "model": 20,
                "cameras": {
                    "1379DA3BB035": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C90CFD65B411": {
                "model": 20,
                "cameras": {
                    "AEF640757A84": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9325BF925BAD": {
                "model": 19,
                "cameras": {
                    "7380F99BD953": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0402AC3D5A21": {
                "model": 19,
                "cameras": {
                    "034D28BA5CC9": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "45E5F9B81ACC": {
                "model": 20,
                "cameras": {
                    "8C0D0B0FBBDF": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "50D754FF2082": {
                "model": 20,
                "cameras": {
                    "F62D463FFB51": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CEF3B5A45629": {
                "model": 19,
                "cameras": {
                    "1C4E32D2E570": {
                        "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.9",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CB17E3051052": {
                "model": 19,
                "cameras": {
                    "43E1F9BD6FA0": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "EC5653DEE8EA": {
                "model": 13,
                "cameras": {
                    "CCC507245AF0": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "66E289676B4F": {
                "model": 18,
                "cameras": {
                    "A6E982AE742C": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "879F4CCDD98D": {
                "model": 13,
                "cameras": {
                    "F97E7B00426C": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "DA8FF37B3302": {
                "model": 18,
                "cameras": {
                    "97F67A4C45F5": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": false,
                            "red": 47,
                            "blue": 24
                        }
                    }
                }
            }
        }
    }
}
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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "3879B8BD8D2D": {
                "model": 18,
                "cameras": {
                    "2FB5B2659272": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "E2864CB5BEEE": {
                "model": 13,
                "cameras": {
                    "6A2949716FC7": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "EBB48C53C24E": {
                "model": 18,
                "cameras": {
                    "38800581F9E0": {
                        "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.9",
    "method": "SET",
    "payload": {
        "devices": {
            "89D36DB70C62": {
                "model": 13,
                "cameras": {
                    "DFEC5BFC1360": {
                        "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