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.50.0",
"method": "SET",
"payload": {
"devices": {
"F7C00300D706": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"DCAE129D4E66": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"879A07CBB84E": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"CA2FC5F0567D": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"0BABC1639DDA": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"B98D950B29EA": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"28A145B07995": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"F14E5CBF31FA": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"DC00B6A530AD": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 81
}
}
}
}
}
}
  • 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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"29301503FDF3": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"pwm": 97
}
}
}
}
}
}
  • 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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"DC00B6A530AD": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 81
}
}
}
}
}
}
  • 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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"856D9A7AF392": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"716651383001": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"F29074FDC650": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"6219CD5AE5D8": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"A06CFBB3BD6E": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 99
}
}
}
}
}
}
  • 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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"89E1EBFA21E0": {
"model": 19,
"elevatingArm": {
"motorDiagnostics": {
"current": 69,
"pwm": 89,
"overcurrent": true,
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"0D190770842E": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 79
}
}
}
}
}
}
  • 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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"BAA8D69A05B2": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"pwm": 78
}
}
}
}
}
}
  • 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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"0D190770842E": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 79
}
}
}
}
}
}
  • 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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"C63F332133F9": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"8D2075B56E4A": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"BCEFE6AA3493": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"84F4F74D5F1A": {
"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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"36F72F5215FF": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 25
}
}
}
}
}
}
  • 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.50.0",
"method": "UPDATE",
"payload": {
"devices": {
"FC7C72F41722": {
"model": 20,
"elevatingArm": {
"motorDiagnostics": {
"current": 81,
"pwm": 64,
"overcurrent": false,
"rpm": -5
}
}
}
}
}
}
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.50.0",
"method": "SET",
"payload": {
"devices": {
"5FF5B75F57FD": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"009D3F741D90": {
"model": 19,
"elevatingArm": {
"present": true,
"height": -23,
"speed": -13,
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"CF4B7B6490B5": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"6D792FABA5C0": {
"model": 20,
"elevatingArm": {
"present": true,
"height": 74,
"speed": 82,
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"46CE3C9B1386": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"29BCE04AA410": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"E225072E83EF": {
"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.50.0",
"method": "SET",
"payload": {
"devices": {
"E5E5F367B1F2": {
"model": 20,
"elevatingArm": {
"speed": -100
}
}
}
}
}
minimum

-100

maximum

100