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.58.14",
    "method": "DELETE",
    "payload": {
        "devices": {
            "76981B0A3554": {
                "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.58.14",
        "method": "SET",
        "payload": {
            "devices": {
                "0A8B23C18BC0": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "9263892AD350": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "52B89B714CCB": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "A0936CB34ABA": {
                    "model": 19,
                    "auxLight": {
                        "intensity": 4
                    }
                }
            }
        }
    }

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.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "09D654D8EEA7": {
                "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D5478915E7D9": {
                "model": 19,
                "battery": {
                    "voltage": 4,
                    "percent": 63,
                    "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.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "099BA210766D": {
                "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "312D1177FAB8": {
                "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.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "ACF5A40AAB55": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "F0837DEA29C4": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "421E0D7B057B": {
                    "model": 19,
                    "bodyLeak": true
                }
            }
        }
    }

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.58.14",
        "method": "DELETE",
        "payload": {
            "devices": {
                "738DD00983A9": {
                    "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.58.14",
    "method": "DELETE",
    "payload": {
        "devices": {
            "F3FC14573F56": {
                "model": 19,
                "cameras": {
                    "E9F3CDD16A82": {}
                }
            }
        }
    }
}

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.14",
    "method": "DELETE",
    "payload": {
        "devices": {
            "83D5AE2DAFDA": {
                "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.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "199AC7C5F229": {
                "model": 19,
                "cpuTemp": 73
            }
        }
    }
}
  • 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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "5F20FB9B5F92": {
                "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F0926A6AB20B": {
                "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.58.14",
        "method": "SET",
        "payload": {
            "devices": {
                "EAA6F133FE61": {
                    "model": 19,
                    "drive": {
                        "driveMode": "NORMAL",
                        "speed": -7,
                        "steer": 13,
                        "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.58.14",
        "method": "SET",
        "payload": {
            "devices": {
                "90A9FE918087": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "F25FA2FBA6F5": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "9AC48B529FEB": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "964F8C4E1789": {
                    "model": 19,
                    "drive": {
                        "speed": -53
                    }
                }
            }
        }
    }

  • 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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "1FC24A801FB0": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "538D1BF52175": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "484FAE2DB320": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "0338AA7E1E17": {
                    "model": 19,
                    "drive": {
                        "steer": -30
                    }
                }
            }
        }
    }

  • 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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "19C81FE657CC": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "18405CC32C57": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "A5861CCD3756": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "138051AD4D99": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "AC3A20894A7C": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "466514F0AD19": {
                    "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.58.14",
    "method": "SET",
    "payload": {
        "devices": {
            "58DA212F8528": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "F117D55B8AB7": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "EC81E95DA05C": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "F06941C5646C": {
                "model": 19,
                "elevatingArm": {
                    "present": true,
                    "height": -9,
                    "speed": -30,
                    "leak": true
                }
            }
        }
    }
}

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

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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6DBBD9FC542A": {
                "model": 19,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 38
                }
            }
        }
    }
}

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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "37238FD67515": {
                "model": 19,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 63
                }
            },
            "9E1EC81DD6C8": {
                "model": 19,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 9
                }
            }
        }
    }
}

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.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "8A404DCD2AE5": {
                    "model": 19,
                    "imuTemp": 100
                }
            }
        }
    }

  • 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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "60330E4616A8": {
                    "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.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "E7D26B1561DC": {
                    "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.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4842F315EB9B": {
                "model": 19,
                "leftMotorDiagnostics": {
                    "current": 1,
                    "overcurrent": false,
                    "pwm": 3,
                    "rpm": 0,
                    "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FC1FE0B08ED4": {
                "model": 19,
                "leftMotorDiagnostics": {
                    "current": 74,
                    "overcurrent": false,
                    "pwm": 74,
                    "rpm": 60,
                    "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.58.14",
        "method": "SET",
        "payload": {
            "devices": {
                "01D0C5F6E7F2": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "55C6528C1ED6": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "E4C3B4C58031": {
                    "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.14",
        "method": "SET",
        "payload": {
            "devices": {
                "228C2E218271": {
                    "model": 19,
                    "rearLight": {
                        "intensity": 7
                    }
                }
            }
        }
    }

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.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F4FCB29FE4D0": {
                "model": 19,
                "rightMotorDiagnostics": {
                    "current": 5,
                    "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.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7386909F7AC1": {
                "model": 19,
                "rightMotorDiagnostics": {
                    "current": 87,
                    "overcurrent": false,
                    "pwm": 65,
                    "rpm": -53,
                    "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.58.14",
    "method": "SET",
    "payload": {
        "devices": {
            "A0BDF0564C53": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "3A90693CF5B5": {
                "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.58.14",
        "method": "UPDATE",
        "payload": {
            "devices": {
                "4AB4741BC7B1": {
                    "model": 19,
                    "usageTime": {
                        "currentSeconds": 58
                    }
                }
            }
        }
    }
  • 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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FC025387C790": {
                "model": 19,
                "usageTime": {
                    "totalSeconds": 96
                }
            }
        }
    }
}
  • 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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "EB80C1ADE374": {
                "model": 19,
                "usageTime": {
                    "totalSeconds": 3,
                    "currentSeconds": 53
                }
            }
        }
    }
}

Optional version

version?: DeviceVersion

Version