IA150 | Deep Trekker BRIDGE API

notexported

a150 Crawler

DELETE Request

From ./dist/samples/json/requests/devices/vehicles/a150/core/a150DeleteSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "72C2E50E6D1D": {
                "model": 20
            }
        }
    }
}

Hierarchy

A150
- IA150

Properties

Optional auxLight

auxLight?: Light

Aux Light

Controls the auxiliary light attached to the a150 crawler.

remarks

See Light type for more details.

Example Payloads

SET Requests

Lights On (mid)

From ./dist/samples/json/requests/devices/vehicles/a150/auxLight/a150AuxLightOnMidIntensitySample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "7A1C6884A1FD": {
                "model": 20,
                "auxLight": {
                    "intensity": 50
                }
            }
        }
    }
}

Lights Off

From ./dist/samples/json/requests/devices/vehicles/a150/auxLight/a150AuxLightOffSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "99CCF11E1FDB": {
                "model": 20,
                "auxLight": {
                    "intensity": 0
                }
            }
        }
    }
}

Lights On (max)

From ./dist/samples/json/requests/devices/vehicles/a150/auxLight/a150AuxLightOnMaxIntensitySample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "90D79C1AD541": {
                "model": 20,
                "auxLight": {
                    "intensity": 100
                }
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a150/auxLight/a150AuxLightRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "20F2B77DA8A0": {
                "model": 20,
                "auxLight": {
                    "intensity": 95
                }
            }
        }
    }
}

Optional battery

battery?: Battery

Main Crawler Battery

Example Payload

Battery Danger Sample

From ./dist/samples/json/requests/devices/vehicles/a150/battery/a150BatteryDangerSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8CC4AA395FF7": {
                "model": 20,
                "battery": {
                    "percent": 15
                }
            }
        }
    }
}

Battery Random Sample

From ./dist/samples/json/requests/devices/vehicles/a150/battery/a150BatteryRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "AEF41AE16471": {
                "model": 20,
                "battery": {
                    "voltage": 8,
                    "percent": 21,
                    "charging": false
                }
            }
        }
    }
}

Battery Shutdown Sample

From ./dist/samples/json/requests/devices/vehicles/a150/battery/a150BatteryShutdownSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B5172275D915": {
                "model": 20,
                "battery": {
                    "percent": 3
                }
            }
        }
    }
}

Battery Warning Sample

From ./dist/samples/json/requests/devices/vehicles/a150/battery/a150BatteryWarningSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A0590FB9AF4D": {
                "model": 20,
                "battery": {
                    "percent": 30
                }
            }
        }
    }
}

Optional bodyLeak

bodyLeak?: boolean

Body Leak Fault

Example Payloads

UPDATE Requests

No body leak

From ./dist/samples/json/requests/devices/vehicles/a150/bodyLeak/a150HasNoBodyLeakSample.json

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

Body leak present

From ./dist/samples/json/requests/devices/vehicles/a150/bodyLeak/a150HasBodyLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A089B40D6BEF": {
                "model": 20,
                "bodyLeak": true
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a150/bodyLeak/a150BodyLeakRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "872D5A1DB288": {
                "model": 20,
                "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

a150 camera head

From ./dist/samples/json/requests/devices/vehicles/a150/cameraHead/a150CameraHead/core/a150A150CameraHeadSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "3373AE41E4C0": {
                "model": 20,
                "cameraHead": {}
            }
        }
    }
}

Optional cameras

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

Cameras

Example Payloads

DELETE Requests

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/core/a150CameraDeleteSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "EAFD2008E0C2": {
                "model": 20,
                "cameras": {
                    "2B2ED9AD7131": {}
                }
            }
        }
    }
}

From ./dist/samples/json/requests/devices/vehicles/a150/cameras/core/a150CamerasSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "DELETE",
    "payload": {
        "devices": {
            "2F5EC561389D": {
                "model": 20,
                "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/a150/temperature/cpuTemp/a150CPUTemperatureRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "33C733534B35": {
                "model": 20,
                "cpuTemp": 81
            }
        }
    }
}

CPU temperature warning

From ./dist/samples/json/requests/devices/vehicles/a150/temperature/cpuTemp/a150CPUTemperatureWarningSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B0BD4845950F": {
                "model": 20,
                "cpuTemp": 75
            }
        }
    }
}

CPU temperature shutdown

From ./dist/samples/json/requests/devices/vehicles/a150/temperature/cpuTemp/a150CPUTemperatureShutdownSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "EA99D0E06332": {
                "model": 20,
                "cpuTemp": 85
            }
        }
    }
}

Optional cygnus

cygnus?: cygnusType

The ut(cygnus) probe

Optional drive

drive?: CrawlerDrive

Drive

Controls the direction of drive for the a150

remarks

See CrawlerDrive type for more details

Example Payloads

SET Requests

Arbitrary Values

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "04EC4896C279": {
                "model": 20,
                "drive": {
                    "driveMode": "NORMAL",
                    "speed": 60,
                    "steer": -52,
                    "motorsDisabled": true,
                    "calibrator": true
                }
            }
        }
    }
}

Drive mode: Normal

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveModeNormalSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "4E62888D00EF": {
                "model": 20,
                "drive": {
                    "driveMode": "NORMAL"
                }
            }
        }
    }
}

Drive mode: Assist

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveModeAssistSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "2BA9D408C6BF": {
                "model": 20,
                "drive": {
                    "driveMode": "RETRIEVAL_ASSIST"
                }
            }
        }
    }
}

Drive mode: Cruise

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveModeCruiseSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "612EE2BE26E2": {
                "model": 20,
                "drive": {
                    "driveMode": "RETRIEVAL_CRUISE"
                }
            }
        }
    }
}

Random Speed

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveSpeedRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "0ED47688FD76": {
                "model": 20,
                "drive": {
                    "speed": 44
                }
            }
        }
    }
}

Max Speed Forward Speed

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveMaxSpeedForwardSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "58A799BC5104": {
                "model": 20,
                "drive": {
                    "speed": 100
                }
            }
        }
    }
}

Max Speed Backward Speed

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveMaxSpeedBackwardSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "2206AE90EF30": {
                "model": 20,
                "drive": {
                    "speed": -100
                }
            }
        }
    }
}

No Speed

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveNoSpeedSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "4F10EB080D99": {
                "model": 20,
                "drive": {
                    "speed": 0
                }
            }
        }
    }
}

Random Steer

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveSteerRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "FFAF51B0B4E1": {
                "model": 20,
                "drive": {
                    "steer": -45
                }
            }
        }
    }
}

Steer Left

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveSteerLeftSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "39105090B19E": {
                "model": 20,
                "drive": {
                    "steer": -100
                }
            }
        }
    }
}

Steer Right

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveSteerRightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "C5EE5C3B9D64": {
                "model": 20,
                "drive": {
                    "steer": 100
                }
            }
        }
    }
}

No Steer

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150DriveNoSteerSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "1E0274F0A9B9": {
                "model": 20,
                "drive": {
                    "steer": 0
                }
            }
        }
    }
}

Motors Disabled

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150MotorsDisabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "BD2D2EE51DDD": {
                "model": 20,
                "drive": {
                    "motorsDisabled": true
                }
            }
        }
    }
}

Motors Enabled

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150MotorsEnabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "F8AB17C86D4B": {
                "model": 20,
                "drive": {
                    "motorsDisabled": false
                }
            }
        }
    }
}

Active Freewheel Calibration

From ./dist/samples/json/requests/devices/vehicles/a150/drive/a150AFWCalibrationSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "02ED4FD7C0C4": {
                "model": 20,
                "drive": {
                    "calibrator": true
                }
            }
        }
    }
}

Optional elevatingArm

elevatingArm?: ElevatingArm

Elevating Arm

No elevating arm

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmNotPresentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "DF972CF7670F": {
                "model": 20,
                "elevatingArm": {
                    "present": false
                }
            }
        }
    }
}

Elevating arm minimum height

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmMinHeightSample.json

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

Elevating arm maximum height

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmMaxHeightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "3B1A25FD10F7": {
                "model": 20,
                "elevatingArm": {
                    "height": 100
                }
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "EC1E3054D6E1": {
                "model": 20,
                "elevatingArm": {
                    "present": true,
                    "height": 68,
                    "speed": 8,
                    "leak": false
                }
            }
        }
    }
}

Optional hybridPowerDiagnostics

hybridPowerDiagnostics?: VehicleHpDiagnostics

Hybrid Power Diagnostics

Hybrid Power Diagnostics Charge Input Random Sample

From ./dist/samples/json/requests/devices/vehicles/a150/hybridPowerDiagnostics/chargeVoltage/a150HybridPowerDiagnosticsChargeVoltageRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0FD589EDCBE7": {
                "model": 20,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 70
                }
            }
        }
    }
}

Hybrid Power Diagnostics Input Voltage Random Sample

From ./dist/samples/json/requests/devices/vehicles/a150/hybridPowerDiagnostics/inputVoltage/a150HybridPowerDiagnosticsInputVoltageRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "05C3345D9B6A": {
                "model": 20,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 96
                }
            }
        }
    }
}

Hybrid Power Diagnostics Random Sample

From ./dist/samples/json/requests/devices/vehicles/a150/hybridPowerDiagnostics/a150HybridPowerDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D588B3DA5B01": {
                "model": 20,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 87
                }
            },
            "00579E836D66": {
                "model": 20,
                "hybridPowerDiagnostics": {
                    "chargeVoltage": 44
                }
            }
        }
    }
}

Optional imuTemp

imuTemp?: number

IMU Temperature Sensor

Measured in degrees celsius

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a150/temperature/imuTemp/a150IMUTemperatureRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "642F6694F3D0": {
                "model": 20,
                "imuTemp": 31
            }
        }
    }
}

IMU temperature warning

From ./dist/samples/json/requests/devices/vehicles/a150/temperature/imuTemp/a150IMUTemperatureWarningSample.json

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

IMU temperature shutdown

From ./dist/samples/json/requests/devices/vehicles/a150/temperature/imuTemp/a150IMUTemperatureShutdownSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "1E393D4EEDCC": {
                "model": 20,
                "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/a150/motorDiagnostics/leftMotor/a150LeftMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "AD68144A6B85": {
                "model": 20,
                "leftMotorDiagnostics": {
                    "current": 8,
                    "overcurrent": false,
                    "pwm": 0,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a150/motorDiagnostics/leftMotor/a150LeftMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0D4EA8509094": {
                "model": 20,
                "leftMotorDiagnostics": {
                    "current": 28,
                    "overcurrent": true,
                    "pwm": 67,
                    "rpm": 90,
                    "failure": false
                }
            }
        }
    }
}

model

model: A150Crawler

Optional rearLight

rearLight?: Light

Aux Light

Controls the rear light attached to the a150 crawler.

remarks

See Light type for more details.

Example Payloads

SET Requests

Lights On (mid)

From ./dist/samples/json/requests/devices/vehicles/a150/rearLight/a150RearLightOnMidIntensitySample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "187BAB7B96AE": {
                "model": 20,
                "rearLight": {
                    "intensity": 50
                }
            }
        }
    }
}

Lights Off

From ./dist/samples/json/requests/devices/vehicles/a150/rearLight/a150RearLightOffSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "88AE1B0B2E0C": {
                "model": 20,
                "rearLight": {
                    "intensity": 0
                }
            }
        }
    }
}

Lights On (max)

From ./dist/samples/json/requests/devices/vehicles/a150/rearLight/a150RearLightOnMaxIntensitySample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "62C315D86220": {
                "model": 20,
                "rearLight": {
                    "intensity": 100
                }
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a150/rearLight/a150RearLightRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "F636A4A120ED": {
                "model": 20,
                "rearLight": {
                    "intensity": 49
                }
            }
        }
    }
}

Optional rightMotorDiagnostics

rightMotorDiagnostics?: MotorDiagnostics

Right Motor Diagnostics

Resting Motor

From ./dist/samples/json/requests/devices/vehicles/a150/motorDiagnostics/rightMotor/a150RightMotorDiagnosticsRestingSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FE7E03C8DE8F": {
                "model": 20,
                "rightMotorDiagnostics": {
                    "current": 10,
                    "overcurrent": false,
                    "pwm": 4,
                    "rpm": 0,
                    "failure": false
                }
            }
        }
    }
}

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/a150/motorDiagnostics/rightMotor/a150RightMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "39C26F0875AE": {
                "model": 20,
                "rightMotorDiagnostics": {
                    "current": 42,
                    "overcurrent": false,
                    "pwm": 70,
                    "rpm": 64,
                    "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/a150/peripherals/sonde/a150SondeEnabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "6493F3C20461": {
                "model": 20,
                "sonde": {
                    "enabled": true
                }
            }
        }
    }
}

Sonde Disabled

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/sonde/a150SondeDisabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "SET",
    "payload": {
        "devices": {
            "7964283E4E8D": {
                "model": 20,
                "sonde": {
                    "enabled": false
                }
            }
        }
    }
}

Optional usageTime

usageTime?: UsageTime

Vehicle Usage Time

Example Payloads

GET Requests

Current seconds

From ./dist/samples/json/requests/devices/vehicles/a150/usageTime/a150CurrentSecondsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2EE2A118D95A": {
                "model": 20,
                "usageTime": {
                    "currentSeconds": 52
                }
            }
        }
    }
}

Total Seconds

From ./dist/samples/json/requests/devices/vehicles/a150/usageTime/a150TotalSecondsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CBFA2653D5F9": {
                "model": 20,
                "usageTime": {
                    "totalSeconds": 86
                }
            }
        }
    }
}

Arbitrary Total Usage

From ./dist/samples/json/requests/devices/vehicles/a150/usageTime/a150UsageTimeRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.3",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "160FB59898C4": {
                "model": 20,
                "usageTime": {
                    "totalSeconds": 54,
                    "currentSeconds": 35
                }
            }
        }
    }
}

Optional version

version?: DeviceVersion

Version

DELETE Request

Hierarchy

Index

Properties

Properties

Optional auxLight

Example Payloads

SET Requests

Optional battery

Example Payload

Battery Danger Sample

Battery Random Sample

Battery Shutdown Sample

Battery Warning Sample

Optional bodyLeak

Example Payloads

UPDATE Requests

Optional calibrator

Optional cameraHead

Example Payloads

GET Requests

Optional cameras

Example Payloads

DELETE Requests

Optional cpProbe

Optional cpuTemp

Optional cygnus

Optional drive

Example Payloads

SET Requests

Optional elevatingArm

Optional hybridPowerDiagnostics

Hybrid Power Diagnostics Charge Input Random Sample

Hybrid Power Diagnostics Input Voltage Random Sample

Hybrid Power Diagnostics Random Sample

Optional imuTemp

Optional incline

Optional ip

Optional leftMotorDiagnostics

model

Optional rearLight

Example Payloads

SET Requests

Optional rightMotorDiagnostics

Optional roll

Optional sonde

Example Payloads

SET Request

Optional usageTime

Example Payloads

GET Requests

Optional version