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.15",
"method": "SET",
"payload": {
"devices": {
"FBAA5C58F31A": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"E1DB1778ECE7": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"D923826CE4FA": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"E522EBF5E403": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"FAF0FC59B9BE": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"E822302001D7": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"90A8F227001C": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"87BFD9D52977": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"F2A96BCC1E5E": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 83
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"9F211C2464D9": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"pwm": 62
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"F2A96BCC1E5E": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 83
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"305E593DDE1D": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"2A7E5377CDF3": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"B404277FAACD": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"49DA6AB9581C": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"532EB2C89741": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 29
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"0E73FF0CBCB3": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 37,
"pwm": 77,
"overcurrent": true,
"rpm": 7
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"1589DF9F29E0": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 19
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"1BCAB4CF3B44": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"pwm": 66
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"1589DF9F29E0": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 19
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"B26613F848BC": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"2392CDEFEB30": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"441348F41B67": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"6A384AB20717": {
"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.15",
"method": "UPDATE",
"payload": {
"devices": {
"2E7C407E5305": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 36
}
}
}
}
}
}
  • 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.15",
"method": "UPDATE",
"payload": {
"devices": {
"6CC95D5CE5D8": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 83,
"pwm": 96,
"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.15",
"method": "SET",
"payload": {
"devices": {
"FD6215F0E29A": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"357BBD035499": {
"model": 19,
"elevatingArm": {
"present": true,
"height": -71,
"speed": -89,
"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.58.15",
"method": "SET",
"payload": {
"devices": {
"34C55508F8D2": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"9D27AC3599F8": {
"model": 20,
"elevatingArm": {
"present": true,
"height": 19,
"speed": -10,
"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.15",
"method": "SET",
"payload": {
"devices": {
"B966FE2040C2": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"CF77A03C5969": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"CD53446583B2": {
"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.15",
"method": "SET",
"payload": {
"devices": {
"E62C327CE9C2": {
"model": 20,
"elevatingArm": {
"speed": -100
}
}
}
}
}
minimum

-100

maximum

100