Options
All
  • Public
  • Public/Protected
  • All
Menu
notexported

See type declaration

Manual Reel

Hierarchy

Index

Properties

calibrator?: boolean

Calibrator

Calibrator Front-end (request) Back-end (response)
true Calibrate -
false Cancel Calibration -
undefined - -
cpuTemp?: number

Reel CPU Temperature

Measured in degrees celsius

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',

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.56.4",
"method": "SET",
"payload": {
"devices": {
"750262C24C1D": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"FC8CBFCEF982": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"B93B131789CB": {
"model": 108,
"encoderFailed": false
}
}
}
}
ip?: string

IP address

leak?: boolean

Leak Detection

readonly
model: ManualReel
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.56.4",
"method": "SET",
"payload": {
"devices": {
"59299FD0F1C2": {
"model": 108,
"totalDistance": 94637
}
}
}
}
version?: DeviceVersion

Version