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.56.4",
"method": "SET",
"payload": {
"devices": {
"CD797DF878AD": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"D51299CD5E7A": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"15990788EF37": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"84175BACE637": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"255C8D2B1AE4": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"56327A260B27": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"59BDD0CE8546": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"CED66ECC1A88": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"B7872A2EE1D8": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 27
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"821E42CAD215": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"pwm": 15
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"B7872A2EE1D8": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 27
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"52DBAD136FA7": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"53E10D68CE03": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"0BA58E47A226": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"2EB9DFD24D64": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"0E227E04EED7": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 64
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"003DC9DE7D06": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 23,
"pwm": 15,
"overcurrent": true,
"rpm": 1
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"0705A97692C7": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 40
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"DAE0CBE55CB2": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"pwm": 90
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"0705A97692C7": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 40
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"2D5D41C680F0": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"20C69253E4AB": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"AE66B9CD9F5F": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"CB3676EA66DC": {
"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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"88B7EAC01A54": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 31
}
}
}
}
}
}
  • 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.56.4",
"method": "UPDATE",
"payload": {
"devices": {
"8AEEDF2E03AE": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 98,
"pwm": 29,
"overcurrent": false,
"rpm": 0
}
}
}
}
}
}
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.56.4",
"method": "SET",
"payload": {
"devices": {
"62F5559CE0E3": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"5DBE235E3A06": {
"model": 19,
"elevatingArm": {
"present": true,
"height": -5,
"speed": -32,
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"567BA626970D": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"96DF0A6F5135": {
"model": 20,
"elevatingArm": {
"present": true,
"height": -62,
"speed": 55,
"leak": true
}
}
}
}
}
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.56.4",
"method": "SET",
"payload": {
"devices": {
"7AC8A4BDB244": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"85BD70D78E61": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"8594ED0423CD": {
"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.56.4",
"method": "SET",
"payload": {
"devices": {
"040A58B9DBED": {
"model": 20,
"elevatingArm": {
"speed": -100
}
}
}
}
}
minimum

-100

maximum

100