IManualReel | Deep Trekker BRIDGE API

notexported

See type declaration

Manual Reel

Hierarchy

ManualReel
- IManualReel

Index

Properties

Optional calibrator

calibrator?: boolean

Calibrator

Calibrator	Front-end (request)	Back-end (response)
`true`	Calibrate	-
`false`	Cancel Calibration	-
`undefined`	-	-

Optional cpuTemp

cpuTemp?: number

Reel CPU Temperature

Measured in degrees celsius

Optional distance

distance?: number

Section tether distance

description: relative payed out tether distance, given in cm. This can be overwritten to set a value from the UI. This is used to keep track of the relative payed out tether, which is different from 'totalDistance',

Optional encoderFailed

encoderFailed?: boolean

Encoder failure detection

readonly

Reel encoder failed random sample

From ./dist/samples/json/requests/devices/reels/poweredReels/encoderFailed/poweredReelEncoderFailedRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "9AE71DE99A73": {
                "model": 108,
                "encoderFailed": true
            }
        }
    }
}

Reel encoder failed sample

From ./dist/samples/json/requests/devices/reels/poweredReels/encoderFailed/poweredReelHasEncoderFailedSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "C021DFA16F09": {
                "model": 108,
                "encoderFailed": true
            }
        }
    }
}

Reel encoder not failed sample

From ./dist/samples/json/requests/devices/reels/poweredReels/encoderFailed/poweredReelHasNoEncoderFailedSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "635169196C30": {
                "model": 108,
                "encoderFailed": false
            }
        }
    }
}

Optional ip

ip?: string

IP address

Optional leak

leak?: boolean

Leak Detection

readonly

Optional lineSpeed

lineSpeed?: number

The reel line speed in m/min

readonly

model

model: ManualReel

Optional totalDistance

totalDistance?: number

Total tether distance

description

total payed out tether distance, given in cm. This can be overwritten to set a value from the UI. This is used to keep track of the total payed out tether distance even after having reset the 'distance' property.

Reel total distance random sample

From ./dist/samples/json/requests/devices/reels/poweredReels/totalDistance/poweredReelTotalDistanceRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {
        "devices": {
            "D04E9194D0A5": {
                "model": 108,
                "totalDistance": 3637
            }
        }
    }
}

Optional version

version?: DeviceVersion

Version