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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "6724F2AB18F6": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "C02A581D03B2": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "C77B06317F92": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "C2239C852E73": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "43C1054D787E": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "83A3C3AC200A": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "3FFEC1CBA2E0": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "C758B2FA04CB": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2C8679202312": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 25
                    }
                }
            }
        }
    }
}
  • 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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "E3C232CBA4ED": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "pwm": 96
                    }
                }
            }
        }
    }
}
  • 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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "2C8679202312": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 25
                    }
                }
            }
        }
    }
}
  • 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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "37DC72B01562": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "15D092CC3041": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "DBA59793EBCF": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "67E6386135EB": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "CAF120557AC9": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 97
                    }
                }
            }
        }
    }
}
  • 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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "4D7BCC9EAA66": {
                "model": 19,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 27,
                        "pwm": 49,
                        "overcurrent": false,
                        "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.58.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "484818E959D0": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 18
                    }
                }
            }
        }
    }
}
  • 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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "BC4AA37372BF": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "484818E959D0": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 18
                    }
                }
            }
        }
    }
}
  • 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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "D616AA31BE3D": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "84A6827F2146": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "ADFC0A152493": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "C5EE3AB2F002": {
                "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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "F907CDDEB77D": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 64
                    }
                }
            }
        }
    }
}
  • 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.7",
    "method": "UPDATE",
    "payload": {
        "devices": {
            "8434176AB211": {
                "model": 20,
                "elevatingArm": {
                    "motorDiagnostics": {
                        "current": 80,
                        "pwm": 51,
                        "overcurrent": false,
                        "rpm": -1
                    }
                }
            }
        }
    }
}

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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "473268FA2F6F": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "CDF9911F886F": {
                "model": 19,
                "elevatingArm": {
                    "present": true,
                    "height": 0,
                    "speed": -8,
                    "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.58.7",
    "method": "SET",
    "payload": {
        "devices": {
            "B87801476364": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "A3FDA8E832D8": {
                "model": 20,
                "elevatingArm": {
                    "present": true,
                    "height": 25,
                    "speed": 66,
                    "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.58.7",
    "method": "SET",
    "payload": {
        "devices": {
            "E4DA107DF06F": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "493397B91B5E": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "D4218433B7A4": {
                "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.7",
    "method": "SET",
    "payload": {
        "devices": {
            "15F2AE3A97BD": {
                "model": 20,
                "elevatingArm": {
                    "speed": -100
                }
            }
        }
    }
}
minimum

-100

maximum

100