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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"4A2508DF8BC7": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"84363E888713": {
"model": 108,
"battery1": {
"voltage": 50,
"percent": 30,
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"355F3C57E039": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"E8D4F9CBA412": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"7FBC63FACB60": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"83B98A31B4B8": {
"model": 108,
"battery2": {
"voltage": 23,
"percent": 31,
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"3EF43A36713A": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"6B1D4D4D5109": {
"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

Tether distance

description

payed out tether distance, given in cm. This can be overwritten to set a value from the UI.

readonly
eStop?: boolean

Physical Button States

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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"6BEF8ADE25BB": {
"model": 108,
"motor1Diagnostics": {
"current": 30,
"overcurrent": true,
"pwm": 25,
"rpm": 25
}
}
}
}
}

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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"3FC9396F4D81": {
"model": 108,
"motor1Diagnostics": {
"current": 3,
"overcurrent": false,
"pwm": 4,
"rpm": -1
}
}
}
}
}
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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"2A941D0BA99D": {
"model": 108,
"motor2Diagnostics": {
"current": 37,
"overcurrent": true,
"pwm": 12,
"rpm": -51
}
}
}
}
}

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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"BBC4DDCB4133": {
"model": 108,
"motor2Diagnostics": {
"current": 0,
"overcurrent": false,
"pwm": 3,
"rpm": 0
}
}
}
}
}
reelForward?: boolean
reelReverse?: boolean
speed?: number

Reel Drive Speed

description

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

minimum

-100

maximum

100

version?: DeviceVersion

Version