Options
All
  • Public
  • Public/Protected
  • All
Menu
notexported

See type declaration

🦾 Elevating arm

Hierarchy

Index

Properties

calibrator?: boolean

Calibrator

Calibrator Front-end (request) Back-end (response)
true Calibrate -
false Cancel Calibration -
undefined - -
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.58.14",
"method": "SET",
"payload": {
"devices": {
"EC81E95DA05C": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"F117D55B8AB7": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"A56A4DAD9505": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"6F9FEFEDAB6E": {
"model": 20,
"elevatingArm": {
"height": 0
}
}
}
}
}
minimum

0

maximum

100

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.58.14",
"method": "SET",
"payload": {
"devices": {
"55C82913F245": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"F1DF92E4AA8F": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"09030428B60C": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"F7CBF69C239A": {
"model": 20,
"elevatingArm": {
"leak": false
}
}
}
}
}
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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"3FB22AFB8E0C": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 71
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"C48883F9B2FE": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"pwm": 43
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"3FB22AFB8E0C": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 71
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"7107D38DD8FC": {
"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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"A73A3303841B": {
"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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"4B1DA2C0B70F": {
"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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"9DE2D9363D8C": {
"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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"16D0671C18EC": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 7
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"34E629E5282A": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 29,
"pwm": 39,
"overcurrent": false,
"rpm": -2
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"A36C42CC1D59": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 30
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"8F89A064347A": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"pwm": 99
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"A36C42CC1D59": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 30
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"40902F016EB3": {
"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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"6C459959F043": {
"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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"B1BA48C81BB3": {
"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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"2F8AFBEDE95F": {
"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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"C3636C338671": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 53
}
}
}
}
}
}
  • 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.58.14",
"method": "UPDATE",
"payload": {
"devices": {
"6602A70D65AE": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 54,
"pwm": 57,
"overcurrent": false,
"rpm": 10
}
}
}
}
}
}
parkOnShutdown?: boolean

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

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.58.14",
"method": "SET",
"payload": {
"devices": {
"58DA212F8528": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"F06941C5646C": {
"model": 19,
"elevatingArm": {
"present": true,
"height": -9,
"speed": -30,
"leak": true
}
}
}
}
}

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.58.14",
"method": "SET",
"payload": {
"devices": {
"DC04E04E6509": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"C77E8E7877D9": {
"model": 20,
"elevatingArm": {
"present": true,
"height": -15,
"speed": -14,
"leak": false
}
}
}
}
}
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.58.14",
"method": "SET",
"payload": {
"devices": {
"606C7CD508C6": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"4B7FD4EB4865": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"03094129F929": {
"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.58.14",
"method": "SET",
"payload": {
"devices": {
"7A800CDEF736": {
"model": 20,
"elevatingArm": {
"speed": -100
}
}
}
}
}
minimum

-100

maximum

100