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

See type declaration

Pivot ROV

DELETE Request

From ./dist/samples/json/requests/devices/vehicles/pivot/core/pivotDeleteSample.json

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

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.

Example Payloads

SET Requests

  • Lights On (mid)

    From ./dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightOnMidIntensitySample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "SET",
    "payload": {
    "devices": {
    "0C7E83118E05": {
    "model": 18,
    "auxLight": {
    "intensity": 50
    }
    }
    }
    }
    }

    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
    }
    }
    }
    }
    }
  • Lights 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
    }
    }
    }
    }
    }

    From ./dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightOffSample.json

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

    From ./dist/samples/json/requests/devices/vehicles/pivot/auxLight/pivotAuxLightOnMaxIntensitySample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "SET",
    "payload": {
    "devices": {
    "DC1AD9A0D03F": {
    "model": 18,
    "auxLight": {
    "intensity": 100
    }
    }
    }
    }
    }

    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/pivot/auxLight/pivotAuxLightRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "SET",
    "payload": {
    "devices": {
    "19FBAF03D82E": {
    "model": 18,
    "auxLight": {
    "intensity": 44
    }
    }
    }
    }
    }

    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

Example Payloads

GET Requests

  • Pivot camera head

    From ./dist/samples/json/requests/devices/vehicles/pivot/cameraHead/pivotCameraHeadRequest.json

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

Pivot camera

Example Payloads

DELETE Requests

From ./dist/samples/json/requests/devices/vehicles/pivot/cameras/pivotCameraDeleteSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.50.0",
"method": "DELETE",
"payload": {
"devices": {
"152A962183DE": {
"model": 18,
"cameras": {
"CA56011B19DA": {}
}
}
}
}
}
cpuTemp?: number

Temperature in degrees celsius

Example Payloads

UPDATE Requests

  • CPU temperature warning

    From ./dist/samples/json/requests/devices/vehicles/pivot/temperature/cpuTemp/pivotCPUTemperatureWarningSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F0ECFCAD7D05": {
    "model": 18,
    "cpuTemp": 75
    }
    }
    }
    }
  • CPU temperature shutdown

    From ./dist/samples/json/requests/devices/vehicles/pivot/temperature/cpuTemp/pivotCPUTemperatureShutdownSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "AAB85F26B21F": {
    "model": 18,
    "cpuTemp": 85
    }
    }
    }
    }
  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/pivot/temperature/cpuTemp/pivotCPUTemperatureRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1B8463C73ABA": {
    "model": 18,
    "cpuTemp": 29
    }
    }
    }
    }
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

Motor Diagnostics

Example Payloads

GET Requests

  • Arbitrary (Front Left Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontLeftThruster/pivotFrontLeftMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5A016FC85D45": {
    "model": 18,
    "frontLeftMotorDiagnostics": {
    "current": 62,
    "overcurrent": true,
    "pwm": 3,
    "rpm": 39
    }
    }
    }
    }
    }
  • Resting position (Front Left Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontLeftThruster/pivotFrontLeftMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "79DD0EBCFC53": {
    "model": 18,
    "frontLeftMotorDiagnostics": {
    "current": 2,
    "overcurrent": false,
    "pwm": 2,
    "rpm": 1
    }
    }
    }
    }
    }
frontRightMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

Example Payloads

GET Requests

  • Arbitrary (Front Right Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontRightThruster/pivotFrontRightMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4EEF8ECED2CD": {
    "model": 18,
    "frontRightMotorDiagnostics": {
    "current": 24,
    "overcurrent": true,
    "pwm": 24,
    "rpm": -10
    }
    }
    }
    }
    }
  • Resting position (Front Right Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/frontRightThruster/pivotFrontRightMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "290FC88D2E1F": {
    "model": 18,
    "frontRightMotorDiagnostics": {
    "current": 2,
    "overcurrent": false,
    "pwm": 4,
    "rpm": -1
    }
    }
    }
    }
    }
grabber?: Grabber

Grabber

Example Payloads

GET Requests

  • Resting pivot grabber

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRestingGrabberSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4E48B66377B5": {
    "model": 18,
    "grabber": {
    "openClose": 0,
    "rotate": 0
    }
    }
    }
    }
    }
  • Resting pivot openClose grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotGrabberOpenCloseMotorDiagnosticRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "155A009F2352": {
    "model": 18,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 4,
    "overcurrent": false,
    "pwm": 3,
    "rpm": -1
    }
    }
    }
    }
    }
    }
  • Resting pivot rotate grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotGrabberRotateMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0F2EDFB9992C": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 4,
    "overcurrent": false,
    "pwm": 1,
    "rpm": 1
    }
    }
    }
    }
    }
    }
  • Random pivot rotate grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotGrabberRotateMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "52B6EED35140": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 74,
    "overcurrent": false,
    "pwm": 33,
    "rpm": -23
    }
    }
    }
    }
    }
    }
  • Random pivot openClose grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotGrabberOpenCloseMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "19765251C72C": {
    "model": 18,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 20,
    "overcurrent": true,
    "pwm": 54,
    "rpm": -59
    }
    }
    }
    }
    }
    }
  • Open pivot grabber claw

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotOpenClawGrabberSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0C0568991E93": {
    "model": 18,
    "grabber": {
    "openClose": 100
    }
    }
    }
    }
    }
  • open pivot grabber claw diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotOpenClawGrabberDiagnosticSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F315117958A9": {
    "model": 18,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 49,
    "overcurrent": false,
    "pwm": 46,
    "rpm": 9
    }
    }
    }
    }
    }
    }
  • Close pivot grabber claw

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotCloseClawGrabberSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "EA96C880CA20": {
    "model": 18,
    "grabber": {
    "openClose": -100
    }
    }
    }
    }
    }
  • Close pivot grabber claw diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotCloseClawGrabberDiagnosticSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F4FF41D4B39B": {
    "model": 18,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 46,
    "overcurrent": false,
    "pwm": 53,
    "rpm": 6
    }
    }
    }
    }
    }
    }
  • Rotate right pivot grabber

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRotateGrabberRightSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "571D5D5D40FB": {
    "model": 18,
    "grabber": {
    "rotate": 100
    }
    }
    }
    }
    }
  • Rotate right pivot grabber claw diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotRotateGrabberRightDiagnosticSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4FC7D3161302": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 48,
    "overcurrent": false,
    "pwm": 46,
    "rpm": 8
    }
    }
    }
    }
    }
    }
  • Rotate left pivot grabber

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRotateGrabberLeftSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CADB114B09A0": {
    "model": 18,
    "grabber": {
    "rotate": -100
    }
    }
    }
    }
    }
  • Rotate left pivot grabber claw diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotRotateGrabberLeftDiagnosticSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9F032FE39B3E": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 53,
    "overcurrent": false,
    "pwm": 46,
    "rpm": 6
    }
    }
    }
    }
    }
    }
  • Random pivot rotate grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotGrabberRotateMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0F2EDFB9992C": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 4,
    "overcurrent": false,
    "pwm": 1,
    "rpm": 1
    }
    }
    }
    }
    }
    }
  • Random pivot rotate and open close grabber

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRandomGrabberSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6B571EC61C49": {
    "model": 18,
    "grabber": {
    "openClose": 49,
    "rotate": 30
    }
    }
    }
    }
    }
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

    • Battery random percentage

      From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.50.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "D99D19A5D0C8": {
      "model": 18,
      "leftBattery": {
      "percent": 2
      }
      }
      }
      }
      }
  • Battery random voltage

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "14685D0E8ADD": {
    "model": 18,
    "leftBattery": {
    "voltage": 98
    }
    }
    }
    }
    }
  • Battery random leak state

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryLeakRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7D35AEC6678C": {
    "model": 18,
    "leftBattery": {
    "leak": false
    }
    }
    }
    }
    }
  • Battery maximum voltage {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageMaxSample .json}

  • Battery minimum voltage

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryVoltageMinSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6AD6B5C314BA": {
    "model": 18,
    "leftBattery": {
    "voltage": 0
    }
    }
    }
    }
    }
  • Battery no leak

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotHasNoLeftBatteryLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "419BB5735BAF": {
    "model": 18,
    "leftBattery": {
    "leak": false
    }
    }
    }
    }
    }
  • Battery has a leak

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotHasLeftBatteryLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1F2889F01CD6": {
    "model": 18,
    "leftBattery": {
    "leak": true
    }
    }
    }
    }
    }
  • Battery shutdown

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryShutdownSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D2BC1BF5BD22": {
    "model": 18,
    "leftBattery": {
    "percent": 0
    }
    }
    }
    }
    }
  • Battery warning

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryWarningSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1C5ACC276265": {
    "model": 18,
    "leftBattery": {
    "percent": 15
    }
    }
    }
    }
    }
  • Battery All States

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/leftBattery/pivotLeftBatteryAllStatesSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "712AD35C7AC0": {
    "model": 18,
    "leftBattery": {
    "percent": 71,
    "voltage": 5,
    "charging": false,
    "leak": false
    }
    }
    }
    }
    }
model: Pivot
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

Motor Diagnostics

Example Payloads

GET Requests

    • Arbitrary (Rear Left Motor)

      From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/rearLeftThruster/pivotRearLeftMotorDiagnosticsRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.50.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "9E77259738F1": {
      "model": 18,
      "rearLeftMotorDiagnostics": {
      "current": 58,
      "overcurrent": true,
      "pwm": 45,
      "rpm": -16
      }
      }
      }
      }
      }
  • Resting position (Rear Left Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/rearLeftThruster/pivotRearLeftMotorDiagnosticsRestingSample.json

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

Motor Diagnostics

Example Payloads

GET Requests

    • Arbitrary (Rear Right Motor)

      From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/rearRightThruster/pivotRearRightMotorDiagnosticsRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.50.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "1C866E615650": {
      "model": 18,
      "rearRightMotorDiagnostics": {
      "current": 48,
      "overcurrent": false,
      "pwm": 97,
      "rpm": 95
      }
      }
      }
      }
      }
  • Resting position (Rear Right Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/rearRightThruster/pivotRearRightMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D840E0927ED1": {
    "model": 18,
    "rearRightMotorDiagnostics": {
    "current": 10,
    "overcurrent": false,
    "pwm": 3,
    "rpm": 1
    }
    }
    }
    }
    }
rightBattery?: Battery

Right Battery

Example Payloads

UPDATE Requests

  • Battery random percentage

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C0ECAE67146C": {
    "model": 18,
    "rightBattery": {
    "percent": 81
    }
    }
    }
    }
    }
  • Battery random voltage

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryVoltageRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9C42970D2DEB": {
    "model": 18,
    "rightBattery": {
    "voltage": 38
    }
    }
    }
    }
    }
  • Battery random leak state

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryLeakRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A7D653C27966": {
    "model": 18,
    "rightBattery": {
    "leak": true
    }
    }
    }
    }
    }
  • Battery maximum voltage {@codeblock ~~/dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryVoltageMaxSample .json}

  • Battery minimum voltage

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryVoltageMinSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C2DC257325DE": {
    "model": 18,
    "rightBattery": {
    "voltage": 0
    }
    }
    }
    }
    }
  • Battery no leak

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotHasNoRightBatteryLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1273CD306473": {
    "model": 18,
    "rightBattery": {
    "leak": false
    }
    }
    }
    }
    }
  • Battery has a leak

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotHasRightBatteryLeakSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "783524EB9430": {
    "model": 18,
    "rightBattery": {
    "leak": true
    }
    }
    }
    }
    }
  • Battery shutdown

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryShutdownSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3BC5E21B1FDA": {
    "model": 18,
    "rightBattery": {
    "percent": 0
    }
    }
    }
    }
    }
  • Battery warning

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryWarningSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5532128A11BD": {
    "model": 18,
    "rightBattery": {
    "percent": 15
    }
    }
    }
    }
    }
  • Battery All States

    From ./dist/samples/json/requests/devices/vehicles/pivot/battery/rightBattery/pivotRightBatteryAllStatesSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A41FD0F7ACE5": {
    "model": 18,
    "rightBattery": {
    "percent": 95,
    "voltage": 13,
    "charging": true,
    "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 motors on the Rov. These spare motors can be used to extend the capabilities of the ROV by attaching various power tools to them. These tools can include CaviBlasters, cutters and etc.

Example Payloads

UPDATE Requests

  • Resting spare motor 1 diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/pivot/spareMotors/spareMotor1/pivotSpareMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "520122D4A535": {
    "model": 18,
    "spareMotor1": {
    "current": 1,
    "overcurrent": false,
    "pwm": 1,
    "rpm": 0
    }
    }
    }
    }
    }
  • Arbitrary Spare Motor 1 Diagnostics sample

    From ./dist/samples/json/requests/devices/vehicles/pivot/spareMotors/spareMotor1/pivotSpareMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "918DF587F59E": {
    "model": 18,
    "spareMotor1": {
    "current": 63,
    "overcurrent": true,
    "pwm": 18,
    "rpm": -33
    }
    }
    }
    }
    }
tiltPlatform?: TiltPlatform

Grabber

Example Payloads

GET Requests

  • Resting pivot grabber arm

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E1FFF757A36E": {
    "model": 18,
    "tiltPlatform": {
    "tilt": 0
    }
    }
    }
    }
    }
  • Resting pivot grabber arm diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8FBC927F2EC8": {
    "model": 18,
    "tiltPlatform": {
    "tiltMotorDiagnostics": {
    "current": 3,
    "overcurrent": false,
    "pwm": 3,
    "rpm": 0
    }
    }
    }
    }
    }
    }
  • Tilt up

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformUpSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CB172C375FCD": {
    "model": 18,
    "tiltPlatform": {
    "tilt": 100
    }
    }
    }
    }
    }
  • Tilt up pivot grabber arm diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformUpDiagnosticsSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "09157D082235": {
    "model": 18,
    "tiltPlatform": {
    "tiltMotorDiagnostics": {
    "current": 47,
    "overcurrent": false,
    "pwm": 52,
    "rpm": 10
    }
    }
    }
    }
    }
    }
  • Tilt down

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformDownSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "53733E9EFEE8": {
    "model": 18,
    "tiltPlatform": {
    "tilt": -100
    }
    }
    }
    }
    }
  • Tilt down pivot grabber arm diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDownDiagnosticsSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F797414B22BE": {
    "model": 18,
    "tiltPlatform": {
    "tiltMotorDiagnostics": {
    "current": 51,
    "overcurrent": false,
    "pwm": -47,
    "rpm": -5
    }
    }
    }
    }
    }
    }
  • Random pivot grabber arm

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9F9D1558F595": {
    "model": 18,
    "tiltPlatform": {
    "tilt": -57
    }
    }
    }
    }
    }
  • Random pivot grabber arm diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C07ABC70F325": {
    "model": 18,
    "tiltPlatform": {
    "tiltMotorDiagnostics": {
    "current": 7,
    "overcurrent": true,
    "pwm": 26,
    "rpm": 12
    }
    }
    }
    }
    }
    }
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
    }
    }
    }
    }
    }
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

Pivot Version

Example Payloads

GET Requests

  • Version 1

    From ./dist/samples/json/requests/devices/vehicles/pivot/version/pivotVersion1Sample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "EE4D98BF57BC": {
    "model": 18,
    "version": {
    "hardware": "0",
    "software": "1.2"
    }
    }
    }
    }
    }
  • Version 2

    From ./dist/samples/json/requests/devices/vehicles/pivot/version/pivotVersion2Sample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "35E1179FD5AC": {
    "model": 18,
    "version": {
    "hardware": "1",
    "software": "2.2"
    }
    }
    }
    }
    }
  • Version 3

    From ./dist/samples/json/requests/devices/vehicles/pivot/version/pivotVersion3Sample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6457EED324C5": {
    "model": 18,
    "version": {
    "hardware": "2",
    "software": "3.3"
    }
    }
    }
    }
    }
  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/pivot/version/pivotVersionRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "BF559BF7AE8D": {
    "model": 18,
    "version": {
    "hardware": "4",
    "software": "5.5"
    }
    }
    }
    }
    }
verticalFrontMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

Example Payloads

GET Requests

  • Arbitrary (Vertical Front Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalFrontThruster/pivotVerticalFrontMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0B22992D01ED": {
    "model": 18,
    "verticalFrontMotorDiagnostics": {
    "current": 16,
    "overcurrent": true,
    "pwm": 33,
    "rpm": 39
    }
    }
    }
    }
    }
  • Resting position (Vertical Front Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalFrontThruster/pivotVerticalFrontMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "16FEF3ED8F54": {
    "model": 18,
    "verticalFrontMotorDiagnostics": {
    "current": 10,
    "overcurrent": false,
    "pwm": 0,
    "rpm": -1
    }
    }
    }
    }
    }
verticalRearMotorDiagnostics?: MotorDiagnostics

Motor Diagnostics

Example Payloads

GET Requests

  • Arbitrary (Vertical Rear Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalRearThruster/pivotVerticalRearMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "FDD04FB2E187": {
    "model": 18,
    "verticalRearMotorDiagnostics": {
    "current": 88,
    "overcurrent": true,
    "pwm": 35,
    "rpm": -35
    }
    }
    }
    }
    }
  • Resting position (Vertical Rear Motor)

    From ./dist/samples/json/requests/devices/vehicles/pivot/thrusters/verticalRearThruster/pivotVerticalRearMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D8852716CA4E": {
    "model": 18,
    "verticalRearMotorDiagnostics": {
    "current": 8,
    "overcurrent": false,
    "pwm": 5,
    "rpm": 1
    }
    }
    }
    }
    }
waterTemp?: number

Water temperature in degrees celsius

Example Payloads

UPDATE Requests

  • Minimum water temperature

    From ./dist/samples/json/requests/devices/vehicles/pivot/temperature/waterTemp/waterTemperatureMinSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "B46970676612": {
    "model": 18,
    "waterTemp": -10
    }
    }
    }
    }
  • Maximum water temperature

    From ./dist/samples/json/requests/devices/vehicles/pivot/temperature/waterTemp/waterTemperatureMaxSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A7FC5A212903": {
    "model": 18,
    "waterTemp": 50
    }
    }
    }
    }
  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/pivot/temperature/waterTemp/waterTemperatureRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.50.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C567C898DEF5": {
    "model": 18,
    "waterTemp": 43
    }
    }
    }
    }