Skip to main content
Control robot arm operations for your device - motion commands, motor control, and position utilities. All positions are in millimeters (mm).

Syntax

Global Options

Arguments

Commands


Command Reference

position

Get the current arm position in millimeters.
Options:
  • --box TEXT - Lager Box name or IP
Example:

move

Move the arm to an absolute XYZ position in millimeters.
Options:
  • --x FLOAT - Target X position (mm)
  • --y FLOAT - Target Y position (mm)
  • --z FLOAT - Target Z position (mm)
  • --box TEXT - Lager Box name or IP
  • --timeout FLOAT - Move timeout in seconds (default: 5.0)
  • --yes - Confirm the action without prompting
Each axis is a named option, not a positional argument, so you can move along one axis without restating the others. Examples:

move-by

Move the arm by relative offsets (delta movement) in millimeters.
Options:
  • --dx FLOAT - Delta X offset (mm)
  • --dy FLOAT - Delta Y offset (mm)
  • --dz FLOAT - Delta Z offset (mm)
  • --box TEXT - Lager Box name or IP
  • --timeout FLOAT - Move timeout in seconds (default: 5.0)
  • --yes - Confirm the action without prompting
Omitted axes are left unchanged, so a single-axis jog needs only that one option. Examples:

go-home

Move the arm to its home position (X0 Y300 Z0).
Options:
  • --box TEXT - Lager Box name or IP
  • --yes - Confirm the action without prompting
Example:

enable-motor

Enable the arm’s motor drivers.
Options:
  • --box TEXT - Lager Box name or IP
Example:

disable-motor

Disable the arm’s motor drivers. Use this before manual manipulation of the arm.
Options:
  • --box TEXT - Lager Box name or IP
Example:

read-and-save-position

Read the current position and save it as a calibration reference.
Options:
  • --box TEXT - Lager Box name or IP
Example:

set-acceleration

Set arm acceleration parameters for movement control.
Options:
  • --acceleration INTEGER - Acceleration value (>= 0)
  • --travel INTEGER - Travel acceleration value (>= 0)
  • --retract INTEGER - Retract acceleration value (>= 0)
  • --box TEXT - Lager Box name or IP
Example:

Listing Arm Nets

When invoked with only --box and no subcommand, lists all arm nets on the box:
Output:

Examples


Supported Hardware


Notes

  • All positions are in millimeters (mm)
  • Home position is X0 Y300 Z0
  • Use --yes flag for non-interactive scripts and CI pipelines
  • Always re-enable motors after disabling them to resume normal operation
  • The --timeout option prevents commands from hanging if the arm fails to reach position
  • Default net can be set with lager defaults add --arm-net