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.58.10",
    "method": "SET",
    "payload": {
        "devices": {
            "8C8A8962C835": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "0093F007C9CA": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "E7B1FE2FCD97": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "5751BF858798": {
                "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.58.10",
    "method": "SET",
    "payload": {
        "devices": {
            "0E5F2DAD901E": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "3A8072D50C5F": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "A235E9526776": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "21E1AE926C9C": {
                "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.58.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "70ED9CF5C16F": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 56
                    }
                }
            }
        }
    }
}
  • 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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "673C12615AF8": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 32
                    }
                }
            }
        }
    }
}
  • 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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "70ED9CF5C16F": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 56
                    }
                }
            }
        }
    }
}
  • 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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D03E1560598B": {
                "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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6A46C36073DE": {
                "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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "17FB80C3EABE": {
                "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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "B50D78745D4E": {
                "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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "35A94ADC49F5": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 10
                    }
                }
            }
        }
    }
}
  • 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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4D8381C8B577": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 56,
                        "pwm": 99,
                        "overcurrent": true,
                        "rpm": 9
                    }
                }
            }
        }
    }
}
  • 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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "ABDA677A8D2F": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 52
                    }
                }
            }
        }
    }
}
  • 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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "AE0275ED1AD3": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 63
                    }
                }
            }
        }
    }
}
  • 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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "ABDA677A8D2F": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 52
                    }
                }
            }
        }
    }
}
  • 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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4F0EBFCBBAA8": {
                "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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "676D239A9CD3": {
                "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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "075C404CD720": {
                "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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8B65050BD10B": {
                "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.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "A4972041A187": {
                "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.58.10",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C22C563416B3": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 97,
                        "pwm": 14,
                        "overcurrent": false,
                        "rpm": -4
                    }
                }
            }
        }
    }
}

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.58.10",
    "method": "SET",
    "payload": {
        "devices": {
            "816A4277F7CF": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "FBB6E2127307": {
                "model": 19,
                "elevatingArm": {
                    "present": true,
                    "height": 20,
                    "speed": -29,
                    "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "6A7101F170AF": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "95DB9DCD220B": {
                "model": 20,
                "elevatingArm": {
                    "present": true,
                    "height": -52,
                    "speed": 81,
                    "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.58.10",
    "method": "SET",
    "payload": {
        "devices": {
            "32E87BBA60B5": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "EF26D9E18287": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "EF29AEEE4FB2": {
                "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.10",
    "method": "SET",
    "payload": {
        "devices": {
            "EA4906E31661": {
                "model": 20,
                "elevatingArm": {
                    "speed": -100
                }
            }
        }
    }
}
minimum

-100

maximum

100