IDT645 | Deep Trekker BRIDGE API

notexported

See type declaration

DT645 Utility Crawler

Hierarchy

DT645
- IDT645

Index

Properties

Optional autoSnapshot

autoSnapshot?: { session?: { active?: boolean; cameras?: string; interval?: SnapshotIntervals } }

Type declaration

Optional session?: { active?: boolean; cameras?: string; interval?: SnapshotIntervals }
- Optional active?: boolean
- Optional cameras?: string
- Optional interval?: SnapshotIntervals

Optional bodyLeak

bodyLeak?: boolean

Body Leak Fault

Indicates detection of water leakage within the DT645 Utility Crawler's main body compartment.

Example Payloads

UPDATE Requests

No body leak

From ./dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645HasNoBodyLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2A9B38339F87": {
                "model": 22,
                "bodyLeak": false
            }
        }
    }
}

Body leak present

From ./dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645HasBodyLeakSample.json

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

Arbitrary

From ./dist/samples/json/requests/devices/vehicles/dt645/bodyLeak/dt645BodyLeakRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2CD3094D9359": {
                "model": 22,
                "bodyLeak": true
            }
        }
    }
}

Optional cameraHead

cameraHead?: Removable<A150CameraHead>

Camera Head

The rotating part of the camera that controls its pan and tilt orientation.

Example Payloads

DELETE 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.60.5",
    "method": "DELETE",
    "payload": {
        "devices": {
            "8FF7A53C988F": {
                "model": 20,
                "cameraHead": {}
            }
        }
    }
}

Optional cameras

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

📷 List of cameras

Holds a list of all vehicle Cameras.

Optional cpProbe

cpProbe?: string

The cp probe

Optional cygnus

cygnus?: cygnusType

The ut(cygnus) probe

Optional depth

depth?: number

Depth

Measures the depth of DT645 Utility Crawler (in meters) from water surface

To Calibrate depth, set depth to '0'. Setting depth to any other value will be ignored.

Valid Depth calibration

From ./dist/samples/json/requests/devices/vehicles/dt645/depth/dt645ValidDepthCalibrationSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "043688040DD6": {
                "model": 22,
                "depth": 0
            }
        }
    }
}

Invalid Depth Calibration

From ./dist/samples/json/requests/devices/vehicles/dt645/depth/dt645InvalidDepthCalibrationSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "5B8C7F3B3CE2": {
                "model": 22,
                "depth": 53
            }
        }
    }
}

readonly

Optional drive

drive?: DT645Drive

Drive Controls

Controls the direction of drive for the Dt645 Utility Crawler.

Example Payloads

SET Requests

Arbitrary Values

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "6B40A041AF5E": {
                "model": 22,
                "drive": {
                    "speed": -2,
                    "steer": 6,
                    "motorsDisabled": false
                }
            }
        }
    }
}

Random Speed

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSpeedRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "1A64826D30FB": {
                "model": 22,
                "drive": {
                    "speed": -93
                }
            }
        }
    }
}

Max Speed Forward Speed

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMaxSpeedForwardSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "8511C42FA0D3": {
                "model": 22,
                "drive": {
                    "speed": 100
                }
            }
        }
    }
}

Max Speed Backward Speed

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMaxSpeedBackwardSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "9E8B6520CF0D": {
                "model": 22,
                "drive": {
                    "speed": -100
                }
            }
        }
    }
}

Stop Motor

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveMotorStopSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "B60D23098875": {
                "model": 22,
                "drive": {
                    "speed": 0
                }
            }
        }
    }
}

Random Steer

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "7D0C5E059068": {
                "model": 22,
                "drive": {
                    "steer": 67
                }
            }
        }
    }
}

Steer Left

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerLeftSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "5A732F665488": {
                "model": 22,
                "drive": {
                    "steer": -100
                }
            }
        }
    }
}

Steer Right

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerRightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "6A62A5FEF59F": {
                "model": 22,
                "drive": {
                    "steer": 100
                }
            }
        }
    }
}

Stop Steer

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645DriveSteerStopSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "09733075E4C8": {
                "model": 22,
                "drive": {
                    "steer": 0
                }
            }
        }
    }
}

Motors Disabled

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645MotorsDisabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "890FFD57F542": {
                "model": 22,
                "drive": {
                    "motorsDisabled": true
                }
            }
        }
    }
}

Motors Enabled

From ./dist/samples/json/requests/devices/vehicles/dt645/drive/dt645MotorsEnabledSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "SET",
    "payload": {
        "devices": {
            "97FE0B6FDBDB": {
                "model": 22,
                "drive": {
                    "motorsDisabled": false
                }
            }
        }
    }
}

Optional heading

heading?: number

Heading

The direction that the DT645 Utility Crawler is facing. Measured in degrees from north bearing.

Random Heading

From ./dist/samples/json/requests/devices/vehicles/dt645/heading/dt645HeadingRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "694FC70325E2": {
                "model": 22,
                "heading": 283
            }
        }
    }
}

minimum: 0
maximum: 360
readonly

Optional incline

incline?: number

Incline

The angle at which the DT645 Utility Crawler is positioned relative to a flat surface.

Random Incline

From ./dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "07CB9B4F498A": {
                "model": 22,
                "incline": -176
            }
        }
    }
}

Min Incline

From ./dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineMinSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "3E49C805F495": {
                "model": 22,
                "incline": -180
            }
        }
    }
}

Max Incline

From ./dist/samples/json/requests/devices/vehicles/dt645/incline/dt645InclineMaxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "8ECD71FF27E3": {
                "model": 22,
                "incline": 180
            }
        }
    }
}

minimum: -180.0
maximum: 180.0

Optional ip

ip?: string

IP address

model

model: DT645

Optional pitch

pitch?: number

Pitch

Measured in degrees from the neutral pitch position.

Random Pitch

From ./dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "D442E3069780": {
                "model": 22,
                "pitch": -5
            }
        }
    }
}

Min Pitch

From ./dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchMinSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "270B40A601BE": {
                "model": 22,
                "pitch": -180
            }
        }
    }
}

Max Pitch

From ./dist/samples/json/requests/devices/vehicles/dt645/pitch/dt645PitchMaxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "FF281AA825D4": {
                "model": 22,
                "pitch": 180
            }
        }
    }
}

minimum: -180.0
maximum: 180.0
minimum: -180.0
maximum: 180.0
readonly

Optional roll

roll?: number

Roll

Rotation of the DT645 Utility Crawler around its front-to-back (longitudinal) axis.

Random Roll

From ./dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "A6F33FF519AB": {
                "model": 22,
                "roll": 89
            }
        }
    }
}

Min Roll

From ./dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollMinSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "5F3786237E5F": {
                "model": 22,
                "roll": -180
            }
        }
    }
}

Max Roll

From ./dist/samples/json/requests/devices/vehicles/dt645/roll/dt645RollMaxSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "GET",
    "payload": {
        "devices": {
            "017D7E8731D7": {
                "model": 22,
                "roll": 180
            }
        }
    }
}

minimum: -180.0
maximum: 180.0

Optional usageTime

usageTime?: UsageTime

Usage Time

Example Payloads

GET Requests

Current seconds

From ./dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645CurrentSecondsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "349282878ACC": {
                "model": 22,
                "usageTime": {
                    "currentSeconds": 49
                }
            }
        }
    }
}

Total Seconds

From ./dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645TotalSecondsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "730ADE97786E": {
                "model": 22,
                "usageTime": {
                    "totalSeconds": 100
                }
            }
        }
    }
}

Arbitrary Total Usage

From ./dist/samples/json/requests/devices/vehicles/dt645/usageTime/dt645UsageTimeRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.60.5",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "0FF6152D6E9B": {
                "model": 22,
                "usageTime": {
                    "totalSeconds": 3,
                    "currentSeconds": 71
                }
            }
        }
    }
}

Optional version

version?: DeviceVersion

Version

Hierarchy

Index

Properties

Properties

Optional autoSnapshot

Type declaration

Optional session?: { active?: boolean; cameras?: string; interval?: SnapshotIntervals }

Optional active?: boolean

Optional cameras?: string

Optional interval?: SnapshotIntervals

Optional bodyLeak

Example Payloads

UPDATE Requests

Optional cameraHead

Example Payloads

DELETE Requests

Optional cameras

Optional cpProbe

Optional cygnus

Optional depth

Optional drive

Example Payloads

SET Requests

Optional heading

Optional incline

Optional ip

model

Optional pitch

Optional roll

Optional usageTime

Example Payloads

GET Requests

Optional version