Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IA200

notexported

See type declaration

A200 Crawler

DELETE Request

From ./dist/samples/json/requests/devices/vehicles/a200/core/a200DeleteSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "DELETE",
    "payload": {
        "devices": {
            "F2531E454D6D": {
                "model": 19
            }
        }
    }
}

Hierarchy

Index

Properties

Properties

Optional auxLight

auxLight?: Light

Aux Light

Controls the auxiliary light attached to the a200 crawler.

remarks

See Light type for more details.

Example Payloads

SET Requests

  • Lights On (mid)

    From ./dist/samples/json/requests/devices/vehicles/a200/auxLight/a200AuxLightOnMidIntensitySample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "4AA111E8A379": {
                    "model": 19,
                    "auxLight": {
                        "intensity": 50
                    }
                }
            }
        }
    }

  • Lights Off

    From ./dist/samples/json/requests/devices/vehicles/a200/auxLight/a200AuxLightOffSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "1B4A533F37EF": {
                    "model": 19,
                    "auxLight": {
                        "intensity": 0
                    }
                }
            }
        }
    }

  • Lights On (max)

    From ./dist/samples/json/requests/devices/vehicles/a200/auxLight/a200AuxLightOnMaxIntensitySample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "3667A43B193E": {
                    "model": 19,
                    "auxLight": {
                        "intensity": 100
                    }
                }
            }
        }
    }

  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/a200/auxLight/a200AuxLightRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "0158419CF025": {
                    "model": 19,
                    "auxLight": {
                        "intensity": 74
                    }
                }
            }
        }
    }

Optional battery

battery?: Battery

Main Crawler Battery

Example Payload

Battery Danger Sample

From ./dist/samples/json/requests/devices/vehicles/a200/battery/a200BatteryDangerSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "EE9FD5CBF108": {
                "model": 19,
                "battery": {
                    "percent": 15
                }
            }
        }
    }
}

Battery Random Sample

From ./dist/samples/json/requests/devices/vehicles/a200/battery/a200BatteryRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "22C75B7A1694": {
                "model": 19,
                "battery": {
                    "voltage": 42,
                    "percent": 90,
                    "charging": true
                }
            }
        }
    }
}

Battery Shutdown Sample

From ./dist/samples/json/requests/devices/vehicles/a200/battery/a200BatteryShutdownSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0CB7E6FCF1B6": {
                "model": 19,
                "battery": {
                    "percent": 3
                }
            }
        }
    }
}

Battery Warning Sample

From ./dist/samples/json/requests/devices/vehicles/a200/battery/a200BatteryWarningSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "67FFC29843B2": {
                "model": 19,
                "battery": {
                    "percent": 30
                }
            }
        }
    }
}

Optional bodyLeak

bodyLeak?: boolean

Body Leak Fault

Example Payloads

UPDATE Requests

  • No body leak

    From ./dist/samples/json/requests/devices/vehicles/a200/bodyLeak/a200HasNoBodyLeakSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "287D22FA65A9": {
                    "model": 19,
                    "bodyLeak": false
                }
            }
        }
    }

  • Body leak present

    From ./dist/samples/json/requests/devices/vehicles/a200/bodyLeak/a200HasBodyLeakSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "38B81B28480A": {
                    "model": 19,
                    "bodyLeak": true
                }
            }
        }
    }

  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/a200/bodyLeak/a200BodyLeakRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "EF948D2BEE1A": {
                    "model": 19,
                    "bodyLeak": false
                }
            }
        }
    }

Optional calibrator

calibrator?: boolean

Calibrator

Calibrator Front-end (request) Back-end (response)
true Calibrate -
false Cancel Calibration -
undefined - -

Optional cameraHead

cameraHead?: Record<string, never> | A200CameraHead | A150CameraHead

Camera Head

Example Payloads

GET Requests
  • A200 camera head

    From ./dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/core/a200A200CameraHeadSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "DELETE",
        "payload": {
            "devices": {
                "C2E753C6111B": {
                    "model": 19,
                    "cameraHead": {}
                }
            }
        }
    }

Optional cameras

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

Cameras

Example Payloads

DELETE Requests

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/core/a200CameraDeleteSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "DELETE",
    "payload": {
        "devices": {
            "1340AEE48A28": {
                "model": 19,
                "cameras": {
                    "7F88DB05B1FA": {}
                }
            }
        }
    }
}

From ./dist/samples/json/requests/devices/vehicles/a200/cameras/core/a200CamerasSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "DELETE",
    "payload": {
        "devices": {
            "667D26887F2C": {
                "model": 19,
                "cameras": {}
            }
        }
    }
}

Optional cpProbe

cpProbe?: string

The cp probe

Optional cpuTemp

cpuTemp?: number

CPU Temperature Sensor

Measured in degrees celsius

  • Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a200/temperature/cpuTemp/a200CPUTemperatureRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "17E1BE3B4847": {
                "model": 19,
                "cpuTemp": 21
            }
        }
    }
}
  • CPU temperature warning

From ./dist/samples/json/requests/devices/vehicles/a200/temperature/cpuTemp/a200CPUTemperatureWarningSample.json

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

From ./dist/samples/json/requests/devices/vehicles/a200/temperature/cpuTemp/a200CPUTemperatureShutdownSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "068C38F6771E": {
                "model": 19,
                "cpuTemp": 85
            }
        }
    }
}

Optional cygnus

cygnus?: cygnusType

The ut(cygnus) probe

Optional drive

drive?: CrawlerDrive

Drive

Controls the direction of drive for the A200

remarks

See CrawlerDrive type for more details

Example Payloads

SET Requests

  • Arbitrary Values

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "E2DA025AC0D6": {
                    "model": 19,
                    "drive": {
                        "driveMode": "NORMAL",
                        "speed": 11,
                        "steer": -80,
                        "motorsDisabled": false,
                        "calibrator": true
                    }
                }
            }
        }
    }

  • Drive mode: Normal

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveModeNormalSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "B4A79E867444": {
                    "model": 19,
                    "drive": {
                        "driveMode": "NORMAL"
                    }
                }
            }
        }
    }

  • Drive mode: Assist

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveModeAssistSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "D8BBC4048CC2": {
                    "model": 19,
                    "drive": {
                        "driveMode": "RETRIEVAL_ASSIST"
                    }
                }
            }
        }
    }

  • Drive mode: Cruise

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveModeCruiseSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "0DC215D7B8E4": {
                    "model": 19,
                    "drive": {
                        "driveMode": "RETRIEVAL_CRUISE"
                    }
                }
            }
        }
    }

  • Random Speed

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveSpeedRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "62E557E15957": {
                    "model": 19,
                    "drive": {
                        "speed": 81
                    }
                }
            }
        }
    }

  • Max Speed Forward Speed

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveMaxSpeedForwardSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "2570B2992079": {
                    "model": 19,
                    "drive": {
                        "speed": 100
                    }
                }
            }
        }
    }

  • Max Speed Backward Speed

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveMaxSpeedBackwardSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "613FD2DDCC6F": {
                    "model": 19,
                    "drive": {
                        "speed": -100
                    }
                }
            }
        }
    }

  • No Speed

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveNoSpeedSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "107E41324FA2": {
                    "model": 19,
                    "drive": {
                        "speed": 0
                    }
                }
            }
        }
    }

  • Random Steer

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveSteerRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "863170C13FE7": {
                    "model": 19,
                    "drive": {
                        "steer": 88
                    }
                }
            }
        }
    }

  • Steer Left

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveSteerLeftSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "5CD8773D4B5B": {
                    "model": 19,
                    "drive": {
                        "steer": -100
                    }
                }
            }
        }
    }

  • Steer Right

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveSteerRightSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "6D3C73684983": {
                    "model": 19,
                    "drive": {
                        "steer": 100
                    }
                }
            }
        }
    }

  • No Steer

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200DriveNoSteerSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "920AC68A59E0": {
                    "model": 19,
                    "drive": {
                        "steer": 0
                    }
                }
            }
        }
    }

  • Motors Disabled

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200MotorsDisabledSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "836A5CD330A8": {
                    "model": 19,
                    "drive": {
                        "motorsDisabled": true
                    }
                }
            }
        }
    }

  • Motors Enabled

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200MotorsEnabledSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "5C7E2BBF7FB8": {
                    "model": 19,
                    "drive": {
                        "motorsDisabled": false
                    }
                }
            }
        }
    }

  • Active Freewheel Calibration

    From ./dist/samples/json/requests/devices/vehicles/a200/drive/a200AFWCalibrationSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "BBA46A4D0086": {
                    "model": 19,
                    "drive": {
                        "calibrator": true
                    }
                }
            }
        }
    }

Optional elevatingArm

elevatingArm?: ElevatingArm

Elevating Arm

No elevating arm

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmNotPresentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "6CA99DA9CCA5": {
                "model": 19,
                "elevatingArm": {
                    "present": false
                }
            }
        }
    }
}

Elevating arm minimum height

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmMinHeightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "F93519C1EFEE": {
                "model": 19,
                "elevatingArm": {
                    "height": 0
                }
            }
        }
    }
}

Elevating arm maximum height

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmMaxHeightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "E4508FD734AF": {
                "model": 19,
                "elevatingArm": {
                    "height": 100
                }
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "03424A8309F3": {
                "model": 19,
                "elevatingArm": {
                    "present": true,
                    "height": 78,
                    "speed": 14,
                    "leak": false
                }
            }
        }
    }
}

Optional hybridPowerDiagnostics

hybridPowerDiagnostics?: VehicleHpDiagnostics

Hybrid Power Diagnostics

Hybrid Power Diagnostics Charge Input Random Sample

From ./dist/samples/json/requests/devices/vehicles/a200/hybridPowerDiagnostics/chargeVoltage/a200HybridPowerDiagnosticsChargeVoltageRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2B394485BF59": {
                "model": 19,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 34
                }
            }
        }
    }
}

Hybrid Power Diagnostics Input Voltage Random Sample

From ./dist/samples/json/requests/devices/vehicles/a200/hybridPowerDiagnostics/inputVoltage/a200HybridPowerDiagnosticsInputVoltageRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "EBA5C7CC5AA0": {
                "model": 19,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 95
                }
            }
        }
    }
}

Hybrid Power Diagnostics Random Sample

From ./dist/samples/json/requests/devices/vehicles/a200/hybridPowerDiagnostics/a200HybridPowerDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9F9A84BCE508": {
                "model": 19,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 2
                }
            },
            "A6624DDBAA54": {
                "model": 19,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 64
                }
            }
        }
    }
}

Optional imuTemp

imuTemp?: number

IMU Temperature Sensor

Measured in degrees celsius

  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/a200/temperature/imuTemp/a200IMUTemperatureRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "1702477D48F6": {
                    "model": 19,
                    "imuTemp": 45
                }
            }
        }
    }

  • IMU temperature warning

    From ./dist/samples/json/requests/devices/vehicles/a200/temperature/imuTemp/a200IMUTemperatureWarningSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "ABC614A38B23": {
                    "model": 19,
                    "imuTemp": 75
                }
            }
        }
    }

  • IMU temperature shutdown

    From ./dist/samples/json/requests/devices/vehicles/a200/temperature/imuTemp/a200IMUTemperatureShutdownSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4FB5F3A2621C": {
                    "model": 19,
                    "imuTemp": 85
                }
            }
        }
    }

Optional incline

incline?: number

Vehicle incline

minimum

-180.0

maximum

180.0

Optional ip

ip?: string

IP address

Optional leftMotorDiagnostics

leftMotorDiagnostics?: MotorDiagnostics

Left Motor Diagnostics

Resting Motor

From ./dist/samples/json/requests/devices/vehicles/a200/motorDiagnostics/leftMotor/a200LeftMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4B013B434CF9": {
                "model": 19,
                "leftMotorDiagnostics": {
                    "current": 0,
                    "overcurrent": false,
                    "pwm": 4,
                    "rpm": 1,
                    "failure": false
                }
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a200/motorDiagnostics/leftMotor/a200LeftMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "83B10DE3A335": {
                "model": 19,
                "leftMotorDiagnostics": {
                    "current": 28,
                    "overcurrent": false,
                    "pwm": 89,
                    "rpm": -36,
                    "failure": false
                }
            }
        }
    }
}

model

model: A200Crawler

Optional rearLight

rearLight?: Light

Rear Light

Controls the rear light attached to the a200 crawler.

remarks

See Light type for more details.

Example Payloads

SET Requests

  • Lights On (mid)

    From ./dist/samples/json/requests/devices/vehicles/a200/rearLight/a200RearLightOnMidIntensitySample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "2579F9AC13A4": {
                    "model": 19,
                    "rearLight": {
                        "intensity": 50
                    }
                }
            }
        }
    }

  • Lights Off

    From ./dist/samples/json/requests/devices/vehicles/a200/rearLight/a200RearLightOffSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "1B89466CF299": {
                    "model": 19,
                    "rearLight": {
                        "intensity": 0
                    }
                }
            }
        }
    }

  • Lights On (max)

    From ./dist/samples/json/requests/devices/vehicles/a200/rearLight/a200RearLightOnMaxIntensitySample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "0CD4332CC116": {
                    "model": 19,
                    "rearLight": {
                        "intensity": 100
                    }
                }
            }
        }
    }

  • Arbitrary

    From ./dist/samples/json/requests/devices/vehicles/a200/rearLight/a200RearLightRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "SET",
        "payload": {
            "devices": {
                "13B55DC9DA68": {
                    "model": 19,
                    "rearLight": {
                        "intensity": 38
                    }
                }
            }
        }
    }

Optional rightMotorDiagnostics

rightMotorDiagnostics?: MotorDiagnostics

Right Motor Diagnostics

Resting Motor

From ./dist/samples/json/requests/devices/vehicles/a200/motorDiagnostics/rightMotor/a200RightMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B1D6B9A288AE": {
                "model": 19,
                "rightMotorDiagnostics": {
                    "current": 8,
                    "overcurrent": false,
                    "pwm": 3,
                    "rpm": 0,
                    "failure": false
                }
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a200/motorDiagnostics/rightMotor/a200RightMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A3E33DE3A085": {
                "model": 19,
                "rightMotorDiagnostics": {
                    "current": 56,
                    "overcurrent": false,
                    "pwm": 72,
                    "rpm": 99,
                    "failure": false
                }
            }
        }
    }
}

Optional roll

roll?: number

Vehicle roll

minimum

-180.0

maximum

180.0

Optional sonde

sonde?: Sonde

Sonde

Example Payloads

SET Request
  • Sonde enabled

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/sonde/a200SondeEnabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "A574C3BA0720": {
                "model": 19,
                "sonde": {
                    "enabled": true
                }
            }
        }
    }
}
  • Sonde Disabled

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/sonde/a200SondeDisabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "1541397E580F": {
                "model": 19,
                "sonde": {
                    "enabled": false
                }
            }
        }
    }
}

Optional usageTime

usageTime?: UsageTime

Vehicle Usage Time

Example Payloads

GET Requests
  • Current seconds

    From ./dist/samples/json/requests/devices/vehicles/a200/usageTime/a200CurrentSecondsRandomSample.json

    {
        "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
        "apiVersion": "0.59.0",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "05549127D066": {
                    "model": 19,
                    "usageTime": {
                        "currentSeconds": 40
                    }
                }
            }
        }
    }
  • Total Seconds

From ./dist/samples/json/requests/devices/vehicles/a200/usageTime/a200TotalSecondsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B77B679AD70C": {
                "model": 19,
                "usageTime": {
                    "totalSeconds": 17
                }
            }
        }
    }
}
  • Arbitrary Total Usage

From ./dist/samples/json/requests/devices/vehicles/a200/usageTime/a200UsageTimeRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7DDC2A231199": {
                "model": 19,
                "usageTime": {
                    "totalSeconds": 35,
                    "currentSeconds": 68
                }
            }
        }
    }
}

Optional version

version?: DeviceVersion

Version