move_linear_rel_tool¶

Queued EXEC mode Enabled Homed Takes control

Move the tool in a straight line by an offset along its own axes. The offset is measured along the tool's axes as they are when the move starts. A turn is about those axes.

Syntax¶

robot.move_linear_rel_tool(dx, dy, dz, drx=0.0, dry=0.0, drz=0.0, timeout=120.0, *, angle_unit='rad', **options)

Arguments¶

Name	Type	Default	Description
`dx`	`float`	required	Offset along the tool's X axis, in metres.
`dy`	`float`	required	Offset along the tool's Y axis, in metres.
`dz`	`float`	required	Offset along the tool's Z axis, in metres.
`drx`	`float`	`0.0`	Turn about the tool's X axis, in radians, or degrees with `angle_unit="deg"`.
`dry`	`float`	`0.0`	Turn about the tool's Y axis, in the same unit.
`drz`	`float`	`0.0`	Turn about the tool's Z axis, in the same unit.
`timeout`	`float`	`120.0`	Seconds to wait for the move to finish, in sync mode only.
`angle_unit`	`str`	`'rad'`	`"rad"` or `"deg"`: the unit of every angle in this call.
`**options`	`Any`	each setting's own	Settings for this move only. Each one you leave out takes its default: `speed` = 100 % `accel` = 100 % `duration` = none (the speed decides) `profile` = "ruckig" `jerk` = 100 % `ramp_fraction` = 0.25 `blend` = 0 `blend_mode` = "exact_velocity" `blend_continuity` = "c1" `ik_solver` = "pinocchio" `singularity_strategy` = "stop" `samples` = automatic `dry_run` = False

Returns¶

str

The command id. The call returns once the robot has accepted the move; call wait_idle() to wait until it has finished. In sync mode the call returns when the move has finished.

Examples¶

robot.move_linear_rel_tool(0, 0, 0.02)
robot.wait_idle()

Further details¶

Note

Moves along a Cartesian path run at no more than 20 % of the speed limit; a higher speed has no further effect.

Usage restrictions 26 codes

This command is added to the robot's motion queue. The robot accepts it only when it is ready for motion (EXEC mode, enabled and homed), from the client that holds control or when no client does. Otherwise, the robot refuses it with one of:

[6022] Client too old for pose commands — only a raw client that sends no "protocol": 2
[6010] Command not allowed now — the message names the mode or state it needs
[6101] Control held by another client — another client holds control; the message names it
[5002] Program aborted — an earlier move failed; clear errors first
[6004] Invalid motion options — a setting is unknown, out of range, or refused for a single move
[6011] Motion queue full

Once accepted, the move can still fail before it starts:

[5101] Target out of reach — the arm cannot reach the target pose
[5102] Path only partly reachable — the arm cannot reach a pose on the way to the target
[5103] Path too close to a limit — a pose on the path needs a joint outside its limits
[5105] Configuration flip on the path — the arm would have to change its configuration on the way, for example flip its wrist
[5104] Solution misses the pose — the joint solution misses a pose on the path
[5107] Tool strays from the path — the tool would stray from the straight line, usually near a singularity
[5010] Requested duration too short — duration is shorter than the limits allow
[5011] Invalid duration — duration is not more than 0 seconds
[5201] TOPPRA profile unavailable — profile="toppra", but that planner is missing
[5202] TOPPRA found no solution — profile="toppra" found no timing within the limits
[5009] Planned acceleration over its limit — the planned motion would exceed an acceleration limit
[5006] Move outside the joint limits — the path would take a joint outside its limits
[5007] Move into a safety zone — the path would enter a safety zone
[5008] Zone check unavailable — safety zones are active, but the robot model to check them is missing
[1401] Self-collision — the path would bring two parts of the arm too close
[5001] Trajectory planning failed
[3201] Trajectory not taken by RTI

A move that has started can end early with:

[5003] Command cancelled — an earlier move failed, or the robot left EXEC mode
[5004] Command stopped — stop() was called
[5005] Move did not settle — only with set_completion_policy("strict")

In Python, a refusal raises CommandRejected; its number is the code above. A failure after the robot accepted the move is raised by wait_idle() as MotionFailed, or by this call itself in sync mode as CommandRejected. No answer raises RobotTimeout; no connection, RobotConnectionError. ValueError: angle_unit is neither "rad" nor "deg".

Protocol¶

A client that does not use robotclient sends this over the TCP command protocol (port 29000) for the example above:

{"id": "c1", "cmd": "move_linear_rel_tool", "args": [0.0, 0.0, 0.02, 0.0, 0.0, 0.0], "protocol": 2}