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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "FCF01ED23687": {
    "model": 18,
    "altitude": 134
    }
    }
    }
    }

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

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

Rov altitude valid

Altitude validity flag

Example Payloads

UPDATE Requests

  • 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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3BC678AFAFCF": {
    "model": 18,
    "altitude": 268,
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4731B92F0749": {
    "model": 13,
    "altitudeValid": false,
    "altitude": 237
    }
    }
    }
    }
  • 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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5AD6D9D572F0": {
    "model": 18,
    "altitudeValid": false
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A1BECC62B6EA": {
    "model": 13,
    "altitudeValid": true
    }
    }
    }
    }
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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E4CC871F69A2": {
    "model": 13,
    "bodyLeak": false
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "DA8FCB5C2816": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "AC3613AF885D": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3ED98BF91FD6": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A50CB153E414": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "408F7A0A954B": {
    "model": 18,
    "bodyLeak": true
    }
    }
    }
    }
readonly
cameras?: Record<string, Removable<Cameras>>

📷 List of cameras

Holds a list of all vehicle Cameras.

cpProbe?: string

The cp probe

cygnus?: cygnusType

The ut(cygnus) probe

depth?: number

Rov depth

Measured in meters from water surface

To Calibrate depth, set depth to '0'. Setting depth to any other value will be ignored.

Valid Depth calibration

From ./dist/samples/json/requests/devices/vehicles/pivot/depth/pivotDepthCalibrationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.56.4",
"method": "SET",
"payload": {
"devices": {
"039908329239": {
"model": 18,
"depth": 0
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionDepthCalibrationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.56.4",
"method": "SET",
"payload": {
"devices": {
"62B0FD0D774B": {
"model": 13,
"depth": 0
}
}
}
}

Invalid Depth Calibration

From ./dist/samples/json/requests/devices/vehicles/pivot/depth/pivotInvalidDepthCalibrationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.56.4",
"method": "SET",
"payload": {
"devices": {
"956EFBC32EDC": {
"model": 18,
"depth": 24
}
}
}
}

From ./dist/samples/json/requests/devices/vehicles/revolution/depth/revolutionInvalidDepthCalibrationSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.56.4",
"method": "SET",
"payload": {
"devices": {
"FDFEEEE4AB88": {
"model": 13,
"depth": 213
}
}
}
}
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.56.4",
    "method": "SET",
    "payload": {
    "devices": {
    "F1350FFA7F9D": {
    "model": 18,
    "drive": {
    "thrust": {
    "forward": -79,
    "yaw": 61,
    "vertical": -79,
    "lateral": 89
    },
    "modes": {
    "headingLock": true,
    "altitudeLock": false,
    "depthLock": false,
    "autoStabilization": true,
    "motorsDisabled": true
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "SET",
    "payload": {
    "devices": {
    "5D88D61FA572": {
    "model": 13,
    "drive": {
    "thrust": {
    "forward": 72,
    "yaw": -74,
    "vertical": 14,
    "lateral": -28
    },
    "modes": {
    "headingLock": true,
    "altitudeLock": true,
    "depthLock": true,
    "autoStabilization": true,
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9944280F6F6D": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8E3A47FDBE2E": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5EC007A852E4": {
    "model": 18,
    "inWater": true
    }
    }
    }
    }
  • 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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3A939152D988": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C05AEC9C12C4": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "442C36928DFB": {
    "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.56.4",
    "method": "SET",
    "payload": {
    "devices": {
    "0815E219D101": {
    "model": 13,
    "ip": "192.168.135.162"
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "SET",
    "payload": {
    "devices": {
    "2E03BF95F232": {
    "model": 18,
    "ip": "192.168.129.56"
    }
    }
    }
    }
readonly

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

navigationOptions?: NavigationOptions

Navigation Options

description

Navigation settings and options for the ROV

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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "909C037A6AC6": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "99F532B6CE82": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8AD5DAC2713C": {
    "model": 13,
    "position": {
    "local": {
    "northing": 979,
    "easting": -661,
    "uncertainty": 80
    },
    "global": {
    "latitude": -78,
    "longitude": 112,
    "uncertainty": 63
    }
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "53FA9CE76A57": {
    "model": 18,
    "position": {
    "local": {
    "northing": -477,
    "easting": -419,
    "uncertainty": 29
    },
    "global": {
    "latitude": 90,
    "longitude": -74,
    "uncertainty": 28
    }
    }
    }
    }
    }
    }

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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "239063603183": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BC02CA289316": {
    "model": 18,
    "position": {
    "local": {
    "northing": -426,
    "easting": -905,
    "uncertainty": 25
    }
    }
    }
    }
    }
    }
  • 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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7DF4DBB506B8": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E31188D1927A": {
    "model": 18,
    "position": {
    "global": {
    "latitude": 48,
    "longitude": 143,
    "uncertainty": 63
    }
    }
    }
    }
    }
    }
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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4AB3CB5882EC": {
    "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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "80979D7EBCBD": {
    "model": 18,
    "usageTime": {
    "totalSeconds": 14,
    "currentSeconds": 36
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "11887C1DD08A": {
    "model": 13,
    "usageTime": {
    "totalSeconds": 66,
    "currentSeconds": 90
    }
    }
    }
    }
    }
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.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "782BB2467D3B": {
    "model": 13,
    "velocity": {
    "valid": false,
    "forward": -25,
    "rightward": -33,
    "downward": -65,
    "speed": 23
    }
    }
    }
    }
    }
  • Pivot

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.56.4",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "77821D558B05": {
    "model": 18,
    "velocity": {
    "valid": true,
    "forward": -42,
    "rightward": 47,
    "downward": -61,
    "speed": 19
    }
    }
    }
    }
    }
version?: DeviceVersion

ROV Version

readonly