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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "969F549DE188": {
                "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BD8F61DADF29": {
                "model": 108,
                "battery1": {
                    "voltage": 42,
                    "percent": 81,
                    "charging": false
                }
            }
        }
    }
}

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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "73916A454888": {
                "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "937641E9C354": {
                "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C3114AED3947": {
                "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B827EA4A8D0F": {
                "model": 108,
                "battery2": {
                    "voltage": 42,
                    "percent": 84,
                    "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E5247F0FAE1B": {
                "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "662AD4A42EE4": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "0FFE9CED3D7E": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "2E3BB68E400C": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "EFA3029302C0": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "F3812C1B3257": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "D3A013EBC460": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "7162D2AC4330": {
                "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CF1440DD2C8F": {
                "model": 108,
                "motor1Diagnostics": {
                    "current": 31,
                    "overcurrent": false,
                    "pwm": 22,
                    "rpm": -44,
                    "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "82EF196A453B": {
                "model": 108,
                "motor1Diagnostics": {
                    "current": 1,
                    "overcurrent": false,
                    "pwm": 3,
                    "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "135F0FDD13AD": {
                "model": 108,
                "motor2Diagnostics": {
                    "current": 97,
                    "overcurrent": true,
                    "pwm": 74,
                    "rpm": -95,
                    "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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "83A0061CD8AF": {
                "model": 108,
                "motor2Diagnostics": {
                    "current": 10,
                    "overcurrent": false,
                    "pwm": 3,
                    "rpm": 0,
                    "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "33EAC5997DEF": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "6095EC1AD7F6": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "DFE36CF39020": {
                "model": 108,
                "spragBearing": "FKNN6205-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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "C9B48AB23847": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "CA22AFB77349": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "709A06EC9178": {
                "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.61.0",
    "method": "SET",
    "payload": {
        "devices": {
            "EA54C58C4812": {
                "model": 108,
                "totalDistance": 65044
            }
        }
    }
}

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.61.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "19E936C27426": {
                "model": 108,
                "usageTime": {
                    "totalSeconds": 71807,
                    "currentSeconds": 39867
                }
            }
        }
    }
}

Optional version

version?: DeviceVersion

Version