Options
All
  • Public
  • Public/Protected
  • All
Menu
notexported

See type declaration

Base ROV

Hierarchy

  • Rov
    • IRov

Index

Properties

altitude?: number

Rov altitude

Measured in meters to show relative distance to floor.

Example Payloads

GET Requests

  • Random altitude

    From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "870EE9FF7C82": {
    "model": 18,
    "altitude": 139
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E62604272551": {
    "model": 13,
    "altitudeValid": false
    }
    }
    }
    }
readonly
altitudeValid?: boolean

Rov altitude valid

Altitude validity flag

Example Payloads

UPDATE Requests

  • Invalid altitude (bad data)

    From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeInvalidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5C9FCCC3CB31": {
    "model": 18,
    "altitudeValid": false
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeInvalidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "36FE4EA2734E": {
    "model": 13,
    "altitudeValid": false
    }
    }
    }
    }
  • Valid altitude (good data)

    From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "2E2C848668E2": {
    "model": 18,
    "altitude": 136,
    "altitudeValid": true
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E0FBE4E15B29": {
    "model": 13,
    "altitudeValid": false,
    "altitude": 60
    }
    }
    }
    }
  • Random altitude validity

    From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeValidRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "104BCFE9468B": {
    "model": 18,
    "altitudeValid": true
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/altitude/revolutionAltitudeValidRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E62604272551": {
    "model": 13,
    "altitudeValid": false
    }
    }
    }
    }
readonly
bodyLeak?: boolean

Body Leak Fault

Example Payloads

UPDATE Requests

  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionBodyLeakRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "59099E4F713E": {
    "model": 13,
    "bodyLeak": true
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotBodyLeakRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C56EEA365A34": {
    "model": 18,
    "bodyLeak": false
    }
    }
    }
    }
  • Has no body leak fault

    From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasNoBodyLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "AD1C569616A1": {
    "model": 13,
    "bodyLeak": false
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasNoBodyLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "87E3AD0B8FB2": {
    "model": 18,
    "bodyLeak": false
    }
    }
    }
    }
  • Has body leak fault

    From ./dist/samples/json/requests/devices/vehicles/revolution/bodyLeak/revolutionHasBodyLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "FCA21F3840EC": {
    "model": 13,
    "bodyLeak": true
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/bodyLeak/pivotHasBodyLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A003D8C4729A": {
    "model": 18,
    "bodyLeak": true
    }
    }
    }
    }
readonly
cameras?: Record<string, Removable<Cameras>>

📷 List of cameras

Holds a list of all vehicle Cameras.

depth?: number

Rov depth

Measured in meters from water surface

readonly
drive?: RovDrive

Rov Drive object

Commands thrust actions for the ROV and sets drive modes

See RovDrive for more details.

Example Payloads

SET Requests

  • Random drive request

    From ./dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "SET",
    "payload": {
    "devices": {
    "3A9108F6ECBC": {
    "model": 18,
    "drive": {
    "thrust": {
    "forward": -59,
    "yaw": 7,
    "vertical": 31,
    "lateral": 86
    },
    "modes": {
    "headingLock": false,
    "altitudeLock": false,
    "depthLock": true,
    "autoStabilization": false,
    "motorsDisabled": false
    }
    }
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/drive/revolutionDriveRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "SET",
    "payload": {
    "devices": {
    "6C7863478D40": {
    "model": 13,
    "drive": {
    "thrust": {
    "forward": 27,
    "yaw": 80,
    "vertical": 97,
    "lateral": 69
    },
    "modes": {
    "headingLock": true,
    "altitudeLock": true,
    "depthLock": false,
    "autoStabilization": false,
    "motorsDisabled": false
    }
    }
    }
    }
    }
    }
heading?: number

Rov heading

Measured in degrees from north bearing

minimum

0

maximum

360

readonly
inWater?: boolean

Rov in water status

readonly

Example Payloads

UPDATE Requests

  • Pivot in water

    From ./dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotInWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4A79B81B0391": {
    "model": 18,
    "inWater": true
    }
    }
    }
    }
  • Pivot out of water

    From ./dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotOutOfWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7EE39D2F1A97": {
    "model": 18,
    "inWater": false
    }
    }
    }
    }
  • Pivot in water random status sample

    From ./dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotInWaterRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "05F85826D82D": {
    "model": 18,
    "inWater": false
    }
    }
    }
    }
  • Revolution out of water

    From ./dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionOutOfWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C942BBF31287": {
    "model": 13,
    "inWater": false
    }
    }
    }
    }
  • Revolution in water

    From ./dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionInWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A398232C69AF": {
    "model": 13,
    "inWater": true
    }
    }
    }
    }
  • Revolution in water random status sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionInWaterRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "53C3E81698F1": {
    "model": 13,
    "inWater": false
    }
    }
    }
    }
ip?: string
  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/revolution/ip/revolutionRandomIpSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "SET",
    "payload": {
    "devices": {
    "7AC5B29BFBFA": {
    "model": 13,
    "ip": "192.168.51.127"
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/ip/pivotIpRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "SET",
    "payload": {
    "devices": {
    "DCAF16C9E5D4": {
    "model": 18,
    "ip": "192.168.41.163"
    }
    }
    }
    }
readonly

Deep Trekker internal device model numbers. This can be used for selecting the associated device schema.

pitch?: number

Rov pitch

Measured in degrees from neutral pitch position

minimum

-180.0

maximum

180.0

readonly
position?: Position

ROV Position

description

Contains positional data about the ROV.

Example payloads

UPDATE Requests

  • Invalid position sample

  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionPositionInvalidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3BCFAF159E23": {
    "model": 13,
    "position": {
    "local": {
    "uncertainty": 10000
    },
    "global": {
    "uncertainty": 10000
    }
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotPositionInvalidSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E9753C35F66A": {
    "model": 18,
    "position": {
    "local": {
    "uncertainty": 10000
    },
    "global": {
    "uncertainty": 10000
    }
    }
    }
    }
    }
    }
  • Arbitrary position sample

  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8EAE9DBA7A3A": {
    "model": 13,
    "position": {
    "local": {
    "northing": -891,
    "easting": 607,
    "uncertainty": 33
    },
    "global": {
    "latitude": -38,
    "longitude": -116,
    "uncertainty": 82
    }
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1880F5B0D457": {
    "model": 18,
    "position": {
    "local": {
    "northing": -266,
    "easting": -153,
    "uncertainty": 94
    },
    "global": {
    "latitude": 32,
    "longitude": 85,
    "uncertainty": 31
    }
    }
    }
    }
    }
    }

UPDATE Requests

  • Arbitrary Local position only

  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "02C393BACD83": {
    "model": 13,
    "position": {
    "local": {
    "northing": 10,
    "easting": 10,
    "uncertainty": 10
    }
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "B9979A829D3A": {
    "model": 18,
    "position": {
    "local": {
    "northing": -836,
    "easting": 517,
    "uncertainty": 30
    }
    }
    }
    }
    }
    }
  • Arbitrary Global position only

  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E16025B403DD": {
    "model": 13,
    "position": {
    "global": {
    "latitude": 10,
    "longitude": 10,
    "uncertainty": 10
    }
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9F8AB3F295F7": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 27,
    "longitude": 91,
    "uncertainty": 93
    }
    }
    }
    }
    }
    }
roll?: number

Rov roll

Measured in degrees from neutral roll position

minimum

-180.0

maximum

180.0

readonly
sensorPodLeak?: boolean

Sensor Pod Leak Fault

Common across all ROV and also comes from the ROV Web Adapter in Con_gui

turns?: number

Turns

Count the number of turns the rov has completed

readonly
usageTime?: UsageTime

Vehicle Usage Time

Example Payloads

GET Requests

  • Total and current usage times

    From ./dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "640E243D8E0C": {
    "model": 18,
    "usageTime": {
    "totalSeconds": 0,
    "currentSeconds": 0
    }
    }
    }
    }
    }
  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "55C2DC2CA8E5": {
    "model": 18,
    "usageTime": {
    "totalSeconds": 63,
    "currentSeconds": 71
    }
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/revolution/usageTime/revolutionUsageTimeRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6E52DD52CD3B": {
    "model": 13,
    "usageTime": {
    "totalSeconds": 92,
    "currentSeconds": 22
    }
    }
    }
    }
    }
velocity?: Velocity

Rov Velocity

description

Velocity and speed components for the ROV

Example payloads

UPDATE Requests

  • Arbitrary velocity samples
  • Revolution

    From ./dist/samples/json/requests/devices/vehicles/revolution/velocity/revolutionVelocityRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0E8F9E075949": {
    "model": 13,
    "velocity": {
    "valid": true,
    "forward": 13,
    "rightward": -13,
    "downward": -36,
    "speed": 90
    }
    }
    }
    }
    }
  • Pivot

    From ./dist/samples/json/requests/devices/vehicles/pivot/velocity/pivotVelocityRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C81D03E77F91": {
    "model": 18,
    "velocity": {
    "valid": false,
    "forward": 27,
    "rightward": -14,
    "downward": 67,
    "speed": 17
    }
    }
    }
    }
    }
version?: DeviceVersion

ROV Version

readonly