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.60.2",
"method": "DELETE",
"payload": {
"devices": {
"C40EDCD4D40F": {
"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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "11502F388586": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "F167DD47D900": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "B1510078EEB8": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "474C3E07169A": {
    "model": 19,
    "auxLight": {
    "intensity": 7
    }
    }
    }
    }
    }
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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"C24FDD2A8782": {
"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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"3AE39EDF8822": {
"model": 19,
"battery": {
"voltage": 31,
"percent": 8,
"charging": false
}
}
}
}
}

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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"BCF97384AB2C": {
"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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"84F6C01AAF27": {
"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.60.2",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "22D6DEBCE726": {
    "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.60.2",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6739CDA93712": {
    "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.60.2",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "87C0E8F178DA": {
    "model": 19,
    "bodyLeak": false
    }
    }
    }
    }
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.60.2",
    "method": "DELETE",
    "payload": {
    "devices": {
    "92B4C8C1B7BE": {
    "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.60.2",
"method": "DELETE",
"payload": {
"devices": {
"F8F4770B5BA3": {
"model": 19,
"cameras": {
"40071E2E3294": {}
}
}
}
}
}

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

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.60.2",
"method": "DELETE",
"payload": {
"devices": {
"8B8D373D557B": {
"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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"DA21C1CA74EF": {
"model": 19,
"cpuTemp": 32
}
}
}
}
  • 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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"FDE662589FEC": {
"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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"BBDF499599EA": {
"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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "17DD98282C76": {
    "model": 19,
    "drive": {
    "driveMode": "NORMAL",
    "speed": -38,
    "steer": 28,
    "motorsDisabled": false,
    "calibrator": false
    }
    }
    }
    }
    }
  • 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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "83A2E41C9672": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "FD57A63C122B": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "15D1662DF638": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "9A608EB8E24C": {
    "model": 19,
    "drive": {
    "speed": -92
    }
    }
    }
    }
    }
  • 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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "D19C979155AB": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "A807EEB48CF4": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "FD484F303182": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "4750381939F6": {
    "model": 19,
    "drive": {
    "steer": -5
    }
    }
    }
    }
    }
  • 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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "626CEF09EF7A": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "11686DF02092": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "34E3F6ED38C2": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "64203F4DF2F0": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "DABE4962E68B": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "C468ECE0E5AF": {
    "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.60.2",
"method": "SET",
"payload": {
"devices": {
"B4A716C6BC36": {
"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.60.2",
"method": "SET",
"payload": {
"devices": {
"B087CBDD0ECC": {
"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.60.2",
"method": "SET",
"payload": {
"devices": {
"4A9BACCFA31A": {
"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.60.2",
"method": "SET",
"payload": {
"devices": {
"D4D612521CEC": {
"model": 19,
"elevatingArm": {
"present": true,
"height": -81,
"speed": 88,
"leak": true
}
}
}
}
}
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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"E4A63454E8C7": {
"model": 19,
"hybridPowerDiagnostics": {
"chargeVoltage": 13
}
}
}
}
}

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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"B5A1B422C5B3": {
"model": 19,
"hybridPowerDiagnostics": {
"chargeVoltage": 13
}
}
}
}
}

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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"D2CAAF849031": {
"model": 19,
"hybridPowerDiagnostics": {
"chargeVoltage": 38
}
},
"5945F8E0E996": {
"model": 19,
"hybridPowerDiagnostics": {
"chargeVoltage": 23
}
}
}
}
}
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.60.2",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4011165C4A9B": {
    "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.60.2",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "0B43E42EC505": {
    "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.60.2",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "EFCFFD67C8AD": {
    "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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"2AD300EBB572": {
"model": 19,
"leftMotorDiagnostics": {
"current": 0,
"overcurrent": false,
"pwm": 5,
"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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"015C0EEF0F0F": {
"model": 19,
"leftMotorDiagnostics": {
"current": 1,
"overcurrent": true,
"pwm": 39,
"rpm": -81,
"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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "EA851CA11AFD": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "95E7F305486F": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "F4A4721AD486": {
    "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.60.2",
    "method": "SET",
    "payload": {
    "devices": {
    "B20057F9F576": {
    "model": 19,
    "rearLight": {
    "intensity": 15
    }
    }
    }
    }
    }
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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"0BEB23133DD1": {
"model": 19,
"rightMotorDiagnostics": {
"current": 3,
"overcurrent": false,
"pwm": 2,
"rpm": -1,
"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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"98E10D98728E": {
"model": 19,
"rightMotorDiagnostics": {
"current": 96,
"overcurrent": false,
"pwm": 71,
"rpm": -83,
"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.60.2",
"method": "SET",
"payload": {
"devices": {
"32888B55852B": {
"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.60.2",
"method": "SET",
"payload": {
"devices": {
"268755C96F18": {
"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.60.2",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3087FC9636F4": {
    "model": 19,
    "usageTime": {
    "currentSeconds": 8
    }
    }
    }
    }
    }
  • 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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"BB55949310F6": {
"model": 19,
"usageTime": {
"totalSeconds": 69
}
}
}
}
}
  • 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.60.2",
"method": "UPDATE",
"payload": {
"devices": {
"66440A55572A": {
"model": 19,
"usageTime": {
"totalSeconds": 14,
"currentSeconds": 20
}
}
}
}
}
version?: DeviceVersion

Version