Options
All
  • Public
  • Public/Protected
  • All
Menu

DeepTrekker API - v0.54.0

Index

Enumerations

Interfaces Core

Interfaces Device/CameraHeads

Interfaces Device/Cameras

Interfaces DeviceVersions

Interfaces Devices

Interfaces Devices/CameraHeads

Interfaces Devices/Cameras

Interfaces Devices/Core

Interfaces Devices/Peripherals

Interfaces Devices/Reels

Interfaces Devices/Vehicles

Interfaces Other

Interfaces SignalServer

Type Aliases Core

Type Aliases Device

Type Aliases Device/CameraHead

Type Aliases Device/CameraHeads

Type Aliases Device/Cameras

Type Aliases DeviceVersions

Type Aliases Devices

Type Aliases Devices/CameraHeads

Type Aliases Devices/Cameras

Type Aliases Devices/Core

Type Aliases Devices/Peripherals

Type Aliases Devices/Reels

Type Aliases Devices/Vehicles

Type Aliases Devices/Vehicles/Navigation

Type Aliases Devices/peripherals

Type Aliases Other

Type Aliases SignalServer

Variables Other

Variables SignalServer

Core Type Aliases

TransferPayload<T>: { apiVersion: string; error?: TransferError; method: TransferMethodType; payload: T }

TransferPayload

TransferPayload represents the payload structure that should be used via an API to send a payload with a specific load type.

example

From ./dist/samples/json/requests/errors/notAccepted405.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.54.0",
"method": "ERROR",
"payload": {},
"error": {
"code": 405,
"message": "This payload cannot be sent for this request type"
}
}

Type Parameters

  • T

    BridgeBox

Type declaration

  • apiVersion: string

    API target version (defaults to the latest)

    pattern

    (^[0-9]{1,3}[.][0-9]{1,3}([.][0-9]{1,3})?$)

  • Optional error?: TransferError

    Transfer error type

  • method: TransferMethodType

    Method action type

  • payload: T

    Payload

Device Type Aliases

Vehicle: { cameras?: Record<string, Removable<Cameras>> } & Device

Vehicle interface provides a base interfaces for vehicle devices, including ROVs and crawlers.

Device/CameraHead Type Aliases

A150CameraHead: { model: A150CameraHead } & CrawlerCameraHead & Calibratable

Pan-Tilt Camera Head

A200CameraHead: { lasers?: Laser; model: A200CameraHead } & CrawlerCameraHead & Calibratable

Pan-Tilt Camera Head

CrawlerCameraHead: { joint1MotorDiagnostics?: MotorDiagnostics; joint2MotorDiagnostics?: MotorDiagnostics; light?: Light; natural?: boolean; orientation?: CameraHeadOrientation; pan?: CalibratableRotaryJoint; panMotorDiagnostics?: MotorDiagnostics; tilt?: RotaryJoint; tiltMotorDiagnostics?: MotorDiagnostics } & CameraHead & Calibratable

Crawler Camera Head

Device/CameraHeads Type Aliases

CameraHead: { cpuTemp?: number; leak?: boolean; usageTime?: UsageTime } & Device

Device/Cameras Type Aliases

DTCam: { brightness?: number; contrast?: number; model: DTCam; saturation?: number; whiteBalance?: { auto?: boolean; blue?: number; green?: number; red?: number } } & Camera
OcleaCam: Camera & { brightness?: number; contrast?: number; exposure?: { auto?: boolean; autoExposureCompensation?: number; sensorGain?: number; shutterTime?: string }; model: OcleaCam; saturation?: number; whiteBalance?: { auto?: boolean; blue?: number; red?: number } }

📷 4k UHD Camera

TamronHarrierZoomCamera: Camera & { brightness?: number; exposure?: { auto?: boolean; value?: number }; focus?: { auto?: boolean; nearLimit?: 10 | 34 | 90 | 250 | 800 | 2300; rate?: Rate; value?: number }; model: TamronHarrierZoomCamera; saturation?: number; sharpness?: number; zoom?: ZoomControl }

📷 Tamron-Harrier Zoom Camera

TamronOcleaZoomCamera: Camera & { exposure?: { auto?: boolean; value?: number }; focus?: { auto?: boolean; nearLimit?: 10 | 34 | 90 | 250 | 800 | 2300; rate?: Rate; value?: number }; model: TamronOcleaZoomCamera; sharpness?: number; zoom?: ZoomControl }

📷 Tamron-OClea Zoom Camera

DeviceVersions Type Aliases

DeviceVersion: { hardware?: string; software?: string }

Device Version

Device Version is a base interface for hardware and software version sample payloads. -1 hardware versions and 0.0 software versions refer to not applicable

Type declaration

  • Optional hardware?: string
  • Optional software?: string

Devices Type Aliases

Device: { ip?: string; model: DeviceModel; version?: DeviceVersion }

Device

Device interface is a base interface for interacting with derived device types such as vehicles, reels, cameras, etc. In order to properly parse and generate the derived interface data, an appropriate schema must be selected. This can be done by parsing the device's @param model and mapping the associated device schema.

Type declaration

  • Optional ip?: string

    IP address

  • model: DeviceModel

    Deep Trekker internal device model numbers. This can be used for selecting the associated device schema.

  • Optional version?: DeviceVersion

    Version

Devices/CameraHeads Type Aliases

TiltCameraHead: { lasers?: Laser; leak?: boolean; light?: Light; model: TiltCameraHeadModel; tilt?: RotaryJoint; tiltMotorDiagnostics?: MotorDiagnostics } & CameraHead

Tilt Camera Head

Devices/Cameras Type Aliases

Camera: { model: typeof CAMERA_DEVICE_MODELS[number]; osd?: Osd; streamMode?: StreamMode; streams?: Record<string, Stream>; type?: CameraType } & Device

Devices/Core Type Aliases

Battery: { charging?: boolean; diagnostics?: BatteryDiagnostics; leak?: boolean; percent?: number; voltage?: number }

🔋 Battery

notexported
readonly

Type declaration

  • Optional charging?: boolean

    Battery charging state

    description

    Represents whether the battery is being charged or not

  • Optional diagnostics?: BatteryDiagnostics
  • Optional leak?: boolean
  • Optional percent?: number

    Battery charge percentage

    minimum

    0

    maximum

    100

    tjs-type

    integer

  • Optional voltage?: number

    Battery voltage

BatteryDiagnostics: { averageCurrent?: number; averageVoltage?: number; estimatedSoC?: number; instantCurrent?: number; instantVoltage?: number; lastFullChargeCapacity?: number; remainingCapacity?: number; reportedChargeCycles?: number; timeTillEmpty?: number; timeTillFull?: number; totalChargeCycles?: number }

BatteryDiagnostics

TODO: Add samples for all devices that use battery diagnostics

notexported
readonly

Type declaration

  • Optional averageCurrent?: number

    Average current (mA)

    readonly
  • Optional averageVoltage?: number

    Average voltage (mV)

    readonly
    minimum

    0

  • Optional estimatedSoC?: number

    Estimated state of charge

    minimum

    0

    maximum

    100

    tjs-type

    integer

  • Optional instantCurrent?: number

    Instant current (mA)

    readonly
  • Optional instantVoltage?: number

    Instant voltage (mV)

    readonly
    minimum

    0

  • Optional lastFullChargeCapacity?: number

    Last full charge capacity (mAh)

    readonly
  • Optional remainingCapacity?: number

    Remaining capacity (mAh)

    readonly
  • Optional reportedChargeCycles?: number

    Reported charge cycles (charge cycles currently reported by the battery monitoring chip)

    readonly
  • Optional timeTillEmpty?: number

    Time till empty (minutes)

    readonly
  • Optional timeTillFull?: number

    Time till full (minutes)

    readonly
  • Optional totalChargeCycles?: number

    Total charge cycles (charge cycles over the battery's lifetime)

    readonly
Calibratable: { calibrator?: boolean }

Calibrated

readonly

Type declaration

  • Optional calibrator?: boolean

    Calibrator

    Calibrator Front-end (request) Back-end (response)
    true Calibrate -
    false Cancel Calibration -
    undefined - -
MotorDiagnostics: { current?: number; failure?: boolean; overcurrent?: boolean; pwm?: number; rpm?: number }

Motor Diagnostics

Type declaration

  • Optional current?: number

    Motor Current (mA)

    readonly
  • Optional failure?: boolean

    Failure Fault

    readonly
  • Optional overcurrent?: boolean

    Overcurrent Fault

    readonly
  • Optional pwm?: number

    Motor PWM (%)

    minimum

    0

    maximum

    100

    tjs-type

    integer

    readonly
  • Optional rpm?: number

    RPM

    • < 0: reversing
    • > 0: moving forward
    • = 0: not moving ✋
    readonly
UsageTime: { currentSeconds?: number; totalSeconds?: number }

Usage Time

The usage time of a device.

readonly

Type declaration

  • Optional currentSeconds?: number

    Current usage time in seconds.

  • Optional totalSeconds?: number

    Total usage time in seconds.

Devices/Peripherals Type Aliases

Grabber: { openClose?: number; openCloseMotorDiagnostics?: MotorDiagnostics; rotate?: number; rotateMotorDiagnostics?: MotorDiagnostics }

Type declaration

  • Optional openClose?: number

    Open Close motor

    description

    Grabber claw motor power

    • < 0: Close grabber claw
    • == 0: Motor off
    • > 0: Open grabber claw

    Example Payload

    at Close Grabber

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberCloseClawSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "933B3E8A1551": {
    "model": 13,
    "grabber": {
    "openClose": -100
    }
    }
    }
    }
    }
    ~ ##### at Open Grabber

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberOpenClawSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "874CC297413B": {
    "model": 13,
    "grabber": {
    "openClose": 100
    }
    }
    }
    }
    }
    • Open pivot grabber claw

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotOpenClawGrabberSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "10C28A70ED39": {
    "model": 18,
    "grabber": {
    "openClose": 100
    }
    }
    }
    }
    }
    • Close pivot grabber claw

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotCloseClawGrabberSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "4076D40C0D5E": {
    "model": 18,
    "grabber": {
    "openClose": -100
    }
    }
    }
    }
    }
    • OpenClose pivot grabber random

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotOpenCloseGrabberRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "30036B8C93A0": {
    "model": 18,
    "grabber": {
    "openClose": -98
    }
    }
    }
    }
    }
    minimum

    -100

    maximum

    100

  • Optional openCloseMotorDiagnostics?: MotorDiagnostics

    openCloseMotorDiagnostics

    description

    Grabber open close motor diagnostics

    Example Payload

    at all random values

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberOpenCloseMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8F7A3DD7EA0B": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 1,
    "pwm": 95,
    "overcurrent": true,
    "rpm": -10
    },
    "rotateMotorDiagnostics": {}
    }
    }
    }
    }
    }
    at random current

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberOpenCloseMotorDiagnosticsRandomCurrentSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A71696FFA005": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 78
    },
    "rotateMotorDiagnostics": {}
    }
    }
    }
    }
    }
    at random PWM

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberOpenCloseMotorDiagnosticsRandomPwmSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "D8D62DC56A44": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "pwm": 97
    },
    "rotateMotorDiagnostics": {}
    }
    }
    }
    }
    }
    at has overcurrent

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberOpenCloseMotorDiagnosticsHasOvercurrentSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "500B18DC2B45": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "overcurrent": true
    },
    "rotateMotorDiagnostics": {}
    }
    }
    }
    }
    }
    at has no overcurrent

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberOpenCloseMotorDiagnosticsHasNoOvercurrentSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "673BAAC69E8E": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "overcurrent": false
    },
    "rotateMotorDiagnostics": {}
    }
    }
    }
    }
    }
    at static RPM

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberOpenCloseMotorDiagnosticsStaticRpmSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "9941976C1580": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "rpm": 0
    },
    "rotateMotorDiagnostics": {}
    }
    }
    }
    }
    }
    at forward RPM

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberOpenCloseMotorDiagnosticsForwardRpmSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "8BAE31C2C50B": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "rpm": 10
    },
    "rotateMotorDiagnostics": {}
    }
    }
    }
    }
    }
    at backward RPM

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberOpenCloseMotorDiagnosticsBackwardRpmSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7446C7682F8B": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "rpm": -10
    },
    "rotateMotorDiagnostics": {}
    }
    }
    }
    }
    }
    • Resting pivot openClose grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotGrabberOpenCloseMotorDiagnosticRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "DFD7F10C1015": {
    "model": 18,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 2,
    "overcurrent": false,
    "pwm": 5,
    "rpm": -1,
    "failure": false
    }
    }
    }
    }
    }
    }
    • Random pivot openClose grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotGrabberOpenCloseMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "CE5A7E70734F": {
    "model": 18,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 95,
    "overcurrent": true,
    "pwm": 10,
    "rpm": -67,
    "failure": false
    }
    }
    }
    }
    }
    }
    • Open pivot grabber claw diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotOpenClawGrabberDiagnosticSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "545D5F6722F8": {
    "model": 18,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 47,
    "overcurrent": false,
    "pwm": 46,
    "rpm": 6
    }
    }
    }
    }
    }
    }
    • Close pivot grabber claw diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/openClose/pivotCloseClawGrabberDiagnosticSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "316BDB9A556B": {
    "model": 18,
    "grabber": {
    "openCloseMotorDiagnostics": {
    "current": 52,
    "overcurrent": false,
    "pwm": 51,
    "rpm": 6
    }
    }
    }
    }
    }
    }
  • Optional rotate?: number

    Rotation motor

    description

    Grabber rotation motor power

    • < 0 = rotate left
    • == 0 = motor off
    • > 0 = rotate right

    Example Payload

    • Rotate right revolution Grabber

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateLeftSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "3BFD88D2AF50": {
    "model": 13,
    "grabber": {
    "rotate": -100
    }
    }
    }
    }
    }
    • Rotate right revolution Grabber

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRotateRightSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "1D8612C2A4F4": {
    "model": 13,
    "grabber": {
    "rotate": 100
    }
    }
    }
    }
    }
    • Rotate revolution grabber random

      From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/revolutionGrabberRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "6B9EF6AFDAD0": {
      "model": 13,
      "grabber": {
      "rotate": -6,
      "openClose": -72
      }
      }
      }
      }
      }
    • Rotate right pivot grabber

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRotateGrabberRightSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "DB65808E3699": {
    "model": 18,
    "grabber": {
    "rotate": 100
    }
    }
    }
    }
    }
    • Rotate left pivot grabber

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRotateGrabberLeftSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A69E9C111C8A": {
    "model": 18,
    "grabber": {
    "rotate": -100
    }
    }
    }
    }
    }
    • Rotate pivot grabber random

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/pivotRotateGrabberRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7283C5391C51": {
    "model": 18,
    "grabber": {
    "rotate": -42
    }
    }
    }
    }
    }
    minimum

    -100

    maximum

    100

  • Optional rotateMotorDiagnostics?: MotorDiagnostics

    rotateMotorDiagnostics

    description

    Grabber rotate motor diagnostics

    Example Payload

    at all random values

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberRotateMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "47D05B55DD11": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {},
    "rotateMotorDiagnostics": {
    "current": 15,
    "pwm": 25,
    "overcurrent": false,
    "rpm": -10
    }
    }
    }
    }
    }
    }
    at random current

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberRotateMotorDiagnosticsRandomCurrentSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "35FC8724659D": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {},
    "rotateMotorDiagnostics": {
    "current": 29
    }
    }
    }
    }
    }
    }
    at random PWM

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberRotateMotorDiagnosticsRandomPwmSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "319F3E9F8B01": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {},
    "rotateMotorDiagnostics": {
    "pwm": 73
    }
    }
    }
    }
    }
    }
    at has overcurrent

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberRotateMotorDiagnosticsHasOvercurrentSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "70FC8D3AD8A0": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {},
    "rotateMotorDiagnostics": {
    "overcurrent": true
    }
    }
    }
    }
    }
    }
    at has no overcurrent

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberRotateMotorDiagnosticsHasNoOvercurrentSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "7FBC328DD25B": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {},
    "rotateMotorDiagnostics": {
    "overcurrent": false
    }
    }
    }
    }
    }
    }
    at static RPM

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberRotateMotorDiagnosticsStaticRpmSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "49302D97D6E7": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {},
    "rotateMotorDiagnostics": {
    "rpm": 0
    }
    }
    }
    }
    }
    }
    at forward RPM

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberRotateMotorDiagnosticsForwardRpmSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "71813F8EE66B": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {},
    "rotateMotorDiagnostics": {
    "rpm": 10
    }
    }
    }
    }
    }
    }
    at backward RPM

    From ./dist/samples/json/requests/devices/vehicles/revolution/grabber/motorDiagnostics/revolutionGrabberRotateMotorDiagnosticsBackwardRpmSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "E64BE9BF72C0": {
    "model": 13,
    "grabber": {
    "openCloseMotorDiagnostics": {},
    "rotateMotorDiagnostics": {
    "rpm": -10
    }
    }
    }
    }
    }
    }
    • Resting pivot rotate grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotGrabberRotateMotorDiagnosticsRestingSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "F149A2945690": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 1,
    "overcurrent": false,
    "pwm": 1,
    "rpm": 1,
    "failure": false
    }
    }
    }
    }
    }
    }
    • Random pivot rotate grabber diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotGrabberRotateMotorDiagnosticsRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "A2ABE5B07829": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 29,
    "overcurrent": false,
    "pwm": 80,
    "rpm": 89,
    "failure": false
    }
    }
    }
    }
    }
    }
    • Rotate right pivot grabber claw diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotRotateGrabberRightDiagnosticSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "59973D284D8F": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 55,
    "overcurrent": false,
    "pwm": 48,
    "rpm": 6
    }
    }
    }
    }
    }
    }
    • Rotate left pivot grabber claw diagnostic

    From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/grabber/motorDiagnostics/rotate/pivotRotateGrabberLeftDiagnosticSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "devices": {
    "6D4CEA9DA3AD": {
    "model": 18,
    "grabber": {
    "rotateMotorDiagnostics": {
    "current": 46,
    "overcurrent": false,
    "pwm": 46,
    "rpm": 8
    }
    }
    }
    }
    }
    }
Laser: { enabled: boolean }

Type declaration

  • enabled: boolean

    Laser Enabled

    • true = enabled
    • false = disabled

    Example Payload

    at Laser On

    From ./dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/lasers/a200A200CameraHeadLaserOnSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "devices": {
    "F8F4B72A8498": {
    "model": 19,
    "cameraHead": {
    "model": 106,
    "lasers": {
    "enabled": true
    }
    }
    }
    }
    }
    }
    at Laser Off

    From ./dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/lasers/a200A200CameraHeadLaserOffSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "devices": {
    "8F4F731893F0": {
    "model": 19,
    "cameraHead": {
    "model": 106,
    "lasers": {
    "enabled": false
    }
    }
    }
    }
    }
    }
Light: { intensity: number }

Type declaration

  • intensity: number

    Light Intensity

    description

    Light intensity, intensity of zero is off.

    Example Payload

    at Light Intensity Random

    From ./dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityRandomSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "devices": {
    "0568FEC1E7CE": {
    "model": 19,
    "cameraHead": {
    "model": 106,
    "light": {
    "intensity": 49
    }
    }
    }
    }
    }
    }
    at Light Intensity Minimum

    From ./dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityMinSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "devices": {
    "CEEEB6BE57AB": {
    "model": 19,
    "cameraHead": {
    "model": 106,
    "light": {
    "intensity": 0
    }
    }
    }
    }
    }
    }
    at Light Intensity Maximum

    From ./dist/samples/json/requests/devices/vehicles/a200/cameraHead/a200CameraHead/light/a200A200CameraHeadLightIntensityMaxSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "devices": {
    "193750194A2A": {
    "model": 19,
    "cameraHead": {
    "model": 106,
    "light": {
    "intensity": 100
    }
    }
    }
    }
    }
    }
    minimum

    0

    maximum

    100

Sonde: { enabled: boolean }

Type declaration

  • enabled: boolean

    Sonde Enabled

    • true = enabled
    • false = disabled

    Example Payload

    at Sonde Off

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

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

    at Sonde On

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

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "devices": {
    "5D631C8C5F11": {
    "model": 19,
    "sonde": {
    "enabled": true
    }
    }
    }
    }
    }
TiltPlatform: { tilt?: number; tiltMotorDiagnostics?: MotorDiagnostics }

Tilt Grabber Arm

Type declaration

  • Optional tilt?: number

    Tilt

    Example Payloads

    GET Requests

    • Resting pivot tilt platform

      From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformRestingSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "6977DBCECC19": {
      "model": 18,
      "tiltPlatform": {
      "tilt": 0
      }
      }
      }
      }
      }
    • Tilt up

      From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformUpSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "4C964B390D52": {
      "model": 18,
      "tiltPlatform": {
      "tilt": 100
      }
      }
      }
      }
      }
    • Tilt down

      From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformDownSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "9A11E4B74B8D": {
      "model": 18,
      "tiltPlatform": {
      "tilt": -100
      }
      }
      }
      }
      }
    • Random tilt pivot tilt platform

      From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/pivotTiltPlatformRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "F647854FF745": {
      "model": 18,
      "tiltPlatform": {
      "tilt": 75
      }
      }
      }
      }
      }
  • Optional tiltMotorDiagnostics?: MotorDiagnostics

    Tilt Motor Diagnostics

    Example Payloads

    GET Requests

    • Resting pivot tilt platform diagnostic

      From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDiagnosticsRestingSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "C1F272C195D5": {
      "model": 18,
      "tiltPlatform": {
      "tiltMotorDiagnostics": {
      "current": 1,
      "overcurrent": false,
      "pwm": 4,
      "rpm": 0,
      "failure": false
      }
      }
      }
      }
      }
      }
    • Tilt up pivot tilt platform diagnostic

      From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformUpDiagnosticsSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "9E4F7EADFA29": {
      "model": 18,
      "tiltPlatform": {
      "tiltMotorDiagnostics": {
      "current": 51,
      "overcurrent": false,
      "pwm": 54,
      "rpm": 5
      }
      }
      }
      }
      }
      }
    • Tilt down pivot tilt platform diagnostic

      From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDownDiagnosticsSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "6923A857E46E": {
      "model": 18,
      "tiltPlatform": {
      "tiltMotorDiagnostics": {
      "current": 55,
      "overcurrent": false,
      "pwm": -50,
      "rpm": -7
      }
      }
      }
      }
      }
      }
    • Random tilt pivot tilt platform diagnostic

      From ./dist/samples/json/requests/devices/vehicles/pivot/peripherals/tiltPlatform/motorDiagnostics/tilt/pivotTiltPlatformDiagnosticsRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "3E86B16DF3AD": {
      "model": 18,
      "tiltPlatform": {
      "tiltMotorDiagnostics": {
      "current": 73,
      "overcurrent": true,
      "pwm": 16,
      "rpm": 55,
      "failure": false
      }
      }
      }
      }
      }
      }

Devices/Reels Type Aliases

ManualReel: { model: ManualReel } & Reel
PoweredReel: { acConnected?: boolean; battery1?: Battery; battery2?: Battery; crawlerForward?: boolean; crawlerReverse?: boolean; eStop?: boolean; hybridPower?: boolean; model: PoweredReel; motor1Diagnostics?: MotorDiagnostics; motor2Diagnostics?: MotorDiagnostics; reelForward?: boolean; reelReverse?: boolean; speed?: number } & Reel

Powered Reel

summary

Reel

Reel: { cpuTemp?: number; distance?: number; leak?: boolean } & Device & Calibratable

Devices/Vehicles Type Aliases

A150: { auxLight?: Light; battery?: Battery; bodyLeak?: boolean; cameraHead?: Removable<A150CameraHead> | Removable<A200CameraHead>; cameras?: Record<string, Removable<Cameras>>; cpuTemp?: number; drive?: CrawlerDrive; elevatingArm?: ElevatingArm; imuTemp?: number; incline?: number; leftMotorDiagnostics?: MotorDiagnostics; model: A150Crawler; rearLight?: Light; rightMotorDiagnostics?: MotorDiagnostics; roll?: number; sonde?: Sonde; usageTime?: UsageTime } & Vehicle & Calibratable

A150 Class

A-150 vehicle type.

A200: { auxLight?: Light; battery?: Battery; bodyLeak?: boolean; cameraHead?: Removable<A200CameraHead> | Removable<A150CameraHead>; cameras?: Record<string, Removable<Cameras>>; cpuTemp?: number; drive?: CrawlerDrive; elevatingArm?: ElevatingArm; imuTemp?: number; incline?: number; leftMotorDiagnostics?: MotorDiagnostics; model: A200Crawler; rearLight?: Light; rightMotorDiagnostics?: MotorDiagnostics; roll?: number; sonde?: Sonde; usageTime?: UsageTime } & Vehicle & Calibratable

A200 Class

A-200 vehicle type.

Pivot: { auxLight?: Light; cameraHead?: Removable<TiltCameraHead>; cameras?: Record<string, Removable<Cameras>>; cpuTemp?: number; frontLeftMotorDiagnostics?: MotorDiagnostics; frontRightMotorDiagnostics?: MotorDiagnostics; grabber?: Grabber; leftBattery?: Battery; model: Pivot; rearLeftMotorDiagnostics?: MotorDiagnostics; rearRightMotorDiagnostics?: MotorDiagnostics; rightBattery?: Battery; spareMotor1?: MotorDiagnostics; tiltPlatform?: TiltPlatform; usageTime?: UsageTime; version?: DeviceVersion; verticalFrontMotorDiagnostics?: MotorDiagnostics; verticalRearMotorDiagnostics?: MotorDiagnostics; waterTemp?: number } & Rov
description

Pivot vehicle type.

Revolution: { auxLight?: Light; cameraHead?: Removable<TiltCameraHead>; cpuTemp?: number; frontLeftMotorDiagnostics?: MotorDiagnostics; frontRightMotorDiagnostics?: MotorDiagnostics; grabber?: Grabber; leftBattery?: Battery; model: Revolution; rearLeftMotorDiagnostics?: MotorDiagnostics; rearRightMotorDiagnostics?: MotorDiagnostics; rightBattery?: Battery; spareMotor1?: MotorDiagnostics; spareMotor2?: MotorDiagnostics; verticalLeftMotorDiagnostics?: MotorDiagnostics; verticalRightMotorDiagnostics?: MotorDiagnostics; waterTemp?: number } & Rov

📖 See extended definition Revolution Class

description

Revolution vehicle type.

Devices/Vehicles/Navigation Type Aliases

Navigation: { position?: Position; velocity?: Velocity }
description

Navigational data for the ROV.

Type declaration

  • Optional position?: Position

    ROV Position

    description

    Contains positional data about the ROV.

    Example payloads

    UPDATE Requests

    • Invalid position sample

    • Revolution

      From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionPositionInvalidSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "4853FD4CF94C": {
      "model": 13,
      "position": {
      "local": {
      "uncertainty": 10000
      },
      "global": {
      "uncertainty": 10000
      }
      }
      }
      }
      }
      }
    • Pivot

      From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotPositionInvalidSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "5149CCE7BC1D": {
      "model": 18,
      "position": {
      "local": {
      "uncertainty": 10000
      },
      "global": {
      "uncertainty": 10000
      }
      }
      }
      }
      }
      }
    • Arbitrary position sample

    • Revolution

      From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionPositionRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "165E91E90D33": {
      "model": 13,
      "position": {
      "local": {
      "northing": -157,
      "easting": 931,
      "uncertainty": 86
      },
      "global": {
      "latitude": 5,
      "longitude": 39,
      "uncertainty": 62
      }
      }
      }
      }
      }
      }
    • Pivot

      From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotPositionRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "7F1AE434D47E": {
      "model": 18,
      "position": {
      "local": {
      "northing": 673,
      "easting": -816,
      "uncertainty": 34
      },
      "global": {
      "latitude": 61,
      "longitude": 59,
      "uncertainty": 23
      }
      }
      }
      }
      }
      }

    UPDATE Requests

    • Arbitrary Local position only

    • Revolution

      From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionLocalPositionSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "089FE8E68AC4": {
      "model": 13,
      "position": {
      "local": {
      "northing": 10,
      "easting": 10,
      "uncertainty": 10
      }
      }
      }
      }
      }
      }
    • Pivot

      From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotLocalPositionRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "54218F6E6BE5": {
      "model": 18,
      "position": {
      "local": {
      "northing": 377,
      "easting": 387,
      "uncertainty": 91
      }
      }
      }
      }
      }
      }
    • Arbitrary Global position only

    • Revolution

      From ./dist/samples/json/requests/devices/vehicles/revolution/position/revolutionGlobalPositionSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "472E73511F4F": {
      "model": 13,
      "position": {
      "global": {
      "latitude": 10,
      "longitude": 10,
      "uncertainty": 10
      }
      }
      }
      }
      }
      }
    • Pivot

      From ./dist/samples/json/requests/devices/vehicles/pivot/position/pivotGlobalPositionRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "CA7AB3480428": {
      "model": 18,
      "position": {
      "global": {
      "latitude": 50,
      "longitude": -151,
      "uncertainty": 87
      }
      }
      }
      }
      }
      }
  • Optional velocity?: Velocity

    Rov Velocity

    description

    Velocity and speed components for the ROV

    Example payloads

    UPDATE Requests

    • Arbitrary velocity samples
    • Revolution

      From ./dist/samples/json/requests/devices/vehicles/revolution/velocity/revolutionVelocityRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "FFDB67A4798B": {
      "model": 13,
      "velocity": {
      "valid": false,
      "forward": -56,
      "rightward": 62,
      "downward": 88,
      "speed": 84
      }
      }
      }
      }
      }
    • Pivot

      From ./dist/samples/json/requests/devices/vehicles/pivot/velocity/pivotVelocityRandomSample.json

      {
      "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
      "apiVersion": "0.54.0",
      "method": "UPDATE",
      "payload": {
      "devices": {
      "9B5C1C02CA54": {
      "model": 18,
      "velocity": {
      "valid": false,
      "forward": -71,
      "rightward": 20,
      "downward": -43,
      "speed": 98
      }
      }
      }
      }
      }

Devices/peripherals Type Aliases

ElevatingArm: { height?: number; leak?: boolean; motorDiagnostics?: MotorDiagnostics; present?: boolean; speed?: number } & Calibratable

🦾 Elevating arm

Other Type Aliases

BridgeBox: { devices?: Record<string, Removable<Devices>>; networkDiagnostics?: Record<string, NetworkDiagnostics>; serialDevices?: Record<string, SerialDevice>; sonar?: Sonar; swupdate?: SWUpdate; systemSettings?: SystemSettings; version?: DeviceVersion }

BRIDGE Box represents the root of the API endpoint routing

TODO: Currently this is a pretty bare bones class, but in the future it will be extended to hold interfaces to other subsystems on the BRIDGE Box. These could include hardware access, storage devices, network interfaces, update system, etc...

Type declaration

  • Optional devices?: Record<string, Removable<Devices>>

    Devices

    This contains a list of devices and associated UUIDs for accessing connected devices, such as vehicles, reels, etc.

  • Optional networkDiagnostics?: Record<string, NetworkDiagnostics>

    NetworkDiagnostics

    Record of known network interfaces on the bridgebox and their live performance diagnostics.

    Multiple records may be correlated to a single interfaceName. There will typically be two records for a given interfaceName to represent local and remote mac addresses of the network connection. Records here are differentiated by the network card's unique MAC Address.

    readonly
    outputsample

    clients

  • Optional serialDevices?: Record<string, SerialDevice>

    SerialDevices

    This list contains all the serial devices that the backend can modify and communicate with.

    It can be updated with a new key(generated by the frontend) to create a WebSerialDevice

    From ./dist/samples/json/requests/bridgeBox/serialDevices/bridgeBoxSerialDevicesSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "UPDATE",
    "payload": {
    "serialDevices": {
    "xHCI Host Controller 3": {
    "deviceType": "Controller",
    "baudRate": 115200,
    "name": "Top USB Port"
    },
    "xHCI Host Controller 1": {
    "deviceType": "Controller",
    "baudRate": 115200,
    "name": "Bottom USB Port",
    "connectionId": "External GPS Source",
    "connectionName": "GPS Source"
    },
    "External GPS Source": {
    "deviceType": "Internal",
    "baudRate": 115200,
    "name": "External GPS",
    "connectionId": "xHCI Host Controller 1",
    "connectionName": "Bottom USB Port"
    }
    }
    }
    }
  • Optional sonar?: Sonar

    Sonar

    This is the currently connected sonar device

  • Optional swupdate?: SWUpdate

    SWUpdate

  • Optional systemSettings?: SystemSettings

    SystemSettings

  • Optional version?: DeviceVersion

    Version

    The BridgeBox version will be incremented when backend services or operating system updates are available. This type should be checked against the BridgeBox version provided within the update package meta data.

CalibratableRotaryJoint: RotaryJoint & Calibratable

Calibratable Rotary Joint

Allows specific calibration routines to be run on a rotary joint.

CameraDeviceFromModel<T>: Match<T, CameraModelMap>

Type Parameters

  • T

CameraHeadDeviceFromModel<T>: Match<T, CameraHeadModelMap>

Type Parameters

  • T

CameraHeadModelMap: { 102: TiltCameraHead; 103: TiltCameraHead; 106: A200CameraHead; 109: A150CameraHead }
CameraModelMap: { 206: OcleaCam; 240: TamronHarrierZoomCamera; 243: TamronOcleaZoomCamera; 5: DTCam }

Camera Device Models

A collection of all used camera models

Cameras

A collection of all used camera types.

Changelog: { [ deviceModel in DeviceModel | "BRIDGEBOX"]?: HardwareRevisions }

Changelog

An package containing information related to an update of one or more devices.

Client: { client_id: string; connection_id: string }

Client

Identify a client through its named and connection ids

Type declaration

  • client_id: string
  • connection_id: string
Crawler: A150 | A200
CrawlerCameraHeadModel: A150CameraHead | A200CameraHead
CrawlerDeviceFromModel<T>: Match<T, CrawlerModelMap>

Type Parameters

  • T

CrawlerDrive: { driveMode?: CrawlerDriveMode; motorsDisabled?: boolean; speed?: number; steer?: number } & Calibratable

Crawler drive

CrawlerModel: A150Crawler | A200Crawler
CrawlerModelMap: { 19: A200; 20: A150 }

Type declaration

DateTime: { networkTimeSync?: boolean; timestamp?: string }

DateTime

An endpoint to facilitate requesting and adjusting the datetime of the BridgeBox.

Type declaration

  • Optional networkTimeSync?: boolean

    Automatic Date Time Network Sync

    Automatically sync date and time with the NTP server (requires a network connection with an NTP server to sync time)

  • Optional timestamp?: string

    Timestamp

    Used to define the system time.

    Formatted to ISO 8601/RFC 3339 (with time zone extension) spec

    Note: The applied timestamp will not be persistent if the system's network time sync is enabled and there's an NTP server in the network. Use the networkTimeSync property to explicitly disable the network time sync before setting the timestamp.

Devices

This is a collection of all devices used.

FileTransfer: { name?: string; readyToTransfer?: boolean; sha256?: string; size?: number }

FileTransfer

Describe the meta data related to a generic file transfer.

Type declaration

  • Optional name?: string

    File name

    description

    The plain file name with file extension. May not contain directory structures.

  • Optional readyToTransfer?: boolean

    readyToTransfer

    description

    Indicate the receiver is ready for the file transfer. Sender should await this response before sending a byte stream via WebRTC. May not send multiple files to a single endpoint at a time. If multiple files are attempted to be sent simultaneously the receiver should send an error message.

    readonly
  • Optional sha256?: string

    Checksum

    description

    The sha256 checksum used to verify the file content after transfer.

  • Optional size?: number

    File size

    description

    Total number of bytes of the file.

GlobalPosition: { latitude?: number; longitude?: number; uncertainty?: number }

📖 See extended definition Rov Global Position

description

contains positional data for the ROV in the Global reference frame

Type declaration

  • Optional latitude?: number

    Latitude (in degrees decimal)

    minimum

    -90

    maximum

    90

  • Optional longitude?: number

    Longitude (in degrees decimal)

    minimum

    -180

    maximum

    180

  • Optional uncertainty?: number

    Uncertainty radius (in meters)

    minimum

    0

HardwareRevision: {}

HardwareRevision

A list of software updates for specific hardware.

Type declaration

HardwareRevisions: {}

HardwareRevisions

A list of corresponding hardware revisions.

Type declaration

IceCandidateMessage: { content: string; sdpMLineIndex: number; sdpMid: string }

SdpMessage (used internally)

Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

Type declaration

  • content: string
  • sdpMLineIndex: number
  • sdpMid: string
LocalPosition: { easting?: number; northing?: number; uncertainty?: number }

📖 See extended definition Rov Local Position

description

contains positional data for the ROV in the Local reference frame

Type declaration

  • Optional easting?: number

    Easting (in meters)

  • Optional northing?: number

    Northing (in meters)

  • Optional uncertainty?: number

    Uncertainty radius (in meters)

    minimum

    0

Lookup<T>: { [ _key in T]?: string }

Indexed look up structure records

Type Parameters

  • T extends number | string

Match<T, M>: T extends keyof M ? M[T] : never

Type Parameters

  • T

  • M

NetworkDiagnostics: { bridgedDestinationAddress: String; chipset: String; firmwareVersion: String; inboundRate: String; interfaceName: String; networkRole: NetworkRole; outboundRate: String; physicalLocation: PhysicalLocation; terminalEndpointIdentifier: String }

Type declaration

  • bridgedDestinationAddress: String

    MAC of corresponding ethernet IFace behind VDSL

    readonly
  • chipset: String

    Hardware chipset name

    readonly
  • firmwareVersion: String

    The device firmware version

    readonly
  • inboundRate: String

    Mbps

    readonly
  • interfaceName: String

    Network interface name.

    e.g. "ETH0", "ETH1", etc

    readonly
  • networkRole: NetworkRole

    CCO (Central Coordinator) or STA (Station)

    readonly
  • outboundRate: String

    Mbps

    readonly
  • physicalLocation: PhysicalLocation

    May be local or remote

    readonly
  • terminalEndpointIdentifier: String

    A local address

    readonly
OfferAnswer: { caller?: string; sdp: RTCSessionDescription; sessionId?: string; target?: string }

Type declaration

  • Optional caller?: string
  • sdp: RTCSessionDescription
  • Optional sessionId?: string
  • Optional target?: string
Osd: { enabled?: boolean }

OSD (On-screen Display)

Type declaration

  • Optional enabled?: boolean

    Enabled

    Toggles the on-screen display of the harrier camera.

Position: { global?: GlobalPosition; local?: LocalPosition }
description

contains positional data for the ROV

Type declaration

Rate: -1 | 0 | 1

Rate modifer

This is meant to be sent continuously in order to increment/decrement certain values.

  • 📉 Decrease = -1
  • 📈 Increase = 1
  • No Change = 0
ReelDeviceFromModel<T>: Match<T, ReelModelMap>

Type Parameters

  • T

ReelModelMap: { 107: ManualReel; 108: PoweredReel }

Type declaration

ReelModels: PoweredReel | ManualReel
Removable<T>: T | Record<string, never>

Removable

Represents an object that can be removed.

Type Parameters

  • T

Resolution: { height?: number; width?: number }

Resolution, in pixels

Type declaration

  • Optional height?: number
  • Optional width?: number
RotaryJoint: { position?: number; speed?: number }

Rotary Joint

This joint can rotate around.

Type declaration

  • Optional position?: number

    Position

    The rotary position in degrees.

    Pivot rotary position

    minimum

    -90

    maximum

    110

  • Optional speed?: number

    Joint Speed

    minimum

    -100

    maximum

    100

RovDrive: { modes?: { altitudeLock?: boolean; autoStabilization?: boolean; depthLock?: boolean; headingLock?: boolean; motorsDisabled?: boolean }; thrust?: RovThrust }

Rov Drive

description

Container for thrust and mode settings to the ROV

remarks

This is for direct drive using the existing topside-vehicle command architecture. Drive input should be bound to thrusts, any higher level controls should utilize a more sophisticated controls structure.

Type declaration

  • Optional modes?: { altitudeLock?: boolean; autoStabilization?: boolean; depthLock?: boolean; headingLock?: boolean; motorsDisabled?: boolean }

    Modes are not mutually exclusive. Mode requests to the ROV are handled via the state-system

    • Optional altitudeLock?: boolean
    • Optional autoStabilization?: boolean
    • Optional depthLock?: boolean
    • Optional headingLock?: boolean
    • Optional motorsDisabled?: boolean
  • Optional thrust?: RovThrust

    Thrust - forward, yaw, vertical and lateral

RovThrust: { forward: number; lateral: number; vertical: number; yaw: number }

Rov Thrust

description

ROV Thrust commands. All values must be set at the same time as one bundled message. Values are expected to be integers, within the range of +/- 120.

Type declaration

  • forward: number
  • lateral: number
  • vertical: number
  • yaw: number
SWUpdate: { file?: FileTransfer; log?: string; progress?: number }

SWUpdate

An endpoint to facilitate the software update process.

Type declaration

  • Optional file?: FileTransfer

    File

    description

    Define the update package tar file to be transferred.

  • Optional log?: string

    Log

    description

    Provides messages driven by state of the update. WebApp may choose to display these messages as they are delivered.

    readonly
  • Optional progress?: number

    Progress

    description

    Percentage complete indicator.

    readonly
    minimum

    0

    maximum

    100

SdpMessage: { sdp: string; type: SdpMessageType }

SdpMessage (used internally)

Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

Type declaration

SerialDevice: { baudRate: number; connectionId?: string; connectionName?: string; deviceType: SerialDeviceType; name: string }

Type declaration

  • baudRate: number

    The baud rate for the serial device. This value is meaningless with deviceType::Web

  • Optional connectionId?: string

    The id of the device that this device is connected to. If null then this device is not connected to anything

  • Optional connectionName?: string

    The name of the device that this device is connected to. if null then this device is not connected to anything. This is purely provided for convenience. If a name change is required send an update to the actual device.

  • deviceType: SerialDeviceType

    Indicates the type of device

  • name: string

    The display name of this device

SoftwareUpdate: { releaseDate: string; versionNotes: VersionNote }

SoftwareUpdate

Describes a software update giving a release date and corresponding version notes.

Type declaration

Sonar: { active?: boolean; frequency?: SonarFrequency; gain?: number; lowPower?: boolean; model?: SonarModel; range?: number }

Type declaration

  • Optional active?: boolean

    Indicates if the device is currently sending frames to the web app when set to true the backend will create a datachannel called "SONAR_DATA_CHANNEL" to send sonar images

  • Optional frequency?: SonarFrequency

    The frequency of the device

  • Optional gain?: number

    The gain of the sonar

  • Optional lowPower?: boolean

    The low power state of the device

  • Optional model?: SonarModel

    The model of the sonar

  • Optional range?: number

    The range of the sonar

Stream: { active: boolean; resolution?: Resolution }

Camera stream

Type declaration

  • active: boolean

    Stream active

    remarks

    This indicates which active stream the client should focus on displaying to the user.

  • Optional resolution?: Resolution

    Stream resolution

StreamMode: { availableModes?: Partial<Record<StreamModes, boolean>>; mode?: StreamModes }

Type declaration

  • Optional availableModes?: Partial<Record<StreamModes, boolean>>

    All available modes for this camera.

  • Optional mode?: StreamModes

    The currently active mode

SystemSettings: { dateTime?: DateTime; systemOfMeasurement?: SystemOfMeasurement }

SystemSettings

An endpoint to facilitate requesting and adjusting system settings.

Type declaration

  • Optional dateTime?: DateTime

    Date Time

    Date time settings for setting/getting the system time

    NetworkTimeSync network examples

    NetworkTimeSync enabled

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNetworkTimeSyncEnabledSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "networkTimeSync": true
    }
    }
    }
    }

    NetworkTimeSync disabled

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNetworkTimeSyncDisabledSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "networkTimeSync": false
    }
    }
    }
    }

    Timestamp examples

    References:

    Local

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLocaleSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "timestamp": "2024-04-17T16:32:25.920545913+00:00[UTC]"
    }
    }
    }
    }

    UTC

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeUTCSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "timestamp": "2024-04-17T16:32:25.932545931+00:00[UTC]"
    }
    }
    }
    }

    Greenwich

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeGreenwichSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "timestamp": "2024-04-17T16:32:25.913540572+00:00[UTC]"
    }
    }
    }
    }

    Europe/London

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLondonSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "timestamp": "2024-04-17T17:32:25.92254592+01:00[Europe/London]"
    }
    }
    }
    }

    America/Los_Angeles

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeLosAngelesSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "timestamp": "2024-04-17T09:32:25.924545922-07:00[America/Los_Angeles]"
    }
    }
    }
    }

    America/New_York

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeNewYorkSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "timestamp": "2024-04-17T12:32:25.927545924-04:00[America/New_York]"
    }
    }
    }
    }

    Asia/Tokyo

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeTokyoSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "timestamp": "2024-04-18T01:32:25.929545927+09:00[Asia/Tokyo]"
    }
    }
    }
    }

    America/Toronto

    From ./dist/samples/json/requests/bridgeBox/systemSettings/dateTime/bridgeBoxSystemSettingsDateTimeTorontoSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "dateTime": {
    "timestamp": "2024-04-17T12:32:25.931545929-04:00[America/Toronto]"
    }
    }
    }
    }
  • Optional systemOfMeasurement?: SystemOfMeasurement

    System of measurement

    The system of measurement that the BridgeBox will use

    SystemOfMeasurement examples

    METRIC

    From ./dist/samples/json/requests/bridgeBox/systemSettings/systemOfMeasurement/bridgeBoxSystemSettingsSystemOfMeasurementMetricSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "systemOfMeasurement": "METRIC"
    }
    }
    }

    IMPERIAL

    From ./dist/samples/json/requests/bridgeBox/systemSettings/systemOfMeasurement/bridgeBoxSystemSettingsSystemOfMeasurementImperialSample.json

    {
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.54.0",
    "method": "SET",
    "payload": {
    "systemSettings": {
    "systemOfMeasurement": "IMPERIAL"
    }
    }
    }
TiltCameraHeadModel: RevolutionCameraHead | PivotCameraHead
TransferError: { code: ErrorCode; message: string }

Error message from the Bridge Box

Type declaration

  • code: ErrorCode

    Error code, used only with ERROR method types

  • message: string

    Error message

UpdatePackagePayload: { buildDate: string; changelog: Changelog; sha256: string; size: string }

UpdatePackagePayload

An package containing information related to an update of one or more devices.

Type declaration

  • buildDate: string

    buildDate

    description

    Provides a build date to UpdatePackage.

    readonly
  • changelog: Changelog

    Changelog

    description

    A list changes reflecting devices and their hardware and software revisions.

    readonly
  • sha256: string

    sha256

    description

    The sha256 checksum used to verify the file content after transfer.

    readonly
  • size: string

    size

    description

    Total number of bytes of the file.

    readonly
VehicleDeviceFromModel<T>: Match<T, VehicleModelMap>

Type Parameters

  • T

VehicleModelMap: { 13: Revolution; 18: Pivot; 19: A200; 20: A150 }

Type declaration

Velocity: { downward?: number; forward?: number; rightward?: number; speed?: number; valid?: boolean }
description

contains velocity components and speed of the ROV.

Type declaration

  • Optional downward?: number
  • Optional forward?: number
  • Optional rightward?: number
  • Optional speed?: number

    Scalar Magnitude of velocity components (forward, rightward and downward velocity)

    minimum

    0

  • Optional valid?: boolean
VersionNote: { fixes: string[]; improvements: string[] }

VersionNote

Describes changes made in a software update, an array of improvements and bug fixes.

Type declaration

  • fixes: string[]
  • improvements: string[]
ZoomControl: { ratio?: number; speed?: number }

Zoom control

Type declaration

  • Optional ratio?: number

    Zoom Ratio

    remarks

    Represented as a multiplier, 1x zoom for fully zoomed out, higher values when zoomed in (3x, 12.3x, 20x, etc..)

  • Optional speed?: number

    Zoom Speed

    minimum

    -100

    maximum

    100

__TransferPayload_BridgeBox: TransferPayload<BridgeBox> | UpdatePackagePayload

SignalServer Type Aliases

Answer: OfferAnswer

Answer

Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

protocol

wss | https

endpoint

/answer

IceCandidate: { caller?: string; candidate?: IceCandidateMessage; sessionId?: string; target?: string }

IceCandidate

Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

protocol

wss | https

endpoint

/ice_candidate

From ./dist/samples/json/server/iceCandidate.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"target": "b4c51940-7322-4d0a-9c29-d3c0cdc681e7",
"caller": "9458aa18-ba85-411f-a6c8-80eb250aa6f2",
"sessionId": "f7c0bb9b-f8da-48f9-a63e-b65b18df9eab",
"candidate": {
"sdpMid": "0",
"sdpMLineIndex": 0,
"content": "candidate:1409274494 1 udp 2113937151 34a834b8-3b04-4007-968d-c635dc6a11ca.local 42461 typ host generation 0 ufrag heL6 network-cost 999"
}
}

Type declaration

  • Optional caller?: string
  • Optional candidate?: IceCandidateMessage
  • Optional sessionId?: string
  • Optional target?: string
JoinSession: { client_id: string; session_id: string }

JoinSession

Join a session with a user.

Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

typeparam T

BridgeBox

protocol

wss | https

endpoint

/join_session

Type declaration

  • client_id: string
  • session_id: string
LeaveSession: { client_id: string; session_id: string }

LeaveSession

Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

protocol

wss | https

endpoint

/leave_session

Type declaration

  • client_id: string
  • session_id: string

Offer

Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

protocol

wss | https

endpoint

/offer

OnDisconnectAsync: {}

OnDisconnectAsync

See base method documentation on OnDisconnectAsync

override
protocol

wss | https

endpoint

/session_closed

Type declaration

    RegisterSession: string

    RegisterSession

    Creates a new session using a unique vehicle id.

    protocol

    wss | https

    endpoint

    /register_session

    Session: { clients: Client[]; connection_id: string; session_id: string }

    Session

    Sends a list of all the sessions currently authorized for use.

    Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

    endpoint

    /session_list

    protocol

    wss | https

    response

    Response to SessionCheck.

    Type declaration

    • clients: Client[]
    • connection_id: string
    • session_id: string
    SessionCheck: { client_id: string }

    SessionCheck

    Returns a list of all the sessions currently authorized for use.

    Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

    endpoint

    /session_check

    protocol

    wss | https

    Type declaration

    • client_id: string

    Other Variables

    CAMERA_DEVICE_MODEL_LABELS: { 206: "4K UHD Camera"; 207: "Zoom Camera JZC"; 240: "Zoom Camera H"; 241: "Mini Aux Camera"; 243: "Zoom Camera TO"; 5: "DT Camera" } = ...

    Type declaration

    • 206: "4K UHD Camera"
    • 207: "Zoom Camera JZC"
    • 240: "Zoom Camera H"
    • 241: "Mini Aux Camera"
    • 243: "Zoom Camera TO"
    • 5: "DT Camera"
    CAMERA_HEAD_DEVICE_MODELS: readonly [A150CameraHead, A200CameraHead, RevolutionCameraHead, PivotCameraHead] = ...
    CAMERA_HEAD_DEVICE_MODEL_LABELS: { 102: "REVOLUTION Camera Head"; 103: "PIVOT Camera Head"; 106: "A-200 Camera Head"; 109: "A-150 Camera Head" } = ...

    Type declaration

    • 102: "REVOLUTION Camera Head"
    • 103: "PIVOT Camera Head"
    • 106: "A-200 Camera Head"
    • 109: "A-150 Camera Head"
    CRAWLER_CAMERAHEAD_JOINT2_POSITION_MAX: 140 = 140

    Camera head joint 2 maximum rotation limit in degrees

    Useful for front-end client to constrain UI limits of joint 2 position

    CRAWLER_CAMERAHEAD_JOINT2_POSITION_MIN: -140 = -140

    Camera head joint 2 minimum rotation limit in degrees

    Useful for front-end client to constrain UI limits of joint 2 position

    CRAWLER_DEVICE_MODELS: readonly [A150Crawler, A200Crawler] = ...
    DEFAULT_REEL_BATTERY_VOLTAGE: 21 = 21
    DEVICE_MODEL_LABELS: { 102: "REVOLUTION Camera Head"; 103: "PIVOT Camera Head"; 106: "A-200 Camera Head"; 107: "Tether Reel"; 108: "Powered Tether Reel"; 109: "A-150 Camera Head"; 13: "REVOLUTION"; 18: "PIVOT"; 19: "A-200"; 20: "A-150"; 206: "4K UHD Camera"; 207: "Zoom Camera JZC"; 240: "Zoom Camera H"; 241: "Mini Aux Camera"; 243: "Zoom Camera TO"; 5: "DT Camera"; BRIDGEBOX: "BridgeBox" } = ...

    Type declaration

    • 102: "REVOLUTION Camera Head"
    • 103: "PIVOT Camera Head"
    • 106: "A-200 Camera Head"
    • 107: "Tether Reel"
    • 108: "Powered Tether Reel"
    • 109: "A-150 Camera Head"
    • 13: "REVOLUTION"
    • 18: "PIVOT"
    • 19: "A-200"
    • 20: "A-150"
    • 206: "4K UHD Camera"
    • 207: "Zoom Camera JZC"
    • 240: "Zoom Camera H"
    • 241: "Mini Aux Camera"
    • 243: "Zoom Camera TO"
    • 5: "DT Camera"
    • BRIDGEBOX: "BridgeBox"
    ERROR_MESSAGES: Readonly<Record<ErrorCode, string>> = ...

    Error messages

    POSITION_UNCERTAINTY_LIMIT: 10000 = 10000

    Position uncertainty limit.

    description

    The upper bound for valid position uncertainty. Note that the uncertainty value can be arbitrarily large; therefore, a limit is set to ignore invalid positions.

    REEL_DEVICE_MODELS: readonly [ManualReel, PoweredReel] = ...
    REEL_DEVICE_MODEL_LABELS: { 107: "Tether Reel"; 108: "Powered Tether Reel" } = ...

    Type declaration

    • 107: "Tether Reel"
    • 108: "Powered Tether Reel"
    SCREEN_RESOLUTIONS: Readonly<Record<ScreenResolution, Resolution>> = ...
    VEHICLE_DEVICE_MODELS: readonly [A150Crawler, A200Crawler, Revolution, Pivot] = ...
    VEHICLE_DEVICE_MODEL_LABELS: { 13: "REVOLUTION"; 18: "PIVOT"; 19: "A-200"; 20: "A-150" } = ...

    Type declaration

    • 13: "REVOLUTION"
    • 18: "PIVOT"
    • 19: "A-200"
    • 20: "A-150"

    SignalServer Variables

    IRegisterSession: RegisterSession = ""

    RegisterSession

    Creates a new session using a unique vehicle id.

    Note 💡 Ensure the number-like property values are sent as strings when sent and are enclosed in quotes ""

    notexported

    See type declaration

    protocol

    wss | https

    endpoint

    /register_session

    From ./dist/samples/json/server/registerSession.json

    {
    "0": "f",
    "1": "8",
    "2": "5",
    "3": "e",
    "4": "9",
    "5": "a",
    "6": "a",
    "7": "2",
    "8": "-",
    "9": "0",
    "10": "6",
    "11": "4",
    "12": "8",
    "13": "-",
    "14": "4",
    "15": "5",
    "16": "3",
    "17": "b",
    "18": "-",
    "19": "9",
    "20": "f",
    "21": "a",
    "22": "d",
    "23": "-",
    "24": "f",
    "25": "f",
    "26": "1",
    "27": "2",
    "28": "4",
    "29": "e",
    "30": "b",
    "31": "d",
    "32": "7",
    "33": "0",
    "34": "a",
    "35": "d",
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json"
    }