Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRevolution

notexported

See type declaration

Revolution ROV

DELETE Request

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

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

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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "576D07DA9422": {
                    "model": 18,
                    "altitude": 194
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A1C65FF0FF05": {
                    "model": 13,
                    "altitudeValid": false
                }
            }
        }
    }
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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "BDD8EA1D7C2E": {
                    "model": 18,
                    "altitude": 92,
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D213C4973A66": {
                    "model": 13,
                    "altitudeValid": true,
                    "altitude": 24
                }
            }
        }
    }

  • 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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E651B9C74380": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A1C65FF0FF05": {
                    "model": 13,
                    "altitudeValid": false
                }
            }
        }
    }
readonly

Optional auxLight

auxLight?: Light

Aux Light

Controls the auxiliary light attached to the Revolution.

remarks

See Light type for more details.

Example Payloads

SET Requests
  • Light On (mid)

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

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

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

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

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

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

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "SET",
    "payload": {
        "devices": {
            "9ACFD313F082": {
                "model": 13,
                "auxLight": {
                    "intensity": 12
                }
            }
        }
    }
}

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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0FAB44D87583": {
                    "model": 13,
                    "bodyLeak": false
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5532C0DB5E85": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "171021B95459": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D34656FECFF5": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "44C72D05E0FE": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "DEE24D094F69": {
                    "model": 18,
                    "bodyLeak": true
                }
            }
        }
    }
readonly

Optional cameraHead

cameraHead?: Removable<TiltCameraHead>

Camera Head

Controls the camera head attached to the revolution

remarks

See cameraHead type for more details

Example Payloads

Set Requests

Optional cameras

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

📷 List of cameras

Holds a list of all vehicle Cameras.

Optional cpProbe

cpProbe?: string

The cp probe

Optional cpuTemp

cpuTemp?: number

CPU temperature sensors in degrees celsius

Example Payloads

UPDATE Requests
  • Arbitrary

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "1159346C4091": {
                "model": 13,
                "cpuTemp": 95
            }
        }
    }
}

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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "1C4750BE5110": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "9194AF2E0F55": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "AE9AC18A1FA8": {
                "model": 18,
                "depth": 6
            }
        }
    }
}

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "SET",
    "payload": {
        "devices": {
            "E1B0CB6A162F": {
                "model": 13,
                "depth": 13
            }
        }
    }
}
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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "6C30E93EB49F": {
                    "model": 18,
                    "drive": {
                        "thrust": {
                            "forward": 52,
                            "yaw": -14,
                            "vertical": -9,
                            "lateral": 80
                        },
                        "modes": {
                            "headingLock": true,
                            "altitudeLock": true,
                            "depthLock": false,
                            "autoStabilization": true,
                            "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.58.14",
        "method": "SET",
        "payload": {
            "devices": {
                "BB51D366A8C6": {
                    "model": 13,
                    "drive": {
                        "thrust": {
                            "forward": -67,
                            "yaw": -94,
                            "vertical": -85,
                            "lateral": -81
                        },
                        "modes": {
                            "headingLock": false,
                            "altitudeLock": true,
                            "depthLock": true,
                            "autoStabilization": false,
                            "motorsDisabled": true
                        }
                    }
                }
            }
        }
    }

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

Front Left Motor Diagnostics

Example Payloads

UPDATE Requests
  • All arbitrary values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3F0A60F2E8F9": {
                "model": 13,
                "frontLeftMotorDiagnostics": {
                    "current": 39,
                    "overcurrent": true,
                    "pwm": 13,
                    "rpm": -43,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8DC831B7A095": {
                "model": 13,
                "frontLeftMotorDiagnostics": {
                    "current": 0,
                    "overcurrent": false,
                    "pwm": 1,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Optional frontRightMotorDiagnostics

frontRightMotorDiagnostics?: MotorDiagnostics

Front Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4BC11784EB8A": {
                "model": 13,
                "frontRightMotorDiagnostics": {
                    "current": 72,
                    "overcurrent": false,
                    "pwm": 5,
                    "rpm": 35,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BDDA77E31C87": {
                "model": 13,
                "frontRightMotorDiagnostics": {
                    "current": 0,
                    "overcurrent": false,
                    "pwm": 0,
                    "rpm": 1,
                    "failure": false
                }
            }
        }
    }
}

Optional grabber

grabber?: Grabber

Grabber

remarks

see Grabber for more details}

Example Payloads

SET Requests
  • Arbitrary

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BB350525C45C": {
                "model": 13,
                "grabber": {
                    "rotate": -70,
                    "openClose": -73
                }
            }
        }
    }
}
  • Resting

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

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

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

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

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

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

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

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

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CCF5C1D0A452": {
                "model": 13,
                "grabber": {
                    "rotate": 100
                }
            }
        }
    }
}

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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "62150D457CA3": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D9A0EAC75623": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6072A76AF35F": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "04C358AB2E62": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "C42197C15B01": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "DDC19A5C3381": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "3417009E22A4": {
                    "model": 13,
                    "ip": "192.168.171.126"
                }
            }
        }
    }

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

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

Optional leftBattery

leftBattery?: Battery

Left Battery

Example Payloads

UPDATE Requests
  • All arbitrary values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A3A18C4C81C7": {
                "model": 13,
                "leftBattery": {
                    "percent": 96,
                    "voltage": 100,
                    "charging": false
                }
            }
        }
    }
}
  • Left battery warning

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

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

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

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

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

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

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

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

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

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

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D0A8474E1C59": {
                "model": 13,
                "leftBattery": {
                    "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: Revolution

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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5C69029E9519": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "99D8124340DD": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "A335B9A8AECD": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D403DE0C8B81": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E2D6F7039DC5": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 92,
                            "y": -22,
                            "uncertainty": 29
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5EAFCE71B1AD": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -61,
                            "longitude": 56,
                            "uncertainty": 66
                        }
                    }
                }
            }
        }
    }

  • 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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E23F79C03185": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 614,
                            "y": 412,
                            "uncertainty": 77
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4059F7BCFC7C": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": -62,
                            "longitude": 142,
                            "uncertainty": 41
                        }
                    }
                }
            }
        }
    }

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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F4D98B1757D9": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E23F79C03185": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": 614,
                            "y": 412,
                            "uncertainty": 77
                        }
                    }
                }
            }
        }
    }

  • 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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "99DD8F8453E6": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4059F7BCFC7C": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": -62,
                            "longitude": 142,
                            "uncertainty": 41
                        }
                    }
                }
            }
        }
    }

Optional rearLeftMotorDiagnostics

rearLeftMotorDiagnostics?: MotorDiagnostics

Rear Left Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C435E45C8202": {
                "model": 13,
                "rearLeftMotorDiagnostics": {
                    "current": 77,
                    "overcurrent": false,
                    "pwm": 88,
                    "rpm": -73,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "1C3BF60B1304": {
                "model": 13,
                "rearLeftMotorDiagnostics": {
                    "current": 5,
                    "overcurrent": false,
                    "pwm": 1,
                    "rpm": 0,
                    "failure": false
                }
            }
        }
    }
}

Optional rearRightMotorDiagnostics

rearRightMotorDiagnostics?: MotorDiagnostics

Rear Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "5F3C22AA0F2B": {
                "model": 13,
                "rearRightMotorDiagnostics": {
                    "current": 80,
                    "overcurrent": true,
                    "pwm": 28,
                    "rpm": -45,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0EE3C7BA7B99": {
                "model": 13,
                "rearRightMotorDiagnostics": {
                    "current": 4,
                    "overcurrent": false,
                    "pwm": 2,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Optional rightBattery

rightBattery?: Battery

Right Battery

Examples

UPDATE Requests
  • All Arbitrary values

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

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

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

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

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

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

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

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

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

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

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

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

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "869C8B3DF9FE": {
                "model": 13,
                "rightBattery": {
                    "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 motor 1 on the Rov. This spare motor can be used to extend the capabilities of the ROV by attaching a power tool to it.

Example Payloads

UPDATE Requests

  • Resting spare motor 1 diagnostics sample

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "05F5C36E3251": {
                    "model": 13,
                    "spareMotor1": {
                        "current": 17,
                        "overcurrent": false,
                        "pwm": 56,
                        "rpm": 96,
                        "failure": false
                    }
                }
            }
        }
    }

  • Arbitrary Spare Motor 1 Diagnostics sample

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "34DD2559239F": {
                    "model": 13,
                    "spareMotor1": {
                        "current": 53,
                        "overcurrent": true,
                        "pwm": 9,
                        "rpm": -25,
                        "failure": false
                    }
                }
            }
        }
    }

Optional spareMotor2

spareMotor2?: MotorDiagnostics

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

Example Payloads

UPDATE Requests

  • Resting spare motor 2 diagnostics sample

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "3842BDF8D759": {
                    "model": 13,
                    "spareMotor2": {
                        "current": 31,
                        "overcurrent": true,
                        "pwm": 12,
                        "rpm": 72,
                        "failure": false
                    }
                }
            }
        }
    }

  • Arbitrary Spare Motor 2 Diagnostics sample

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2999B4683A31": {
                    "model": 13,
                    "spareMotor2": {
                        "current": 45,
                        "overcurrent": true,
                        "pwm": 92,
                        "rpm": -24,
                        "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5E320DD193A8": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "806DE47AE410": {
                    "model": 18,
                    "usageTime": {
                        "totalSeconds": 58,
                        "currentSeconds": 36
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0D1EF5582F01": {
                    "model": 13,
                    "usageTime": {
                        "totalSeconds": 48,
                        "currentSeconds": 21
                    }
                }
            }
        }
    }

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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "49ECDB6E8A6D": {
                    "model": 13,
                    "velocity": {
                        "valid": false,
                        "forward": 61,
                        "rightward": 58,
                        "downward": 26,
                        "speed": 100
                    }
                }
            }
        }
    }
  • 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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0639D6EB167B": {
                    "model": 18,
                    "velocity": {
                        "valid": true,
                        "forward": -89,
                        "rightward": -5,
                        "downward": -36,
                        "speed": 20
                    }
                }
            }
        }
    }

Optional version

version?: DeviceVersion

ROV Version

readonly

Optional verticalLeftMotorDiagnostics

verticalLeftMotorDiagnostics?: MotorDiagnostics

Vertical Left Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6E6A25C47BEA": {
                "model": 13,
                "verticalLeftMotorDiagnostics": {
                    "current": 11,
                    "overcurrent": false,
                    "pwm": 73,
                    "rpm": -83,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "54D5D028D31F": {
                "model": 13,
                "verticalLeftMotorDiagnostics": {
                    "current": 0,
                    "overcurrent": false,
                    "pwm": 1,
                    "rpm": 1,
                    "failure": false
                }
            }
        }
    }
}

Optional verticalRightMotorDiagnostics

verticalRightMotorDiagnostics?: MotorDiagnostics

Vertical Right Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests
  • All arbitrary values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C80B963816A0": {
                "model": 13,
                "verticalRightMotorDiagnostics": {
                    "current": 37,
                    "overcurrent": true,
                    "pwm": 100,
                    "rpm": -17,
                    "failure": false
                }
            }
        }
    }
}
  • Resting values

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "752B3DE93A93": {
                "model": 13,
                "verticalRightMotorDiagnostics": {
                    "current": 6,
                    "overcurrent": false,
                    "pwm": 5,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Optional waterTemp

waterTemp?: number
  • Arbitrary temp

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

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

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

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

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

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