Options
All
  • Public
  • Public/Protected
  • All
Menu
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.58.15",
"method": "DELETE",
"payload": {
"devices": {
"413C919746BC": {
"model": 19
}
}
}
}

Hierarchy

Index

Properties

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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "861EC4852112": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "E52B22F87DCA": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "B6D5E931F978": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "1D02861309F1": {
    "model": 19,
    "auxLight": {
    "intensity": 19
    }
    }
    }
    }
    }
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"D3EC0E522AD6": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"0C5C98666B3E": {
"model": 19,
"battery": {
"voltage": 90,
"percent": 14,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"EE9C547CCB89": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"CF90339FE503": {
"model": 19,
"battery": {
"percent": 30
}
}
}
}
}
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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "472DF3B24473": {
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9E2E5EB940FB": {
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "60702F2C55A0": {
    "model": 19,
    "bodyLeak": true
    }
    }
    }
    }
calibrator?: boolean

Calibrator

Calibrator Front-end (request) Back-end (response)
true Calibrate -
false Cancel Calibration -
undefined - -
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.58.15",
    "method": "DELETE",
    "payload": {
    "devices": {
    "7179ACCC00AA": {
    "model": 19,
    "cameraHead": {}
    }
    }
    }
    }
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.58.15",
"method": "DELETE",
"payload": {
"devices": {
"F47ECEEE61A5": {
"model": 19,
"cameras": {
"6637120686B6": {}
}
}
}
}
}

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

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "DELETE",
"payload": {
"devices": {
"FA1D8D9719C8": {
"model": 19,
"cameras": {}
}
}
}
}
cpProbe?: string

The cp probe

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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"D5ABA7B1CC37": {
"model": 19,
"cpuTemp": 13
}
}
}
}
  • 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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"58A7026321FB": {
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"B8682E1AF131": {
"model": 19,
"cpuTemp": 85
}
}
}
}
cygnus?: cygnusType

The ut(cygnus) probe

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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "928048A01A31": {
    "model": 19,
    "drive": {
    "driveMode": "NORMAL",
    "speed": -51,
    "steer": 74,
    "motorsDisabled": true,
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "4CE4AFBC7FC5": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "8B780EFC23D0": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "DE42B0A621B2": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "F7F33CF65D49": {
    "model": 19,
    "drive": {
    "speed": -59
    }
    }
    }
    }
    }
  • 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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "DF12ED68E285": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "199EC87C05BF": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "F53268D57554": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "D3EFF05269F4": {
    "model": 19,
    "drive": {
    "steer": -23
    }
    }
    }
    }
    }
  • 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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "BAB032A7D6F4": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "FB5B4979DC83": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "2DAAE597CB75": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "A3319FB54647": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "DD4CB5296737": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "18A64E5DD370": {
    "model": 19,
    "drive": {
    "calibrator": true
    }
    }
    }
    }
    }
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.58.15",
"method": "SET",
"payload": {
"devices": {
"FD6215F0E29A": {
"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.58.15",
"method": "SET",
"payload": {
"devices": {
"E1DB1778ECE7": {
"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.58.15",
"method": "SET",
"payload": {
"devices": {
"FBAA5C58F31A": {
"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.58.15",
"method": "SET",
"payload": {
"devices": {
"357BBD035499": {
"model": 19,
"elevatingArm": {
"present": true,
"height": -71,
"speed": -89,
"leak": false
}
}
}
}
}
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"B12CCAAC9771": {
"model": 19,
"hybridPowerDiagnostics": {
"chargeVoltage": 51
}
}
}
}
}

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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"7C6A67ACEF98": {
"model": 19,
"hybridPowerDiagnostics": {
"chargeVoltage": 8
}
}
}
}
}

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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"01B920FEC14B": {
"model": 19,
"hybridPowerDiagnostics": {
"chargeVoltage": 79
}
},
"93C1902E1B6A": {
"model": 19,
"hybridPowerDiagnostics": {
"chargeVoltage": 15
}
}
}
}
}
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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CA2448FF51C4": {
    "model": 19,
    "imuTemp": 12
    }
    }
    }
    }
  • 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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "363372CFBE91": {
    "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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8334C4037D13": {
    "model": 19,
    "imuTemp": 85
    }
    }
    }
    }
incline?: number

Vehicle incline

minimum

-180.0

maximum

180.0

ip?: string

IP address

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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"E309761DD442": {
"model": 19,
"leftMotorDiagnostics": {
"current": 7,
"overcurrent": false,
"pwm": 2,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"291BC885EE96": {
"model": 19,
"leftMotorDiagnostics": {
"current": 42,
"overcurrent": true,
"pwm": 25,
"rpm": 54,
"failure": false
}
}
}
}
}
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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "9E7A276E41B5": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "35EE001381B3": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "E34A3B4CB93C": {
    "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.58.15",
    "method": "SET",
    "payload": {
    "devices": {
    "423E284A559A": {
    "model": 19,
    "rearLight": {
    "intensity": 85
    }
    }
    }
    }
    }
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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"8957D0645A91": {
"model": 19,
"rightMotorDiagnostics": {
"current": 0,
"overcurrent": false,
"pwm": 0,
"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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"E005B8D69968": {
"model": 19,
"rightMotorDiagnostics": {
"current": 12,
"overcurrent": false,
"pwm": 63,
"rpm": -54,
"failure": false
}
}
}
}
}
roll?: number

Vehicle roll

minimum

-180.0

maximum

180.0

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.58.15",
"method": "SET",
"payload": {
"devices": {
"22741BF4C841": {
"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.58.15",
"method": "SET",
"payload": {
"devices": {
"CF4B37D5FA73": {
"model": 19,
"sonde": {
"enabled": false
}
}
}
}
}
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.58.15",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D8AB6738358D": {
    "model": 19,
    "usageTime": {
    "currentSeconds": 88
    }
    }
    }
    }
    }
  • 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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"B2FCCC1B701F": {
"model": 19,
"usageTime": {
"totalSeconds": 26
}
}
}
}
}
  • 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.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"86DB6EE34F9C": {
"model": 19,
"usageTime": {
"totalSeconds": 48,
"currentSeconds": 99
}
}
}
}
}
version?: DeviceVersion

Version