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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"242A2039DB43": {
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"B55D9608C29B": {
"model": 108,
"battery1": {
"voltage": 88,
"percent": 19,
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"AEF6A9123898": {
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"9C5DBF8F3019": {
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"6F6DB0DD87D4": {
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"C04E4D4D3F7D": {
"model": 108,
"battery2": {
"voltage": 84,
"percent": 53,
"charging": false
}
}
}
}
}

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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"F4ACB33574CD": {
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"94C06423D059": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"59BC142C82F1": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"E95B08C43883": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"50050C7116CF": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"77A56145CC70": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"FE7A5E006D1D": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"43C7784DE1A1": {
"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
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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"CFF801C3B2B6": {
"model": 108,
"motor1Diagnostics": {
"current": 57,
"overcurrent": true,
"pwm": 93,
"rpm": -66,
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"FB72FEC13A28": {
"model": 108,
"motor1Diagnostics": {
"current": 5,
"overcurrent": false,
"pwm": 2,
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"0D0C673CAC99": {
"model": 108,
"motor2Diagnostics": {
"current": 74,
"overcurrent": false,
"pwm": 73,
"rpm": 7,
"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.55.3",
"method": "UPDATE",
"payload": {
"devices": {
"2DE3CDF88446": {
"model": 108,
"motor2Diagnostics": {
"current": 10,
"overcurrent": false,
"pwm": 4,
"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

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.55.3",
"method": "SET",
"payload": {
"devices": {
"658867041998": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"AD6ED35F9592": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"0456A91D078E": {
"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.55.3",
"method": "SET",
"payload": {
"devices": {
"799498598882": {
"model": 108,
"totalDistance": 25254
}
}
}
}
version?: DeviceVersion

Version