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

See type declaration

Revolution ROV

DELETE Request

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

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

Hierarchy

Index

Properties

altitude?: number

Rov altitude

Measured in meters to show relative distance to floor.

Example Payloads

GET Requests

  • Random altitude

    From ./dist/samples/json/requests/devices/vehicles/pivot/altitude/pivotAltitudeRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5C9DE1311C56": {
    "model": 18,
    "altitude": 105
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1474B862A637": {
    "model": 13,
    "altitudeValid": false
    }
    }
    }
    }
readonly
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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A3524674ECE9": {
    "model": 18,
    "altitude": 174,
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "322179B987BE": {
    "model": 13,
    "altitudeValid": true,
    "altitude": 117
    }
    }
    }
    }
  • 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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "DEBB1635DA6D": {
    "model": 18,
    "altitudeValid": false
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1474B862A637": {
    "model": 13,
    "altitudeValid": false
    }
    }
    }
    }
readonly
auxLight?: Light

Aux Light

Controls the auxiliary light attached to the Revolution.

remarks

See Light type for more details.

Example Payloads

SET Requests

  • Light On (mid)

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

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.5",
"method": "SET",
"payload": {
"devices": {
"77A9D6F0DDE6": {
"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.5",
"method": "SET",
"payload": {
"devices": {
"3E2551F3CD68": {
"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.5",
"method": "SET",
"payload": {
"devices": {
"D03C80E6E734": {
"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.5",
"method": "SET",
"payload": {
"devices": {
"D36030988ABF": {
"model": 13,
"auxLight": {
"intensity": 97
}
}
}
}
}
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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7C480E23F971": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5ACF9A157BE5": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5B4477A195CB": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E5646D3F9823": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0F16D14353C8": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0DF3C01C6B68": {
    "model": 18,
    "bodyLeak": true
    }
    }
    }
    }
readonly

Camera Head

Controls the camera head attached to the revolution

remarks

See cameraHead type for more details

Example Payloads

Set Requests

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

📷 List of cameras

Holds a list of all vehicle Cameras.

cpProbe?: string

The cp probe

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.5",
"method": "UPDATE",
"payload": {
"devices": {
"05EAEF956867": {
"model": 13,
"cpuTemp": 14
}
}
}
}
cygnus?: cygnusType

The ut(cygnus) probe

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.5",
"method": "SET",
"payload": {
"devices": {
"484FF65BDDF4": {
"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.5",
"method": "SET",
"payload": {
"devices": {
"A19C9EE34634": {
"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.5",
"method": "SET",
"payload": {
"devices": {
"83F71AD442A8": {
"model": 18,
"depth": 11
}
}
}
}

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

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.5",
"method": "SET",
"payload": {
"devices": {
"98B31A4F0B08": {
"model": 13,
"depth": 83
}
}
}
}
readonly
directPowerKitPresent?: boolean

Direct Power Kit Present Flag

readonly
drive?: RovDrive

Rov Drive object

Commands thrust actions for the ROV and sets drive modes

See RovDrive for more details.

Example Payloads

SET Requests

  • Random drive request

    From ./dist/samples/json/requests/devices/vehicles/pivot/drive/pivotDriveRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "SET",
    "payload": {
    "devices": {
    "F805886D6FBA": {
    "model": 18,
    "drive": {
    "thrust": {
    "forward": 60,
    "yaw": -98,
    "vertical": -99,
    "lateral": 98
    },
    "modes": {
    "headingLock": false,
    "altitudeLock": false,
    "depthLock": true,
    "autoStabilization": false,
    "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.5",
    "method": "SET",
    "payload": {
    "devices": {
    "A66AA0F506A7": {
    "model": 13,
    "drive": {
    "thrust": {
    "forward": 95,
    "yaw": -76,
    "vertical": 17,
    "lateral": 62
    },
    "modes": {
    "headingLock": true,
    "altitudeLock": true,
    "depthLock": false,
    "autoStabilization": false,
    "motorsDisabled": true
    }
    }
    }
    }
    }
    }
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.5",
"method": "UPDATE",
"payload": {
"devices": {
"BEC0A5C47F8A": {
"model": 13,
"frontLeftMotorDiagnostics": {
"current": 42,
"overcurrent": false,
"pwm": 73,
"rpm": 83,
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"E6FF24A45E9A": {
"model": 13,
"frontLeftMotorDiagnostics": {
"current": 1,
"overcurrent": false,
"pwm": 5,
"rpm": -1,
"failure": false
}
}
}
}
}
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.5",
"method": "UPDATE",
"payload": {
"devices": {
"173FDAD35B0F": {
"model": 13,
"frontRightMotorDiagnostics": {
"current": 74,
"overcurrent": true,
"pwm": 99,
"rpm": 15,
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"16B7F3459584": {
"model": 13,
"frontRightMotorDiagnostics": {
"current": 10,
"overcurrent": false,
"pwm": 1,
"rpm": 1,
"failure": false
}
}
}
}
}
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.5",
"method": "UPDATE",
"payload": {
"devices": {
"D22B1325C4C3": {
"model": 13,
"grabber": {
"rotate": -40,
"openClose": -55
}
}
}
}
}
  • 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.5",
"method": "UPDATE",
"payload": {
"devices": {
"26801083E903": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"9021F8441865": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"936067EAA327": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"C274277B0E03": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"2F4263C7C4A4": {
"model": 13,
"grabber": {
"rotate": 100
}
}
}
}
}
heading?: number

Rov heading

Measured in degrees from north bearing

minimum

0

maximum

360

readonly
inWater?: boolean

Rov in water status

readonly

Example Payloads

UPDATE Requests

  • Pivot in water

    From ./dist/samples/json/requests/devices/vehicles/pivot/inWater/pivotInWaterSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8B978268FEEF": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "ED2CA1CC3473": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8B0F673D85DF": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "962D5B1C886B": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "69B34F4D83DB": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F6E62739D0CA": {
    "model": 13,
    "inWater": true
    }
    }
    }
    }
ip?: string
  • Arbitrary

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "SET",
    "payload": {
    "devices": {
    "2F604198983A": {
    "model": 13,
    "ip": "192.168.240.34"
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "SET",
    "payload": {
    "devices": {
    "03A84BD05873": {
    "model": 18,
    "ip": "192.168.176.92"
    }
    }
    }
    }
readonly
leftBattery?: Battery

Left Battery

Example Payloads

UPDATE Requests

  • All arbitrary values

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

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.5",
"method": "UPDATE",
"payload": {
"devices": {
"D579241CAC61": {
"model": 13,
"leftBattery": {
"percent": 39,
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"B1F89F49AF2E": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"F8B0C72D0FEF": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"8448406F9ECE": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"FD67F5A37460": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"2E9B10E7293B": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"39C7499BAF34": {
"model": 13,
"leftBattery": {
"leak": false
}
}
}
}
}
localHeading?: number

Rov local heading

Measure in degrees from local heading

minimum

-360

maximum

360

model: Revolution
navigationOptions?: NavigationOptions

Navigation Options

description

Navigation settings and options for the ROV

pitch?: number

Rov pitch

Measured in degrees from neutral pitch position

minimum

-180.0

maximum

180.0

readonly
position?: Position

ROV Position

description

Contains positional data about the ROV.

Example payloads

UPDATE Requests

  • Invalid position sample

  • Revolution

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0B7CA34CF95B": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CEBD311B4D01": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6FE52C9CDA20": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1BDB4FE5EE32": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "873530E699D2": {
    "model": 13,
    "position": {
    "local": {
    "x": -53,
    "y": 772,
    "uncertainty": 95
    }
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "07B3ED38EADD": {
    "model": 13,
    "position": {
    "global": {
    "latitude": -3,
    "longitude": -114,
    "uncertainty": 61
    }
    }
    }
    }
    }
    }
  • 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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5437CDB3470D": {
    "model": 18,
    "position": {
    "local": {
    "x": 624,
    "y": -172,
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F9D27C4267E7": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -78,
    "longitude": 36,
    "uncertainty": 70
    }
    }
    }
    }
    }
    }

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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1A96A5F43D5E": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "5437CDB3470D": {
    "model": 18,
    "position": {
    "local": {
    "x": 624,
    "y": -172,
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "34D412CA5A07": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F9D27C4267E7": {
    "model": 18,
    "position": {
    "global": {
    "latitude": -78,
    "longitude": 36,
    "uncertainty": 70
    }
    }
    }
    }
    }
    }
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.5",
"method": "UPDATE",
"payload": {
"devices": {
"B4D0CEA2BC24": {
"model": 13,
"rearLeftMotorDiagnostics": {
"current": 32,
"overcurrent": true,
"pwm": 33,
"rpm": -1,
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"1A6A29C86F22": {
"model": 13,
"rearLeftMotorDiagnostics": {
"current": 2,
"overcurrent": false,
"pwm": 1,
"rpm": 0,
"failure": false
}
}
}
}
}
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.5",
"method": "UPDATE",
"payload": {
"devices": {
"6B5D032E481A": {
"model": 13,
"rearRightMotorDiagnostics": {
"current": 89,
"overcurrent": false,
"pwm": 75,
"rpm": -60,
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"6616D4A87324": {
"model": 13,
"rearRightMotorDiagnostics": {
"current": 2,
"overcurrent": false,
"pwm": 5,
"rpm": 0,
"failure": false
}
}
}
}
}
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.5",
"method": "UPDATE",
"payload": {
"devices": {
"5B32C7C842C9": {
"model": 13,
"rightBattery": {
"percent": 83,
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"EBB7D89BBF5B": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"2F5F887E5D59": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"876BE0B210C3": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"EB58C4B7B3C3": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"AF2860419D2F": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"BFFED8BF8214": {
"model": 13,
"rightBattery": {
"leak": false
}
}
}
}
}
roll?: number

Rov roll

Measured in degrees from neutral roll position

minimum

-180.0

maximum

180.0

readonly

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

sensorPodLeak?: boolean

Sensor Pod Leak Fault

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

spareMotor1?: MotorDiagnostics

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

Example Payloads

UPDATE Requests

  • Resting spare motor 1 diagnostics sample

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "04D7A8A41A9D": {
    "model": 13,
    "spareMotor1": {
    "current": 94,
    "overcurrent": false,
    "pwm": 75,
    "rpm": 56,
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8F4DE26A9A46": {
    "model": 13,
    "spareMotor1": {
    "current": 11,
    "overcurrent": true,
    "pwm": 49,
    "rpm": -69,
    "failure": false
    }
    }
    }
    }
    }
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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "087250969AA0": {
    "model": 13,
    "spareMotor2": {
    "current": 28,
    "overcurrent": false,
    "pwm": 72,
    "rpm": -87,
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "AB6FB9250327": {
    "model": 13,
    "spareMotor2": {
    "current": 90,
    "overcurrent": false,
    "pwm": 58,
    "rpm": -44,
    "failure": false
    }
    }
    }
    }
    }
turns?: number

Turns

Count the number of turns the rov has completed

readonly
usageTime?: UsageTime

Vehicle Usage Time

Example Payloads

GET Requests

  • Total and current usage times

    From ./dist/samples/json/requests/devices/vehicles/pivot/usageTime/pivotUsageTimeSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F951085EC88F": {
    "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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "AE8EA9E86185": {
    "model": 18,
    "usageTime": {
    "totalSeconds": 86,
    "currentSeconds": 25
    }
    }
    }
    }
    }

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "57D12333CD71": {
    "model": 13,
    "usageTime": {
    "totalSeconds": 87,
    "currentSeconds": 47
    }
    }
    }
    }
    }
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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "63BADBD30D9F": {
    "model": 13,
    "velocity": {
    "valid": false,
    "forward": -22,
    "rightward": -30,
    "downward": 81,
    "speed": 77
    }
    }
    }
    }
    }
  • 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.5",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "C543A2FEA06D": {
    "model": 18,
    "velocity": {
    "valid": false,
    "forward": 66,
    "rightward": 86,
    "downward": -55,
    "speed": 51
    }
    }
    }
    }
    }
version?: DeviceVersion

ROV Version

readonly
verticalLeftMotorDiagnostics?: MotorDiagnostics

Vertical Left Motor Diagnostics

remarks

See MotorDiagnostics type for more details

Example Payloads

UPDATE Requests

  • All arbitrary values

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

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.5",
"method": "UPDATE",
"payload": {
"devices": {
"29F8BB662F20": {
"model": 13,
"verticalLeftMotorDiagnostics": {
"current": 31,
"overcurrent": false,
"pwm": 97,
"rpm": 37,
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"9F6A6D8F9A92": {
"model": 13,
"verticalLeftMotorDiagnostics": {
"current": 4,
"overcurrent": false,
"pwm": 5,
"rpm": 0,
"failure": false
}
}
}
}
}
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.5",
"method": "UPDATE",
"payload": {
"devices": {
"7560406B2B06": {
"model": 13,
"verticalRightMotorDiagnostics": {
"current": 51,
"overcurrent": true,
"pwm": 48,
"rpm": -22,
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"F40B0C32297B": {
"model": 13,
"verticalRightMotorDiagnostics": {
"current": 3,
"overcurrent": false,
"pwm": 5,
"rpm": 0,
"failure": false
}
}
}
}
}
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.5",
"method": "UPDATE",
"payload": {
"devices": {
"6535D99ADE54": {
"model": 13,
"waterTemp": 15
}
}
}
}
  • 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.5",
"method": "UPDATE",
"payload": {
"devices": {
"0384425BDF61": {
"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.5",
"method": "UPDATE",
"payload": {
"devices": {
"570F94B3B4D5": {
"model": 13,
"waterTemp": -10
}
}
}
}