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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "37A37B20CBE8": {
                "model": 13,
                "cameras": {
                    "CF54ADDD6B36": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "46A03253A3FE": {
                "model": 13,
                "cameras": {
                    "B93C721CE5EF": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "E558633AF212": {
                "model": 13,
                "cameras": {
                    "FACB5C18E37E": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "703F62691192": {
                "model": 13,
                "cameras": {
                    "19EC389D8781": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CAA19FD95028": {
                "model": 20,
                "cameras": {
                    "8F6C451DC5FD": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D75A3F19FC6E": {
                "model": 20,
                "cameras": {
                    "2296C72611C9": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3E34DD3B78B6": {
                "model": 20,
                "cameras": {
                    "840F3426E1A6": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9CAA6F9AC1E7": {
                "model": 19,
                "cameras": {
                    "B8A70F2141D9": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DA8A2F35F66A": {
                "model": 19,
                "cameras": {
                    "710CC7401524": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "AC5B757AD1D2": {
                "model": 19,
                "cameras": {
                    "349AEF822BDF": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F0A8D9D291F5": {
                "model": 20,
                "cameras": {
                    "E7B2D53896D4": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F6C6321C0BB5": {
                "model": 20,
                "cameras": {
                    "69D99C22D53E": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "47746FAFEE2E": {
                "model": 20,
                "cameras": {
                    "1172362DDA4D": {
                        "model": 240,
                        "osd": {
                            "enabled": true
                        }
                    }
                }
            }
        }
    }
}

Osd Samples (A200)
A200 with Osd Enabled

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "79ADC8E8E1A4": {
                "model": 19,
                "cameras": {
                    "7FD64C201420": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "77098EE3DE2E": {
                "model": 19,
                "cameras": {
                    "CBA65E3EB870": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "08EB47ABB95C": {
                "model": 19,
                "cameras": {
                    "681BED26E93A": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "E388B0DB6C12": {
                "model": 13,
                "cameras": {
                    "FF8728D14CD1": {
                        "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "A8176C4FCBAA": {
                "model": 20,
                "cameras": {
                    "196A030D1EEB": {
                        "model": 5,
                        "streams": {
                            "618E9FD31FE4": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "0EE656ED521A": {
                "model": 20,
                "cameras": {
                    "37F1D96B0BEF": {
                        "model": 5,
                        "streams": {
                            "C3946642AEC6": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "E7C25E3DC7EA": {
                "model": 20,
                "cameras": {
                    "1756A68BECF2": {
                        "model": 5,
                        "streams": {
                            "91E7D5F2DA8B": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "1582E6E9E105": {
                "model": 20,
                "cameras": {
                    "14D5DA0A3FD4": {
                        "model": 5,
                        "streams": {
                            "E6BD917D393D": {
                                "active": true,
                                "resolution": {
                                    "width": 54,
                                    "height": 23
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "FB172394C21C": {
                "model": 19,
                "cameras": {
                    "A2DB8FCF9CFD": {
                        "model": 5,
                        "streams": {
                            "CEC42E5ABDC1": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "7BD664EA9D42": {
                "model": 19,
                "cameras": {
                    "6AE3776AA537": {
                        "model": 5,
                        "streams": {
                            "3211C8A2D470": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "E84476A92607": {
                "model": 19,
                "cameras": {
                    "88FD971F3C0E": {
                        "model": 5,
                        "streams": {
                            "03145305C899": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "5B3595E932F5": {
                "model": 19,
                "cameras": {
                    "34279F90ED91": {
                        "model": 5,
                        "streams": {
                            "9A75A340C8DC": {
                                "active": true,
                                "resolution": {
                                    "width": 97,
                                    "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "852630311ACF": {
                "model": 20,
                "cameras": {
                    "8D380A80BA21": {
                        "model": 240,
                        "streams": {
                            "F9D52026C3F9": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "B4D6C8D23DE0": {
                "model": 20,
                "cameras": {
                    "BBE9F2840EE7": {
                        "model": 240,
                        "streams": {
                            "CB0A2C7397C4": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "174A3ABC7D02": {
                "model": 20,
                "cameras": {
                    "6AB4FE948B3D": {
                        "model": 240,
                        "streams": {
                            "262719F0F3AA": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "7CABC66F4039": {
                "model": 20,
                "cameras": {
                    "6DE6593A7C62": {
                        "model": 240,
                        "streams": {
                            "253D3CBA51A3": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "512468DA83DC": {
                "model": 20,
                "cameras": {
                    "A34EAACE61AF": {
                        "model": 240,
                        "streams": {
                            "703E20357BD4": {
                                "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.15",
    "method": "DELETE",
    "payload": {
        "devices": {
            "C9C703C775C9": {
                "model": 20,
                "cameras": {
                    "88184AEBE362": {
                        "model": 240,
                        "streams": {
                            "A26BA2B03B1F": {
                                "active": true,
                                "resolution": {
                                    "width": 68,
                                    "height": 82
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

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.15",
    "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.15",
    "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.15",
    "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.15",
    "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.15",
    "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.15",
    "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "9A866F3E553C": {
                "model": 13,
                "cameras": {
                    "353EF569C929": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "08BBB0295C6A": {
                "model": 13,
                "cameras": {
                    "FDF7EDFF0DB4": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "B46DD2517304": {
                "model": 13,
                "cameras": {
                    "3693F4653800": {
                        "model": 206,
                        "turbidityFilter": {
                            "strength": 5
                        }
                    }
                }
            }
        }
    }
}
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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "1F53905AE0C6": {
                "model": 18,
                "cameras": {
                    "399EA6320136": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "8BB11B94A904": {
                "model": 18,
                "cameras": {
                    "9C95C13B377E": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "7D1F367F5BB8": {
                "model": 18,
                "cameras": {
                    "1DE95F89A2DF": {
                        "model": 206,
                        "turbidityFilter": {
                            "strength": 2
                        }
                    }
                }
            }
        }
    }
}

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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6BDE60ADD391": {
                "model": 20,
                "cameras": {
                    "CF7AD72DE610": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "1C0C69527850": {
                "model": 20,
                "cameras": {
                    "71A43B08E57B": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A62B29EAADB9": {
                "model": 19,
                "cameras": {
                    "27B8EC47FAE5": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A7E69A0EB723": {
                "model": 19,
                "cameras": {
                    "214BE9042A27": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F14343D207EE": {
                "model": 20,
                "cameras": {
                    "28AA8FB15F38": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2481E118C6AB": {
                "model": 20,
                "cameras": {
                    "6DBF7870A77D": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "431B18832AC2": {
                "model": 19,
                "cameras": {
                    "CF07986FB6FC": {
                        "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.15",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2E28E36FAEDC": {
                "model": 19,
                "cameras": {
                    "E9E799B9B9F3": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "1203967CC655": {
                "model": 13,
                "cameras": {
                    "BDFED9DDF83C": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "BB9A6AC91377": {
                "model": 18,
                "cameras": {
                    "1F33A356D09F": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "6BD159674307": {
                "model": 13,
                "cameras": {
                    "B31E7C182C8F": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "AFCB545368C6": {
                "model": 18,
                "cameras": {
                    "97DB901C57C1": {
                        "model": 206,
                        "whiteBalance": {
                            "auto": true,
                            "red": 8,
                            "blue": 23
                        }
                    }
                }
            }
        }
    }
}
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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "C8C164ADC1F9": {
                "model": 18,
                "cameras": {
                    "43E632F7519A": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "83BF689A9B76": {
                "model": 13,
                "cameras": {
                    "1F89F45C264B": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "846B227C9CA9": {
                "model": 18,
                "cameras": {
                    "2CF164E81A00": {
                        "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.15",
    "method": "SET",
    "payload": {
        "devices": {
            "6AD75FC70F4E": {
                "model": 13,
                "cameras": {
                    "E91A8A7FD714": {
                        "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