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.12",
"method": "UPDATE",
"payload": {
"devices": {
"93423C091A54": {
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"D82FBF6157AA": {
"model": 108,
"battery1": {
"voltage": 71,
"percent": 80,
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"3C77AD555072": {
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"FDE822F434A6": {
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"481DACF8AD83": {
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"BF24DEA840B8": {
"model": 108,
"battery2": {
"voltage": 25,
"percent": 41,
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"100B39A1D018": {
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"E88B086AA1E9": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"EB66A4B7F75E": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"F2BBA31821B1": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"BFC7BEF649DB": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"74A606D1BF58": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"520369B4B095": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"5C84D76596FC": {
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"409D4A4F3EEC": {
"model": 108,
"motor1Diagnostics": {
"current": 55,
"overcurrent": false,
"pwm": 16,
"rpm": -53,
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"2D46C0DD4819": {
"model": 108,
"motor1Diagnostics": {
"current": 2,
"overcurrent": false,
"pwm": 1,
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"12A20994D144": {
"model": 108,
"motor2Diagnostics": {
"current": 18,
"overcurrent": true,
"pwm": 10,
"rpm": 17,
"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.12",
"method": "UPDATE",
"payload": {
"devices": {
"9287AE3CB088": {
"model": 108,
"motor2Diagnostics": {
"current": 7,
"overcurrent": false,
"pwm": 0,
"rpm": 1,
"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.12",
"method": "SET",
"payload": {
"devices": {
"1C4DF4714FC6": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"D49BA7FCB3FD": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"1057A12EB4D8": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"ABF91F4DA29C": {
"model": 108,
"stalled": false
}
}
}
}

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.12",
"method": "SET",
"payload": {
"devices": {
"4ECAA194DDA9": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"9B68F5F90A3B": {
"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.12",
"method": "SET",
"payload": {
"devices": {
"089986FD65E5": {
"model": 108,
"totalDistance": 76473
}
}
}
}
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.12",
"method": "UPDATE",
"payload": {
"devices": {
"65D94565E991": {
"model": 108,
"usageTime": {
"totalSeconds": 62021,
"currentSeconds": 61824
}
}
}
}
}
version?: DeviceVersion

Version