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

See type declaration

Revolution ROV

DELETE Request

From ./dist/samples/json/requests/devices/vehicles/revolution/core/revolutionDeleteSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "DELETE",
"payload": {
"devices": {
"42BD20736EDB": {
"model": 13
}
}
}
}

Hierarchy

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
auxLight?: Light

Aux Light

Controls the auxiliary light attached to the Revolution.

remarks

See Light type for more details.

Example Payloads

SET Requests

  • Light On (mid)

From ./dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMidIntensitySample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "SET",
"payload": {
"devices": {
"FE6E9E9F954C": {
"model": 13,
"auxLight": {
"intensity": 50
}
}
}
}
}
  • Light Off

From ./dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOffSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "SET",
"payload": {
"devices": {
"FC8FDBB4F31A": {
"model": 13,
"auxLight": {
"intensity": 0
}
}
}
}
}
  • Light On (max)

From ./dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightOnMaxIntensitySample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "SET",
"payload": {
"devices": {
"84BCEF057669": {
"model": 13,
"auxLight": {
"intensity": 100
}
}
}
}
}
  • Arbitrary

From ./dist/samples/json/requests/devices/vehicles/revolution/auxLight/revolutionAuxLightRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "SET",
"payload": {
"devices": {
"DD85769C916F": {
"model": 13,
"auxLight": {
"intensity": 41
}
}
}
}
}
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

Camera Head

Controls the camera head attached to the revolution

remarks

See cameraHead type for more details

Example Payloads

Set Requests

cameras?: Record<string, Removable<Cameras>>

📷 List of cameras

Holds a list of all vehicle Cameras.

cpuTemp?: number

CPU temperature sensors in degrees celsius

Example Payloads

UPDATE Requests

  • Arbitrary

From ./dist/samples/json/requests/devices/vehicles/revolution/cpuTemp/revolutionCpuTempRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"E58EBAED92F6": {
"model": 13,
"cpuTemp": 59
}
}
}
}
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
    }
    }
    }
    }
    }
    }
frontLeftMotorDiagnostics?: MotorDiagnostics

Front Left Motor Diagnostics

Example Payloads

UPDATE Requests

  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"80C91B15A471": {
"model": 13,
"frontLeftMotorDiagnostics": {
"current": 57,
"overcurrent": true,
"pwm": 37,
"rpm": -87
}
}
}
}
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontLeftThruster/revolutionFrontLeftMotorDiagnosticsRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"9099DEF8917C": {
"model": 13,
"frontLeftMotorDiagnostics": {
"current": 8,
"overcurrent": false,
"pwm": 5,
"rpm": -1
}
}
}
}
}
frontRightMotorDiagnostics?: MotorDiagnostics

Front Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests

  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontRightThruster/revolutionFrontRightMotorDiagnosticsRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"8543FAEB8C23": {
"model": 13,
"frontRightMotorDiagnostics": {
"current": 86,
"overcurrent": true,
"pwm": 80,
"rpm": 19
}
}
}
}
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/frontRightThruster/revolutionFrontRightMotorDiagnosticsRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"447A23E2539F": {
"model": 13,
"frontRightMotorDiagnostics": {
"current": 6,
"overcurrent": false,
"pwm": 2,
"rpm": 1
}
}
}
}
}
grabber?: Grabber

Grabber

remarks

see Grabber for more details}

Example Payloads

SET Requests

  • Arbitrary

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"B962FE77842E": {
"model": 13,
"grabber": {
"rotate": -62,
"openClose": -26
}
}
}
}
}
  • Resting

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"3145FE0F29CE": {
"model": 13,
"grabber": {
"rotate": 0,
"openClose": 0
}
}
}
}
}
  • Open

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberOpenClawSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"D543AC15A52F": {
"model": 13,
"grabber": {
"openClose": 100
}
}
}
}
}
  • Close

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberCloseClawSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"1C892F1ECA1A": {
"model": 13,
"grabber": {
"openClose": -100
}
}
}
}
}
  • Rotate Left

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateLeftSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"BF8498CA45CC": {
"model": 13,
"grabber": {
"rotate": -100
}
}
}
}
}
  • Rotate Right

From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateRightSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"1CF736950D42": {
"model": 13,
"grabber": {
"rotate": 100
}
}
}
}
}
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
leftBattery?: Battery

Left Battery

Example Payloads

UPDATE Requests

  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"05ADBB8D2B3F": {
"model": 13,
"leftBattery": {
"percent": 97,
"voltage": 100,
"charging": true
}
}
}
}
}
  • Left battery warning

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryWarningSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"C19A3AF8006B": {
"model": 13,
"leftBattery": {
"percent": 10
}
}
}
}
}
  • Left battery shutdown

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryShutdownSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"4016538AC54D": {
"model": 13,
"leftBattery": {
"percent": 0
}
}
}
}
}
  • Left battery charging

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsChargingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"8BCA1CF870C2": {
"model": 13,
"leftBattery": {
"charging": true
}
}
}
}
}
  • left battery not charging

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/revolutionLeftBatteryIsNotChargingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"EE170821303F": {
"model": 13,
"leftBattery": {
"charging": false
}
}
}
}
}
  • left battery has leak

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasLeakSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"33EB95160658": {
"model": 13,
"leftBattery": {
"leak": true
}
}
}
}
}
  • left batter has no leak

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/leftBattery/leak/revolutionLeftBatteryHasNoLeakSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"45CF743C96DF": {
"model": 13,
"leftBattery": {
"leak": false
}
}
}
}
}
model: Revolution
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
    }
    }
    }
    }
    }
    }
rearLeftMotorDiagnostics?: MotorDiagnostics

Rear Left Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests

  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearLeftThruster/revolutionRearLeftMotorDiagnosticsRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"DFE26A79C03B": {
"model": 13,
"rearLeftMotorDiagnostics": {
"current": 17,
"overcurrent": false,
"pwm": 24,
"rpm": 69
}
}
}
}
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearLeftThruster/revolutionRearLeftMotorDiagnosticsRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"F5BB0B2B3CCE": {
"model": 13,
"rearLeftMotorDiagnostics": {
"current": 8,
"overcurrent": false,
"pwm": 2,
"rpm": -1
}
}
}
}
}
rearRightMotorDiagnostics?: MotorDiagnostics

Rear Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests

  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearRightThruster/revolutionRearRightMotorDiagnosticsRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"FB053D8C2C6E": {
"model": 13,
"rearRightMotorDiagnostics": {
"current": 62,
"overcurrent": true,
"pwm": 36,
"rpm": -89
}
}
}
}
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/rearRightThruster/revolutionRearRightMotorDiagnosticsRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"2A2F4C14E2B6": {
"model": 13,
"rearRightMotorDiagnostics": {
"current": 8,
"overcurrent": false,
"pwm": 2,
"rpm": -1
}
}
}
}
}
rightBattery?: Battery

Right Battery

Examples

UPDATE Requests

  • All Arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"F42DD9FCFB79": {
"model": 13,
"rightBattery": {
"percent": 69,
"voltage": 100,
"charging": true
}
}
}
}
}
  • Right battery warning

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryWarningSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"E96F18E373D1": {
"model": 13,
"rightBattery": {
"percent": 10
}
}
}
}
}
  • Right battery shutdown

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryShutdownSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"9D3B984031D1": {
"model": 13,
"rightBattery": {
"percent": 0
}
}
}
}
}
  • Right battery charging

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryIsChargingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"DA7C1FF19E93": {
"model": 13,
"rightBattery": {
"charging": true
}
}
}
}
}
  • Right battery not charging

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/revolutionRightBatteryIsNotChargingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"DA670AD051E7": {
"model": 13,
"rightBattery": {
"charging": false
}
}
}
}
}
  • right battery has leak

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/leak/revolutionRightBatteryHasLeakSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"358C63C89C8A": {
"model": 13,
"rightBattery": {
"leak": true
}
}
}
}
}
  • right battery has no leak

From ./dist/samples/json/requests/devices/vehicles/revolution/battery/rightBattery/leak/revolutionRightBatteryHasNoLeakSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"F3F1F5CB7B5B": {
"model": 13,
"rightBattery": {
"leak": false
}
}
}
}
}
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

spareMotor1?: MotorDiagnostics

Provides diagnostics for spare motor 1 on the Rov. This spare motor can be used to extend the capabilities of the ROV by attaching a power tool to it.

Example Payloads

UPDATE Requests

  • Resting spare motor 1 diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor1/revolutionSpareMotor1DiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4C17043DFBAE": {
    "model": 13,
    "spareMotor1": {
    "current": 66,
    "overcurrent": false,
    "pwm": 39,
    "rpm": -54
    }
    }
    }
    }
    }
  • Arbitrary Spare Motor 1 Diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor1/revolutionSpareMotor1DiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F99176403F7E": {
    "model": 13,
    "spareMotor1": {
    "current": 79,
    "overcurrent": false,
    "pwm": 8,
    "rpm": 79
    }
    }
    }
    }
    }
spareMotor2?: MotorDiagnostics

Provides diagnostics for spare motor 2 on the Rov. This spare motor can be used to extend the capabilities of the ROV by attaching a power tool to it.

Example Payloads

UPDATE Requests

  • Resting spare motor 2 diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor2/revolutionSpareMotor2DiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6F42C8E2150B": {
    "model": 13,
    "spareMotor2": {
    "current": 61,
    "overcurrent": true,
    "pwm": 56,
    "rpm": -94
    }
    }
    }
    }
    }
  • Arbitrary Spare Motor 2 Diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/revolution/spareMotors/spareMotor2/revolutionSpareMotor2DiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "23B62FE7827D": {
    "model": 13,
    "spareMotor2": {
    "current": 40,
    "overcurrent": true,
    "pwm": 53,
    "rpm": -62
    }
    }
    }
    }
    }
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
verticalLeftMotorDiagnostics?: MotorDiagnostics

Vertical Left Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests

  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalLeftThruster/revolutionVerticalLeftMotorDiagnosticsRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"805C9603EF8D": {
"model": 13,
"verticalLeftMotorDiagnostics": {
"current": 9,
"overcurrent": true,
"pwm": 23,
"rpm": 27
}
}
}
}
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalLeftThruster/revolutionVerticalLeftMotorDiagnosticsRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"FE44D25C62C9": {
"model": 13,
"verticalLeftMotorDiagnostics": {
"current": 4,
"overcurrent": false,
"pwm": 1,
"rpm": -1
}
}
}
}
}
verticalRightMotorDiagnostics?: MotorDiagnostics

Vertical Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests

  • All arbitrary values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"97889E60D45F": {
"model": 13,
"verticalRightMotorDiagnostics": {
"current": 70,
"overcurrent": true,
"pwm": 16,
"rpm": -19
}
}
}
}
}
  • Resting values

From ./dist/samples/json/requests/devices/vehicles/revolution/thrusters/diagnostics/verticalRightThruster/revolutionVerticalRightMotorDiagnosticsRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"8755486536E8": {
"model": 13,
"verticalRightMotorDiagnostics": {
"current": 3,
"overcurrent": false,
"pwm": 1,
"rpm": -1
}
}
}
}
}
waterTemp?: number
  • Arbitrary temp

From ./dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionRandomWaterTempSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"800479FC3DBB": {
"model": 13,
"waterTemp": 19
}
}
}
}
  • Max water temp

From ./dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionMaxWaterTempSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"1E285447DDEC": {
"model": 13,
"waterTemp": 50
}
}
}
}
  • Min water temp

From ./dist/samples/json/requests/devices/vehicles/revolution/waterTemp/revolutionMinWaterTempSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"4DF92C3383A1": {
"model": 13,
"waterTemp": -10
}
}
}
}