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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "8DA0C7A207BF": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "9C28485EB668": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "53186B414578": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "97E6E7971AAB": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "0A766FD14B9E": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "1C16BF3D1EFB": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "25725BBD2AAD": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "C8FAD6EEE40F": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "70248249C72C": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 44
                    }
                }
            }
        }
    }
}
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4D0122BB3418": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 59
                    }
                }
            }
        }
    }
}
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "70248249C72C": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 44
                    }
                }
            }
        }
    }
}
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2C04DCB4909D": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "9831922EE4B2": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D32B59DD7E4B": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "AD8B7E1D0C91": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "90661D3E4AC6": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 24
                    }
                }
            }
        }
    }
}
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8F648D0E60A8": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 14,
                        "pwm": 20,
                        "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6A5B71976FF0": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 73
                    }
                }
            }
        }
    }
}
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CA91541E8259": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 37
                    }
                }
            }
        }
    }
}
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6A5B71976FF0": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 73
                    }
                }
            }
        }
    }
}
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "42230E0A3CA1": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "6EADCB49C164": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "EC1F9EA581DA": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DFB5085F667B": {
                "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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F36F719961C1": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 84
                    }
                }
            }
        }
    }
}
  • 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.57.4",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C77BAF2298C0": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 83,
                        "pwm": 0,
                        "overcurrent": false,
                        "rpm": 7
                    }
                }
            }
        }
    }
}

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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "66686866D053": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "598CA738697D": {
                "model": 19,
                "elevatingArm": {
                    "present": true,
                    "height": -35,
                    "speed": 71,
                    "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "A207DDFC1D92": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "C1CE3664220B": {
                "model": 20,
                "elevatingArm": {
                    "present": true,
                    "height": -27,
                    "speed": 13,
                    "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "9C5F16DE5E2C": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "F2790D812B66": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "8B5ADB575BE6": {
                "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.57.4",
    "method": "SET",
    "payload": {
        "devices": {
            "D71D42856EC1": {
                "model": 20,
                "elevatingArm": {
                    "speed": -100
                }
            }
        }
    }
}
minimum

-100

maximum

100