v1

latestOpenAPI 3.1.02026-07-26243347.4 KB
control

Read End-Effector Position

Retrieve the position, orientation, and open status of the robot's end effector. Only available for manipulators.

post/end-effector/read

Query parameters

robot_idinteger

Request body

only_gripperboolean

If True, only return the gripper state. If False, return the full end effector position and orientation.

syncboolean

If True, the simulation will first read the motor positions, synchronize them with the simulated robot, and then return the end effector position.Useful for measurements, however it will take more time to respond.

Response

Successful Response

opennumber required

0 for closed, 1 for open

rxnumber nullable required

Absolute Pitch in degrees

rynumber nullable required

Absolute Yaw in degrees

rznumber nullable required

Absolute Roll in degrees

xnumber nullable required

X position in centimeters

ynumber nullable required

Y position in centimeters

znumber nullable required

Z position in centimeters