Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPoweredReel

notexported

See type declaration

Powered Reel

summary

Reel

Hierarchy

Index

Properties

Properties

Optional acConnected

acConnected?: boolean

AC Connected

description

Represents whether AC power cable is connected or not.

Optional battery1

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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A7EC31B106C9": {
                "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "09E9835769F8": {
                "model": 108,
                "battery1": {
                    "voltage": 37,
                    "percent": 74,
                    "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "07D948308D63": {
                "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3324B6CDAE8B": {
                "model": 108,
                "battery1": {
                    "percent": 30
                }
            }
        }
    }
}

Optional battery2

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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F56FCED560C1": {
                "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6B8D600D2621": {
                "model": 108,
                "battery2": {
                    "voltage": 62,
                    "percent": 64,
                    "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.58.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B75C3E489BEC": {
                "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F83CBD0811C2": {
                "model": 108,
                "battery2": {
                    "percent": 30
                }
            }
        }
    }
}

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 crawlerForward

crawlerForward?: boolean

Optional crawlerReverse

crawlerReverse?: boolean

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 eStop

eStop?: boolean

Physical Button States

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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "DC697E20032C": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "3B0F19C60A3D": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "8C018F028998": {
                "model": 108,
                "encoderFailed": false
            }
        }
    }
}

Optional encoderMiscalibrated

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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "0CDB9101FB0E": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "1062A40EBC87": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "259F88708F1A": {
                "model": 108,
                "encoderMiscalibrated": false
            }
        }
    }
}

Optional hybridPower

hybridPower?: boolean

Hybrid Power Enabled

description

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

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: PoweredReel

Optional motor1Diagnostics

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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "1139FD37CC01": {
                "model": 108,
                "motor1Diagnostics": {
                    "current": 29,
                    "overcurrent": true,
                    "pwm": 83,
                    "rpm": 100,
                    "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3803CB45D899": {
                "model": 108,
                "motor1Diagnostics": {
                    "current": 10,
                    "overcurrent": false,
                    "pwm": 5,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Optional motor2Diagnostics

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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9CE7B4474CA8": {
                "model": 108,
                "motor2Diagnostics": {
                    "current": 9,
                    "overcurrent": false,
                    "pwm": 38,
                    "rpm": -46,
                    "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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C2C5CD356C9D": {
                "model": 108,
                "motor2Diagnostics": {
                    "current": 10,
                    "overcurrent": false,
                    "pwm": 2,
                    "rpm": -1,
                    "failure": false
                }
            }
        }
    }
}

Optional reelForward

reelForward?: boolean

Optional reelReverse

reelReverse?: boolean

Optional speed

speed?: number

Reel Drive Speed

description

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

minimum

-120

maximum

120

Optional spragBearing

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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "A4F49CC0B636": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "F09D0A683EC6": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "7D65E70EE19B": {
                "model": 108,
                "spragBearing": "FKNN6204-2RS"
            }
        }
    }
}

Optional stalled

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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "F878F0DF2785": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "4224EFFBD6E8": {
                "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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "8CC4D620148A": {
                "model": 108,
                "stalled": false
            }
        }
    }
}

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.14",
    "method": "SET",
    "payload": {
        "devices": {
            "C91452F21B9A": {
                "model": 108,
                "totalDistance": 74335
            }
        }
    }
}

Optional usageTime

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.14",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3DEDD8B4F34E": {
                "model": 108,
                "usageTime": {
                    "totalSeconds": 51322,
                    "currentSeconds": 10513
                }
            }
        }
    }
}

Optional version

version?: DeviceVersion

Version