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

See type declaration

Powered Reel

summary

Reel

Hierarchy

Index

Properties

acConnected?: boolean

AC Connected

description

Represents whether AC power cable is connected or not.

battery1?: Battery

Powered Reel Batteries 1

Example Payload

Reel Battery Danger State Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/battery/battery1/poweredReelBattery1DangerSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"9D6E1F07C45B": {
"model": 108,
"battery1": {
"percent": 15
}
}
}
}
}

Reel Battery Random State Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/battery/battery1/poweredReelBattery1RandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"A3C117A6008A": {
"model": 108,
"battery1": {
"voltage": 53,
"percent": 34,
"charging": true
}
}
}
}
}

Reel Battery Shutdown State Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/battery/battery1/poweredReelBattery1ShutdownSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"B616B4CFA772": {
"model": 108,
"battery1": {
"percent": 3
}
}
}
}
}

Reel Battery Warning State Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/battery/battery1/poweredReelBattery1WarningSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"A873543D3B34": {
"model": 108,
"battery1": {
"percent": 30
}
}
}
}
}
battery2?: Battery

Powered Reel Batteries 2

Example Payload

Reel Battery Danger State Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/battery/battery2/poweredReelBattery2DangerSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"78B29AB88B9A": {
"model": 108,
"battery2": {
"percent": 15
}
}
}
}
}

Reel Battery Random State Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/battery/battery2/poweredReelBattery2RandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"654B225B75FD": {
"model": 108,
"battery2": {
"voltage": 81,
"percent": 47,
"charging": true
}
}
}
}
}

Reel Battery Shutdown State Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/battery/battery2/poweredReelBattery2ShutdownSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"C5BDA468547F": {
"model": 108,
"battery2": {
"percent": 3
}
}
}
}
}

Reel Battery Warning State Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/battery/battery2/poweredReelBattery2WarningSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"956690FEF967": {
"model": 108,
"battery2": {
"percent": 30
}
}
}
}
}
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

crawlerForward?: boolean
crawlerReverse?: boolean
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',

eStop?: boolean

Physical Button States

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.15",
"method": "SET",
"payload": {
"devices": {
"17470516E8E6": {
"model": 108,
"encoderFailed": false
}
}
}
}

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.15",
"method": "SET",
"payload": {
"devices": {
"37674CB9D5C3": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"4F61A5A55ACB": {
"model": 108,
"encoderFailed": false
}
}
}
}
encoderMiscalibrated?: boolean

Encoder miscalibration detection

readonly

Reel encoder miscalibrated random sample

From ./dist/samples/json/requests/devices/reels/poweredReels/encoderMiscalibrated/poweredReelEncoderMiscalibratedRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"28BF813E3C70": {
"model": 108,
"encoderMiscalibrated": false
}
}
}
}

Reel encoder miscalibrated sample

From ./dist/samples/json/requests/devices/reels/poweredReels/encoderMiscalibrated/poweredReelHasEncoderMiscalibratedSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"6DDCC31A4361": {
"model": 108,
"encoderMiscalibrated": true
}
}
}
}

Reel encoder not miscalibrated sample

From ./dist/samples/json/requests/devices/reels/poweredReels/encoderMiscalibrated/poweredReelHasNoEncoderMiscalibratedSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"EB0E64AF1A35": {
"model": 108,
"encoderMiscalibrated": false
}
}
}
}
hybridPower?: boolean

Hybrid Power Enabled

description

Represents the actual state of whether power is enabled or not.

ip?: string

IP address

leak?: boolean

Leak Detection

readonly
lineSpeed?: number

The reel line speed in m/min

readonly
motor1Diagnostics?: MotorDiagnostics

Motor 1 Diagnostics

Powered Reel Motor 1 Random Motor Diagnostics Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/motorDiagnostics/motor1/poweredReelMotor1DiagnosticsRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"F8797A17DC84": {
"model": 108,
"motor1Diagnostics": {
"current": 25,
"overcurrent": false,
"pwm": 38,
"rpm": -60,
"failure": false
}
}
}
}
}

Powered Reel Motor 1 Resting Motor Diagnostics Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/motorDiagnostics/motor1/poweredReelMotor1DiagnosticsRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"7EE9F70BB5E9": {
"model": 108,
"motor1Diagnostics": {
"current": 4,
"overcurrent": false,
"pwm": 4,
"rpm": -1,
"failure": false
}
}
}
}
}
motor2Diagnostics?: MotorDiagnostics

Motor 2 Diagnostics

Powered Reel Motor 2 Random Motor Diagnostics Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/motorDiagnostics/motor2/poweredReelMotor2DiagnosticsRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"3862CD53F1BF": {
"model": 108,
"motor2Diagnostics": {
"current": 14,
"overcurrent": false,
"pwm": 80,
"rpm": 8,
"failure": false
}
}
}
}
}

Powered Reel Motor 2 Resting Motor Diagnostics Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/motorDiagnostics/motor2/poweredReelMotor2DiagnosticsRestingSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"2E74D2AD029E": {
"model": 108,
"motor2Diagnostics": {
"current": 8,
"overcurrent": false,
"pwm": 5,
"rpm": 0,
"failure": false
}
}
}
}
}
reelForward?: boolean
reelReverse?: boolean
speed?: number

Reel Drive Speed

description

Negative values for reverse (retract), positive for forward (payout)

minimum

-120

maximum

120

spragBearing?: SpragBearing

Sprag Bearing

description

Represents the actual state of the sprag bearing.

Reel Sprag Bearing FKNN6204-2RS Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/spragBearing/poweredReelSpragBearingFKNN62042RSSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"BF5290B86839": {
"model": 108,
"spragBearing": "FKNN6204-2RS"
}
}
}
}

Reel Sprag Bearing FKNN6205-2RS Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/spragBearing/poweredReelSpragBearingFKNN62052RSSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"8FFC83A1FD9F": {
"model": 108,
"spragBearing": "FKNN6205-2RS"
}
}
}
}

Reel Sprag Bearing Random Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/spragBearing/poweredReelSpragBearingRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"DBB8DC8232BD": {
"model": 108,
"spragBearing": "FKNN6205-2RS"
}
}
}
}
stalled?: boolean

Reel stalled

readonly

Reel stalled random sample

From ./dist/samples/json/requests/devices/reels/poweredReels/stalled/poweredReelStalledRandomSample.json

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

Reel stalled sample

From ./dist/samples/json/requests/devices/reels/poweredReels/stalled/poweredReelHasStalledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"6F4754403AAE": {
"model": 108,
"stalled": true
}
}
}
}

Reel not stalled sample

From ./dist/samples/json/requests/devices/reels/poweredReels/stalled/poweredReelHasNoStalledSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "SET",
"payload": {
"devices": {
"90B9F905A601": {
"model": 108,
"stalled": false
}
}
}
}
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.15",
"method": "SET",
"payload": {
"devices": {
"39AB5AA9E37C": {
"model": 108,
"totalDistance": 95689
}
}
}
}
usageTime?: UsageTime

Usage Time

description

Represents the current running and lifetime usage of the device.

readonly

Powered Reel Random Usage Time Sample

From ./dist/samples/json/requests/devices/reels/poweredReels/usageTime/poweredReelUsageTimeRandomSample.json

{
"$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
"apiVersion": "0.58.15",
"method": "UPDATE",
"payload": {
"devices": {
"A84F86692DEE": {
"model": 108,
"usageTime": {
"totalSeconds": 18253,
"currentSeconds": 94700
}
}
}
}
}
version?: DeviceVersion

Version