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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "4A9BACCFA31A": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "B087CBDD0ECC": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "C63807C9C54F": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "9BB74EEA1690": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "37043D5D891F": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "6E5E869E645F": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "CCEEEA5D51D9": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "4C52D372DE8A": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "133B649D6147": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 99
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7CA25EFEAAD8": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 80
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "133B649D6147": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 99
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DF384257A706": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BE8E1C9402A9": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "168643DE9DF4": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2339098FF9D0": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "EABE44F50989": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 45
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "934883270B0D": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 23,
                        "pwm": 33,
                        "overcurrent": true,
                        "rpm": 8
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "07FCD6CCAACD": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 28
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C81DEC7C6FEB": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 44
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "07FCD6CCAACD": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 28
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "93317786C8D5": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "742B36784916": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "13CFCF714C74": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "7A70AD113F9E": {
                "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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "988FB5956193": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 44
                    }
                }
            }
        }
    }
}
  • 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.60.2",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "5F36F12B0DC0": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 46,
                        "pwm": 38,
                        "overcurrent": false,
                        "rpm": -2
                    }
                }
            }
        }
    }
}

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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "B4A716C6BC36": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "D4D612521CEC": {
                "model": 19,
                "elevatingArm": {
                    "present": true,
                    "height": -81,
                    "speed": 88,
                    "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "165CA6938392": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "ED723391D025": {
                "model": 20,
                "elevatingArm": {
                    "present": true,
                    "height": 29,
                    "speed": 46,
                    "leak": true
                }
            }
        }
    }
}

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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "A76DEB709B59": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "89EFF1A89C9A": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "6C936430A5CA": {
                "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.60.2",
    "method": "SET",
    "payload": {
        "devices": {
            "16EAE8B24471": {
                "model": 20,
                "elevatingArm": {
                    "speed": -100
                }
            }
        }
    }
}
minimum

-100

maximum

100