Skip to content

Commit 97831a6

Browse files
authored
Deprecate gantry.comp
Deprecate the "gantry" HAL component.
1 parent 0eab8f8 commit 97831a6

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

src/hal/components/gantry.comp

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ pin in float search-vel "HOME_SEARCH_VEL from INI file";
5151
function read fp "Update position-fb and home/limit outputs based on joint values.";
5252
function write fp "Update joint pos-cmd outputs based on position-cmd in.";
5353
description """
54+
--- Deprecation Notice
55+
56+
gantry - Superseded by the general purpose 'trivkins' kinematics module.
57+
58+
To specify a gantry with non-identity kinematics: use trivkins with the kinstype parameter set for KINEMATICS_BOTH. Example:
59+
60+
loadrt trivkins coordinates=xyyz kinstypes=BOTH
61+
Drives multiple physical motors (joints) from a single axis input
62+
63+
--- End deprecation notice
5464
Drives multiple physical motors (joints) from a single axis input
5565
.LP
5666
The `personality' value is the number of joints to control. Two is typical, but

0 commit comments

Comments
 (0)