Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IElevatingArm

notexported

See type declaration

🦾 Elevating arm

Hierarchy

Index

Properties

Properties

Optional calibrator

calibrator?: boolean

Calibrator

Calibrator Front-end (request) Back-end (response)
true Calibrate -
false Cancel Calibration -
undefined - -

Optional height

height?: number

Elevating Arm Height

description

Elevating arm height in percentage of total range

Example Payload

A200 at Maximum Height

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmMaxHeightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "E4508FD734AF": {
                "model": 19,
                "elevatingArm": {
                    "height": 100
                }
            }
        }
    }
}

A200 at Minimum Height

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmMinHeightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "F93519C1EFEE": {
                "model": 19,
                "elevatingArm": {
                    "height": 0
                }
            }
        }
    }
}

A150 at Maximum Height

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmMaxHeightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "D57F160F1558": {
                "model": 20,
                "elevatingArm": {
                    "height": 100
                }
            }
        }
    }
}

A150 at Minimum Height

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmMinHeightSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "01C6E8C0D6FC": {
                "model": 20,
                "elevatingArm": {
                    "height": 0
                }
            }
        }
    }
}
minimum

0

maximum

100

Optional leak

leak?: boolean

Leak Fault

readonly

Example Payload

A200 at Leak True

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmHasLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "E7BFBAF1D4C8": {
                "model": 19,
                "elevatingArm": {
                    "leak": true
                }
            }
        }
    }
}

A200 at Leak False

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmHasNoLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "5666B98782D0": {
                "model": 19,
                "elevatingArm": {
                    "leak": false
                }
            }
        }
    }
}

A150 at Leak True

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmHasLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "DA20E4B1699D": {
                "model": 20,
                "elevatingArm": {
                    "leak": true
                }
            }
        }
    }
}

A150 at Leak False

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmHasNoLeakSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "1396A4737E9B": {
                "model": 20,
                "elevatingArm": {
                    "leak": false
                }
            }
        }
    }
}

Optional motorDiagnostics

motorDiagnostics?: MotorDiagnostics

Motor Diagnostics

These are the motor diagnostics of the elevating arm.

Example Payload
UPDATE Requests
  • A200 at random current

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsRandomCurrentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "61177EB1D780": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 22
                    }
                }
            }
        }
    }
}
  • A200 at random PWM

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsRandomPwmSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2EA710C95AFF": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 4
                    }
                }
            }
        }
    }
}
  • A200 at random current

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsRandomCurrentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "61177EB1D780": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 22
                    }
                }
            }
        }
    }
}
  • A200 at overcurrent

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsHasOvercurrentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D06FE4F16AE4": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "overcurrent": true
                    }
                }
            }
        }
    }
}
  • A200 at no overcurrent

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsHasNoOvercurrentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "33A37A73D4B3": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "overcurrent": false
                    }
                }
            }
        }
    }
}
  • A200 at static rpm

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsStaticRpmSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7337EA3ECFD6": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "rpm": 0
                    }
                }
            }
        }
    }
}
  • A200 at forward rpm

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsForwardRpmSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3BF65C43461C": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "rpm": 10
                    }
                }
            }
        }
    }
}
  • A200 at backward rpm

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsBackwardRpmSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7AF133A8AFD3": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 35
                    }
                }
            }
        }
    }
}
  • A200 at all random

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/motorDiagnostics/a200ElevatingArmMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DFD420185F4F": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 85,
                        "pwm": 72,
                        "overcurrent": false,
                        "rpm": 4
                    }
                }
            }
        }
    }
}
  • A150 at random current

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsRandomCurrentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E3207D0AEF39": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 60
                    }
                }
            }
        }
    }
}
  • A150 at random PWM

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsRandomPwmSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A6E6E412DF90": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 79
                    }
                }
            }
        }
    }
}
  • A150 at random current

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsRandomCurrentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E3207D0AEF39": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 60
                    }
                }
            }
        }
    }
}
  • A150 at overcurrent

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsHasOvercurrentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "24D46C13FBFF": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "overcurrent": true
                    }
                }
            }
        }
    }
}
  • A150 at no overcurrent

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsHasNoOvercurrentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "660A01A99224": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "overcurrent": false
                    }
                }
            }
        }
    }
}
  • A150 at static rpm

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsStaticRpmSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3BA2AAF9798F": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "rpm": 0
                    }
                }
            }
        }
    }
}
  • A150 at forward rpm

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsForwardRpmSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "FF41B9111688": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "rpm": 10
                    }
                }
            }
        }
    }
}
  • A150 at backward rpm

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsBackwardRpmSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "3D065BAB8829": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 97
                    }
                }
            }
        }
    }
}
  • A150 at all random

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/motorDiagnostics/a150ElevatingArmMotorDiagnosticsRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DA08CC6391D1": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 40,
                        "pwm": 48,
                        "overcurrent": false,
                        "rpm": -3
                    }
                }
            }
        }
    }
}

Optional parkOnShutdown

parkOnShutdown?: boolean

Park on shutdown - if set to true, the elevating arm will be fully lowered on shutdown

Optional present

present?: boolean

Elevating Arm Presence

Example Payload

A200 at Not Present

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmNotPresentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "6CA99DA9CCA5": {
                "model": 19,
                "elevatingArm": {
                    "present": false
                }
            }
        }
    }
}

A200 at Present

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "03424A8309F3": {
                "model": 19,
                "elevatingArm": {
                    "present": true,
                    "height": 78,
                    "speed": 14,
                    "leak": false
                }
            }
        }
    }
}

A150 at Not Present

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmNotPresentSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "D3E5C7BCF06B": {
                "model": 20,
                "elevatingArm": {
                    "present": false
                }
            }
        }
    }
}

A150 at Present

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmRandomSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "3BEE8F25C5A8": {
                "model": 20,
                "elevatingArm": {
                    "present": true,
                    "height": 84,
                    "speed": 65,
                    "leak": false
                }
            }
        }
    }
}

Optional speed

speed?: number

Elevating Arm Speed

Example Payload

A200 at Maximum Speed

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmForwardMaxSpeedSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "D381C09D9F01": {
                "model": 19,
                "elevatingArm": {
                    "speed": 100
                }
            }
        }
    }
}

A200 at Minimum Speed

From ./dist/samples/json/requests/devices/vehicles/a200/peripherals/elevatingArm/a200ElevatingArmBackwardMaxSpeedSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "F0A808BA4F43": {
                "model": 19,
                "elevatingArm": {
                    "speed": -100
                }
            }
        }
    }
}

A150 at Maximum Speed

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmForwardMaxSpeedSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "1FF453AF89E0": {
                "model": 20,
                "elevatingArm": {
                    "speed": 100
                }
            }
        }
    }
}

A150 at Minimum Speed

From ./dist/samples/json/requests/devices/vehicles/a150/peripherals/elevatingArm/a150ElevatingArmBackwardMaxSpeedSample.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.59.0",
    "method": "SET",
    "payload": {
        "devices": {
            "A02C2D96B16E": {
                "model": 20,
                "elevatingArm": {
                    "speed": -100
                }
            }
        }
    }
}
minimum

-100

maximum

100