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.6",
    "method": "DELETE",
    "payload": {
        "devices": {
            "772802ED43A5": {
                "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "08338BA254BD": {
                    "model": 18,
                    "altitude": 79
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "35B69A53D413": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7716AD3BA25E": {
                    "model": 18,
                    "altitude": 272,
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "81D1AA0524AB": {
                    "model": 13,
                    "altitudeValid": true,
                    "altitude": 113
                }
            }
        }
    }

  • 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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "BB2C68263B1B": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "35B69A53D413": {
                    "model": 13,
                    "altitudeValid": true
                }
            }
        }
    }
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.6",
    "method": "SET",
    "payload": {
        "devices": {
            "D72EB3C615A6": {
                "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.6",
    "method": "SET",
    "payload": {
        "devices": {
            "DAB2BB623EE0": {
                "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.6",
    "method": "SET",
    "payload": {
        "devices": {
            "70BEE3DAFF17": {
                "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.6",
    "method": "SET",
    "payload": {
        "devices": {
            "6E43DCD072C1": {
                "model": 13,
                "auxLight": {
                    "intensity": 83
                }
            }
        }
    }
}

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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "D16A0DC5E074": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "85F79ADED5EA": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "729D72C7AA5A": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "5478BD4EF659": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2E614133CB8D": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "36D38DCAEECB": {
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "98E641868518": {
                "model": 13,
                "cpuTemp": 52
            }
        }
    }
}

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.6",
    "method": "SET",
    "payload": {
        "devices": {
            "8A55CFA2BEF2": {
                "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.6",
    "method": "SET",
    "payload": {
        "devices": {
            "FDE5A6F59D2D": {
                "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.6",
    "method": "SET",
    "payload": {
        "devices": {
            "71E1B5627CD0": {
                "model": 18,
                "depth": 48
            }
        }
    }
}

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.6",
    "method": "SET",
    "payload": {
        "devices": {
            "38F697726895": {
                "model": 13,
                "depth": 300
            }
        }
    }
}
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.6",
        "method": "SET",
        "payload": {
            "devices": {
                "EA6255BA12F3": {
                    "model": 18,
                    "drive": {
                        "thrust": {
                            "forward": -41,
                            "yaw": 0,
                            "vertical": 23,
                            "lateral": -55
                        },
                        "modes": {
                            "headingLock": true,
                            "altitudeLock": false,
                            "depthLock": true,
                            "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.6",
        "method": "SET",
        "payload": {
            "devices": {
                "E85D48EB2A05": {
                    "model": 13,
                    "drive": {
                        "thrust": {
                            "forward": 96,
                            "yaw": -34,
                            "vertical": -58,
                            "lateral": 66
                        },
                        "modes": {
                            "headingLock": false,
                            "altitudeLock": false,
                            "depthLock": true,
                            "autoStabilization": false,
                            "motorsDisabled": false
                        }
                    }
                }
            }
        }
    }

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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "617CB6F33E62": {
                "model": 13,
                "frontLeftMotorDiagnostics": {
                    "current": 75,
                    "overcurrent": false,
                    "pwm": 0,
                    "rpm": 50,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F9B45858D012": {
                "model": 13,
                "frontLeftMotorDiagnostics": {
                    "current": 7,
                    "overcurrent": false,
                    "pwm": 0,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F6C16D53499A": {
                "model": 13,
                "frontRightMotorDiagnostics": {
                    "current": 63,
                    "overcurrent": false,
                    "pwm": 30,
                    "rpm": -76,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D67E8030905C": {
                "model": 13,
                "frontRightMotorDiagnostics": {
                    "current": 7,
                    "overcurrent": false,
                    "pwm": 4,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "83E1C34C4DEC": {
                "model": 13,
                "grabber": {
                    "rotate": 78,
                    "openClose": -20
                }
            }
        }
    }
}
  • 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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "28BE3BCE36D0": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "29CD02CA7D4D": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FA0BFFF320C2": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "40A4D5E96935": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "91F06ED29566": {
                "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F1D6E8FC9157": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "6D2437F6344E": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F78FFC588D45": {
                    "model": 18,
                    "inWater": false
                }
            }
        }
    }

  • Revolution out of water

    From ./dist/samples/json/requests/devices/vehicles/revolution/inWater/revolutionOutOfWaterSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "58D9739C4E53": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "C7C6E5F3FE3A": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "9BB9D0FCAB89": {
                    "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.6",
        "method": "SET",
        "payload": {
            "devices": {
                "DA7ADEC39175": {
                    "model": 13,
                    "ip": "192.168.68.203"
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.6",
        "method": "SET",
        "payload": {
            "devices": {
                "BBD507825B32": {
                    "model": 18,
                    "ip": "192.168.76.124"
                }
            }
        }
    }
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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "AFA8A3B253C2": {
                "model": 13,
                "leftBattery": {
                    "percent": 66,
                    "voltage": 100,
                    "charging": true
                }
            }
        }
    }
}
  • Left battery warning

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

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0CF9B21DE574": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CEAB0589B063": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DCB107D0D8F5": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8269701DDC9B": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "11EBC900DCC7": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "5B6EEB03F977": {
                "model": 13,
                "leftBattery": {
                    "leak": false
                }
            }
        }
    }
}

Optional localHeading

localHeading?: number

Rov local heading

Measure in degrees from local heading

minimum

-360

maximum

360

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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "B8BBA54DEF21": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4A966B7CB834": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "55D3B2D1222F": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7ADE93C948F1": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "26AA89EA5B5F": {
                    "model": 13,
                    "position": {
                        "local": {
                            "x": 447,
                            "y": 557,
                            "uncertainty": 65
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "7B3555349603": {
                    "model": 13,
                    "position": {
                        "global": {
                            "latitude": -49,
                            "longitude": -110,
                            "uncertainty": 78
                        }
                    }
                }
            }
        }
    }

  • 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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "634A1E0B3DFA": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": -917,
                            "y": 786,
                            "uncertainty": 42
                        }
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "88A4DF75BA4D": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 24,
                            "longitude": 54,
                            "uncertainty": 95
                        }
                    }
                }
            }
        }
    }

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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "EB314ADF7A51": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "634A1E0B3DFA": {
                    "model": 18,
                    "position": {
                        "local": {
                            "x": -917,
                            "y": 786,
                            "uncertainty": 42
                        }
                    }
                }
            }
        }
    }

  • 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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4370FB62C127": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "88A4DF75BA4D": {
                    "model": 18,
                    "position": {
                        "global": {
                            "latitude": 24,
                            "longitude": 54,
                            "uncertainty": 95
                        }
                    }
                }
            }
        }
    }

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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "51F9856C045F": {
                "model": 13,
                "rearLeftMotorDiagnostics": {
                    "current": 61,
                    "overcurrent": false,
                    "pwm": 67,
                    "rpm": -82,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A6A11B56AEB7": {
                "model": 13,
                "rearLeftMotorDiagnostics": {
                    "current": 6,
                    "overcurrent": false,
                    "pwm": 0,
                    "rpm": 1,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2A18E35D0F39": {
                "model": 13,
                "rearRightMotorDiagnostics": {
                    "current": 73,
                    "overcurrent": false,
                    "pwm": 40,
                    "rpm": 92,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A9E1074EAAC0": {
                "model": 13,
                "rearRightMotorDiagnostics": {
                    "current": 4,
                    "overcurrent": false,
                    "pwm": 2,
                    "rpm": 0,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "206360B62796": {
                "model": 13,
                "rightBattery": {
                    "percent": 77,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F66329AC01ED": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "705512A444A8": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C1480F288B7D": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "27235FB45DB9": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C0B403B623E6": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A5FA00D75187": {
                "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F3F9241E08FE": {
                    "model": 13,
                    "spareMotor1": {
                        "current": 7,
                        "overcurrent": true,
                        "pwm": 80,
                        "rpm": 10,
                        "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "CDEE4F86375E": {
                    "model": 13,
                    "spareMotor1": {
                        "current": 6,
                        "overcurrent": false,
                        "pwm": 90,
                        "rpm": 49,
                        "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "14E0A9AEF92B": {
                    "model": 13,
                    "spareMotor2": {
                        "current": 23,
                        "overcurrent": true,
                        "pwm": 20,
                        "rpm": 0,
                        "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "817EB82CE10A": {
                    "model": 13,
                    "spareMotor2": {
                        "current": 80,
                        "overcurrent": false,
                        "pwm": 87,
                        "rpm": 42,
                        "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "66DE67A54F50": {
                    "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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "ECBB51198695": {
                    "model": 18,
                    "usageTime": {
                        "totalSeconds": 84,
                        "currentSeconds": 73
                    }
                }
            }
        }
    }

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

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.58.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "0D66BD0ABC63": {
                    "model": 13,
                    "usageTime": {
                        "totalSeconds": 52,
                        "currentSeconds": 73
                    }
                }
            }
        }
    }

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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "766292B258AF": {
                    "model": 13,
                    "velocity": {
                        "valid": true,
                        "forward": -89,
                        "rightward": -18,
                        "downward": 18,
                        "speed": 81
                    }
                }
            }
        }
    }
  • 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.6",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "2130447F9506": {
                    "model": 18,
                    "velocity": {
                        "valid": true,
                        "forward": 93,
                        "rightward": -68,
                        "downward": 39,
                        "speed": 11
                    }
                }
            }
        }
    }

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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "078F0FB87411": {
                "model": 13,
                "verticalLeftMotorDiagnostics": {
                    "current": 28,
                    "overcurrent": true,
                    "pwm": 53,
                    "rpm": 26,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "931F5F422DCF": {
                "model": 13,
                "verticalLeftMotorDiagnostics": {
                    "current": 9,
                    "overcurrent": false,
                    "pwm": 3,
                    "rpm": 0,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "52EDBF22AAFD": {
                "model": 13,
                "verticalRightMotorDiagnostics": {
                    "current": 91,
                    "overcurrent": true,
                    "pwm": 2,
                    "rpm": 61,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B64D1A51A089": {
                "model": 13,
                "verticalRightMotorDiagnostics": {
                    "current": 3,
                    "overcurrent": false,
                    "pwm": 2,
                    "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FFA58B0F9A5F": {
                "model": 13,
                "waterTemp": 33
            }
        }
    }
}
  • 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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "772CC18ABF0D": {
                "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.6",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "75702FC8C9E6": {
                "model": 13,
                "waterTemp": -10
            }
        }
    }
}