Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPivot

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.58.12",
    "method": "DELETE",
    "payload": {
        "devices": {
            "A79C30AD15E3": {
                "model": 18
            }
        }
    }
}

Hierarchy

Index

Properties

Properties

Optional altitude

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "FAD20E7CA909": {
                    "model": 18,
                    "altitude": 247
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "79784F4FBFEF": {
                    "model": 13,
                    "altitudeValid": true
                }
            }
        }
    }
readonly

Optional altitudeValid

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "3F9D41F8F175": {
                    "model": 18,
                    "altitude": 228,
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "FA6823DD2417": {
                    "model": 13,
                    "altitudeValid": true,
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6F0D84778318": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "79784F4FBFEF": {
                    "model": 13,
                    "altitudeValid": true
                }
            }
        }
    }
readonly

Optional auxLight

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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "66F32228E1A2": {
                    "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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "D9EE84381F6F": {
                    "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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "671EA32668A1": {
                    "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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "1078C2747733": {
                    "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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "019DC2E82A8E": {
                    "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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "6408E6D1B979": {
                    "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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "B167D96A050F": {
                    "model": 18,
                    "auxLight": {
                        "intensity": 49
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "5125D0C3C7FC": {
                    "model": 13,
                    "auxLight": {
                        "intensity": 38
                    }
                }
            }
        }
    }

Optional bodyLeak

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "16793EAF2D25": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "63FFF938FEDE": {
                    "model": 18,
                    "bodyLeak": true
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F5120477219C": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "049704DAED47": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7C70D3760874": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "AF261ACE162C": {
                    "model": 18,
                    "bodyLeak": true
                }
            }
        }
    }
readonly

Optional cameraHead

cameraHead?: Removable<TiltCameraHead>

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F9277D772233": {
                    "model": 18
                }
            }
        }
    }

Optional cameras

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.58.12",
    "method": "DELETE",
    "payload": {
        "devices": {
            "F0DAF62835F8": {
                "model": 18,
                "cameras": {
                    "14B80BFC3112": {}
                }
            }
        }
    }
}

Optional cpProbe

cpProbe?: string

The cp probe

Optional cpuTemp

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "510F177560CF": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "45ABF734F4F5": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "8A9275BDC065": {
                    "model": 18,
                    "cpuTemp": 26
                }
            }
        }
    }

Optional cygnus

cygnus?: cygnusType

The ut(cygnus) probe

Optional depth

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.58.12",
    "method": "SET",
    "payload": {
        "devices": {
            "5288F1A98373": {
                "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.58.12",
    "method": "SET",
    "payload": {
        "devices": {
            "543FDFD037E1": {
                "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.58.12",
    "method": "SET",
    "payload": {
        "devices": {
            "51CB263E86F4": {
                "model": 18,
                "depth": 5
            }
        }
    }
}

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.12",
    "method": "SET",
    "payload": {
        "devices": {
            "22E9F6C19F15": {
                "model": 13,
                "depth": 196
            }
        }
    }
}
readonly

Optional directPowerKitPresent

directPowerKitPresent?: boolean

Direct Power Kit Present Flag

readonly

Optional drive

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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "EF72A8F4A92C": {
                    "model": 18,
                    "drive": {
                        "thrust": {
                            "forward": -1,
                            "yaw": 18,
                            "vertical": -78,
                            "lateral": 21
                        },
                        "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.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "849CFF2E6F35": {
                    "model": 13,
                    "drive": {
                        "thrust": {
                            "forward": 64,
                            "yaw": -94,
                            "vertical": -93,
                            "lateral": 16
                        },
                        "modes": {
                            "headingLock": true,
                            "altitudeLock": true,
                            "depthLock": false,
                            "autoStabilization": false,
                            "motorsDisabled": false
                        }
                    }
                }
            }
        }
    }

Optional echosounder

echosounder?: Echosounder

Echosounder device information and control

Optional forwardDistance

forwardDistance?: number

Rov Forward distance

Measured in meters to show relative distance to an object ahead of the ROV.

readonly

Optional frontLeftMotorDiagnostics

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "043F3A40913A": {
                    "model": 18,
                    "frontLeftMotorDiagnostics": {
                        "current": 61,
                        "overcurrent": false,
                        "pwm": 17,
                        "rpm": -62,
                        "failure": false
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7014452AD93B": {
                    "model": 18,
                    "frontLeftMotorDiagnostics": {
                        "current": 4,
                        "overcurrent": false,
                        "pwm": 5,
                        "rpm": -1,
                        "failure": false
                    }
                }
            }
        }
    }

Optional frontRightMotorDiagnostics

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "60DE57C01D92": {
                    "model": 18,
                    "frontRightMotorDiagnostics": {
                        "current": 31,
                        "overcurrent": false,
                        "pwm": 49,
                        "rpm": -36,
                        "failure": false
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "531183D625DB": {
                    "model": 18,
                    "frontRightMotorDiagnostics": {
                        "current": 2,
                        "overcurrent": false,
                        "pwm": 2,
                        "rpm": 0,
                        "failure": false
                    }
                }
            }
        }
    }

Optional grabber

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "FF3E4F342A19": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F192E6CD9410": {
                    "model": 18,
                    "grabber": {
                        "openCloseMotorDiagnostics": {
                            "current": 8,
                            "overcurrent": false,
                            "pwm": 5,
                            "rpm": -1,
                            "failure": false
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5D3962B42E17": {
                    "model": 18,
                    "grabber": {
                        "rotateMotorDiagnostics": {
                            "current": 9,
                            "overcurrent": false,
                            "pwm": 2,
                            "rpm": 0,
                            "failure": false
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "1F497D9D7466": {
                    "model": 18,
                    "grabber": {
                        "rotateMotorDiagnostics": {
                            "current": 98,
                            "overcurrent": false,
                            "pwm": 79,
                            "rpm": 46,
                            "failure": false
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4CEA0137AC04": {
                    "model": 18,
                    "grabber": {
                        "openCloseMotorDiagnostics": {
                            "current": 75,
                            "overcurrent": true,
                            "pwm": 78,
                            "rpm": 7,
                            "failure": false
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "64CF9F6045C5": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "74FC265459AA": {
                    "model": 18,
                    "grabber": {
                        "openCloseMotorDiagnostics": {
                            "current": 55,
                            "overcurrent": false,
                            "pwm": 52,
                            "rpm": 6
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6D3508C324F3": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "9F2EBBEFE6F8": {
                    "model": 18,
                    "grabber": {
                        "openCloseMotorDiagnostics": {
                            "current": 53,
                            "overcurrent": false,
                            "pwm": 48,
                            "rpm": 7
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "BA417C5A54FC": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "8B85302B1CB8": {
                    "model": 18,
                    "grabber": {
                        "rotateMotorDiagnostics": {
                            "current": 55,
                            "overcurrent": false,
                            "pwm": 54,
                            "rpm": 10
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "85BF470D6B0B": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "64F40A15CFC3": {
                    "model": 18,
                    "grabber": {
                        "rotateMotorDiagnostics": {
                            "current": 50,
                            "overcurrent": false,
                            "pwm": 51,
                            "rpm": 9
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5D3962B42E17": {
                    "model": 18,
                    "grabber": {
                        "rotateMotorDiagnostics": {
                            "current": 9,
                            "overcurrent": false,
                            "pwm": 2,
                            "rpm": 0,
                            "failure": false
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4C2C55CF5B15": {
                    "model": 18,
                    "grabber": {
                        "openClose": 59,
                        "rotate": -32
                    }
                }
            }
        }
    }

Optional heading

heading?: number

Rov heading

Measured in degrees from north bearing

minimum

0

maximum

360

readonly

Optional inWater

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2191F5B6EC8E": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "ECFC3CA27309": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "61B60C8D1D12": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "622455E7FD2F": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "63D723475EB8": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A2AD4B65A530": {
                    "model": 13,
                    "inWater": false
                }
            }
        }
    }

Optional ip

ip?: string

IP Address

Example Payloads

SET Requests
  • Arbitrary

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "5C55AC3D80C6": {
                    "model": 13,
                    "ip": "192.168.160.68"
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "SET",
        "payload": {
            "devices": {
                "1FEDC7E4089B": {
                    "model": 18,
                    "ip": "192.168.24.75"
                }
            }
        }
    }
readonly

Optional leftBattery

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.58.12",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "BD269E6D0A1D": {
                      "model": 18,
                      "leftBattery": {
                          "percent": 96
                      }
                  }
              }
          }
      }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "8D12B2D8E796": {
                    "model": 18,
                    "leftBattery": {
                        "voltage": 38
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F961B9B92E41": {
                    "model": 18,
                    "leftBattery": {
                        "leak": true
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A0B714CC016E": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "02EADF402C3B": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "C2FA1E6D1766": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "10DE3F55BD36": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F798C683C11D": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B7E945F6BA27": {
                    "model": 18,
                    "leftBattery": {
                        "percent": 52,
                        "voltage": 15,
                        "charging": false,
                        "leak": false
                    }
                }
            }
        }
    }

Optional localHeading

localHeading?: number

Rov local heading

Measure in degrees from local heading

minimum

-360

maximum

360

Optional locationForwarderOptions

locationForwarderOptions?: LocationForwarderOptions

Location Forwarding Options

description

Locaiton forwarder settings and options for the ROV and Topside location forwarding

model

model: Pivot

Optional navigationOptions

navigationOptions?: NavigationOptions

Navigation Options

description

Navigation settings and options for the ROV

Optional pitch

pitch?: number

Rov pitch

Measured in degrees from neutral pitch position

minimum

-180.0

maximum

180.0

readonly

Optional position

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/revolutionLocalPositionInvalidSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B9CA7AA089B7": {
                    "model": 13,
                    "position": {
                        "local": {
                            "uncertainty": 10000
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5A856DC76FA3": {
                    "model": 13,
                    "position": {
                        "global": {
                            "uncertainty": 10000
                        }
                    }
                }
            }
        }
    }

  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A5FFE44A0F": {
                    "model": 18,
                    "position": {
                        "local": {
                            "uncertainty": 10000
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5E59AED2F15E": {
                    "model": 18,
                    "position": {
                        "global": {
                            "uncertainty": 10000
                        }
                    }
                }
            }
        }
    }

  • Arbitrary position sample

  • Revolution

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6211A813014B": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 297,
                            "y": 61,
                            "uncertainty": 50
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "33E07CEDA1FF": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -37,
                            "longitude": 43,
                            "uncertainty": 100
                        }
                    }
                }
            }
        }
    }

  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A63C3CFB18": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 655,
                            "y": -864,
                            "uncertainty": 84
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "09B2429E68CA": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 28,
                            "longitude": -41,
                            "uncertainty": 96
                        }
                    }
                }
            }
        }
    }

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "20222D09A858": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 10,
                            "y": 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D2A63C3CFB18": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 655,
                            "y": -864,
                            "uncertainty": 84
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5CB1D87198FD": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "09B2429E68CA": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 28,
                            "longitude": -41,
                            "uncertainty": 96
                        }
                    }
                }
            }
        }
    }

Optional rearLeftMotorDiagnostics

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.58.12",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "2F7F70AF6EC7": {
                      "model": 18,
                      "rearLeftMotorDiagnostics": {
                          "current": 36,
                          "overcurrent": false,
                          "pwm": 80,
                          "rpm": 22,
                          "failure": false
                      }
                  }
              }
          }
      }
  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A7844A25B45C": {
                    "model": 18,
                    "rearLeftMotorDiagnostics": {
                        "current": 5,
                        "overcurrent": false,
                        "pwm": 3,
                        "rpm": -1,
                        "failure": false
                    }
                }
            }
        }
    }

Optional rearRightMotorDiagnostics

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.58.12",
          "method": "UPDATE",
          "payload": {
              "devices": {
                  "5066D17BA03C": {
                      "model": 18,
                      "rearRightMotorDiagnostics": {
                          "current": 68,
                          "overcurrent": false,
                          "pwm": 12,
                          "rpm": -46,
                          "failure": false
                      }
                  }
              }
          }
      }
  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E5F60185427F": {
                    "model": 18,
                    "rearRightMotorDiagnostics": {
                        "current": 5,
                        "overcurrent": false,
                        "pwm": 3,
                        "rpm": 1,
                        "failure": false
                    }
                }
            }
        }
    }

Optional rightBattery

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "46E513C5F197": {
                    "model": 18,
                    "rightBattery": {
                        "percent": 23
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "EDB68E7E9EC4": {
                    "model": 18,
                    "rightBattery": {
                        "voltage": 54
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "BF50AB0B0BA1": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F300B2C2C3CB": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "DD0C2869A15A": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E5ACE4809A08": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A6400E9B052A": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2A2439FA0129": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B692501114E0": {
                    "model": 18,
                    "rightBattery": {
                        "percent": 73,
                        "voltage": 10,
                        "charging": true,
                        "leak": false
                    }
                }
            }
        }
    }

Optional roll

roll?: number

Rov roll

Measured in degrees from neutral roll position

minimum

-180.0

maximum

180.0

readonly

Optional sensorPod

sensorPod?: CalibratableSensorPod

Sensor pod information and calibration controls based on the model.

  • Revolution Calibration User Actions for IMU Calibration. dist/samples/json/requests/devices/vehicles/revolution/calibration/startImuCalibration/revolutionStartImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/stopImuCalibration/revolutionStopImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/denyImuCalibration/revolutionDenyImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptImuCalibration/revolutionAcceptImuCalibrationRequest.json

dist/samples/json/requests/devices/vehicles/pivot/calibration/startImuCalibration/pivotStartImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/stopImuCalibration/pivotStopImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/denyImuCalibration/pivotDenyImuCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptImuCalibration/pivotAcceptImuCalibrationRequest.json

  • Revolution Calibration User Actions for Magnetic Calibration. dist/samples/json/requests/devices/vehicles/revolution/calibration/startMagneticCalibration/revolutionStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/stopMagneticCalibration/revolutionStopMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/denyMagneticCalibration/revolutionDenyMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptMagneticCalibration/revolutionAcceptMagneticCalibrationRequest.json

dist/samples/json/requests/devices/vehicles/pivot/calibration/startMagneticCalibration/pivotStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/stopMagneticCalibration/pivotStopMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/denyMagneticCalibration/pivotDenyMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptMagneticCalibration/pivotAcceptMagneticCalibrationRequest.json

  • Revolution and Pivot Pending IMU update dist/samples/json/requests/devices/vehicles/revolution/calibration/startMagneticCalibration/revolutionStartMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorPendingImuCalibration/pivotPendingImuRandomUpdate.json

  • Revolution and Pivot Pending Magnetic update dist/samples/json/requests/devices/vehicles/revolution/calibration/sensorMagneticCalibration/revolutionPendingMagneticRandomUpdate.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorPendingMagneticCalibration/pivotPendingMagneticRandomUpdate.json

  • Revolution and Pivot Accepted Magnetic and IMU update dist/samples/json/requests/devices/vehicles/revolution/calibration/acceptMagneticCalibration/revolutionAcceptMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/acceptMagneticCalibration/pivotAcceptMagneticCalibrationRequest.json dist/samples/json/requests/devices/vehicles/pivot/calibration/sensorNotCalibratingState/pivotAcceptedRandomUpdate.json dist/samples/json/requests/devices/vehicles/revolution/calibration/sensorNotCalibratingState/revolutionAcceptedRandomUpdate.json

Optional sensorPodLeak

sensorPodLeak?: boolean

Sensor Pod Leak Fault

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

Optional spareMotor1

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "8E80C8393768": {
                    "model": 18,
                    "spareMotor1": {
                        "current": 7,
                        "overcurrent": false,
                        "pwm": 1,
                        "rpm": 0,
                        "failure": false
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "443747297203": {
                    "model": 18,
                    "spareMotor1": {
                        "current": 27,
                        "overcurrent": false,
                        "pwm": 59,
                        "rpm": -53,
                        "failure": false
                    }
                }
            }
        }
    }

Optional tiltPlatform

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "07B7A369A42C": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "FA9DE43DA737": {
                    "model": 18,
                    "tiltPlatform": {
                        "tiltMotorDiagnostics": {
                            "current": 1,
                            "overcurrent": false,
                            "pwm": 4,
                            "rpm": -1,
                            "failure": false
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B5385A93794C": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D8182F754379": {
                    "model": 18,
                    "tiltPlatform": {
                        "tiltMotorDiagnostics": {
                            "current": 51,
                            "overcurrent": false,
                            "pwm": 50,
                            "rpm": 6
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "08E30529819D": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "73CA8D6E23C9": {
                    "model": 18,
                    "tiltPlatform": {
                        "tiltMotorDiagnostics": {
                            "current": 55,
                            "overcurrent": false,
                            "pwm": -54,
                            "rpm": -8
                        }
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2F9000658006": {
                    "model": 18,
                    "tiltPlatform": {
                        "tilt": -45
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "016CF789BFF0": {
                    "model": 18,
                    "tiltPlatform": {
                        "tiltMotorDiagnostics": {
                            "current": 64,
                            "overcurrent": false,
                            "pwm": 12,
                            "rpm": -71,
                            "failure": false
                        }
                    }
                }
            }
        }
    }

Optional turns

turns?: number

Turns

Count the number of turns the rov has completed

readonly

Optional usageTime

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "AA046C54E8B6": {
                    "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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "9A6763B13A04": {
                    "model": 18,
                    "usageTime": {
                        "totalSeconds": 67,
                        "currentSeconds": 90
                    }
                }
            }
        }
    }

Optional velocity

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B75E12BF7059": {
                    "model": 13,
                    "velocity": {
                        "valid": false,
                        "forward": -15,
                        "rightward": -76,
                        "downward": 13,
                        "speed": 36
                    }
                }
            }
        }
    }
  • Pivot

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "54C5088BC5BE": {
                    "model": 18,
                    "velocity": {
                        "valid": false,
                        "forward": 39,
                        "rightward": 27,
                        "downward": -53,
                        "speed": 58
                    }
                }
            }
        }
    }

Optional version

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D64D8F7BD9E6": {
                    "model": 18,
                    "version": {
                        "hardware": "0",
                        "software": "1.7"
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6F97CAF044FE": {
                    "model": 18,
                    "version": {
                        "hardware": "1",
                        "software": "2.0"
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "BB7B38AE4CD8": {
                    "model": 18,
                    "version": {
                        "hardware": "2",
                        "software": "3.0"
                    }
                }
            }
        }
    }

  • Arbitrary

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "83F98D246970": {
                    "model": 18,
                    "version": {
                        "hardware": "3",
                        "software": "4.4"
                    }
                }
            }
        }
    }

Optional verticalFrontMotorDiagnostics

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4D04F190E5B3": {
                    "model": 18,
                    "verticalFrontMotorDiagnostics": {
                        "current": 24,
                        "overcurrent": false,
                        "pwm": 1,
                        "rpm": 79,
                        "failure": false
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "78DC2F0D6709": {
                    "model": 18,
                    "verticalFrontMotorDiagnostics": {
                        "current": 1,
                        "overcurrent": false,
                        "pwm": 0,
                        "rpm": 0,
                        "failure": false
                    }
                }
            }
        }
    }

Optional verticalRearMotorDiagnostics

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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "18E72B3F06B2": {
                    "model": 18,
                    "verticalRearMotorDiagnostics": {
                        "current": 87,
                        "overcurrent": true,
                        "pwm": 74,
                        "rpm": 15,
                        "failure": false
                    }
                }
            }
        }
    }

  • 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.58.12",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "81F1EA727458": {
                    "model": 18,
                    "verticalRearMotorDiagnostics": {
                        "current": 2,
                        "overcurrent": false,
                        "pwm": 0,
                        "rpm": 1,
                        "failure": false
                    }
                }
            }
        }
    }

Optional waterTemp

waterTemp?: number

Water temperature in degrees celsius

Example Payloads

UPDATE Requests

  • Minimum water temperature

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

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

  • Maximum water temperature

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

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

  • Arbitrary

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

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