Robots¶

class jacobi.Robot¶

Bases: Element

__init__(*args, **kwargs)¶

static from_model(model: str) → Robot¶

set_speed(self: Robot, speed: float) → None¶

property model¶: The model name of the robot

class jacobi.RobotArm¶

Bases: Robot

__init__(*args, **kwargs)¶

calculate_tcp(self: RobotArm, joint_position: list[float]) → Frame¶

Calculates the forward_kinematics and returns the frame of the robot’s TCP.

Parameter joint_position:: The joint position of the robot.
Returns:: The frame of the robot’s TCP.

calculate_tcp_speed(self: RobotArm, joint_position: list[float], joint_velocity: list[float]) → float¶

Calculates the forward_kinematics and returns the norm of the Cartesian velocity of the robot’s TCP.

Parameter joint_position:: The joint position of the robot.
Parameter joint_velocity:: The joint velocity of the robot.
Returns:: The Cartesian speed of the TCP.

inverse_kinematics(*args, **kwargs)¶

Overloaded function.

inverse_kinematics(self: jacobi.RobotArm, waypoint: jacobi.CartesianWaypoint) -> Optional[list[float]]

Computes the inverse kinematics for a Cartesian waypoint.

Parameter waypoint:: The Cartesian waypoint to compute the inverse kinematics for.
Returns:: An optional Config object representing the joint positions of the robot.

inverse_kinematics(self: jacobi.RobotArm, tcp: jacobi.Frame, reference_config: Optional[list[float]] = None) -> Optional[list[float]]

Computes the inverse kinematics for a Cartesian position and a reference configuration.

Finds a joint position so that the robot’s TCP is at the given frame, which is defined in the world coordinate system. In general, the solution will try to stay close to the reference_config parameter. We use a numerical optimization for robots with more than 6 degrees of freedom. Then, the reference configuration is used as a starting point for the optimization. This method does not take the environment’s collision model into account.

Parameter tcp:: The Cartesian position to compute the inverse kinematics for.
Parameter reference_config:: The reference configuration to use for the inverse kinematics.
Returns:: An optional Config object representing the joint positions of the robot.

set_speed(self: RobotArm, speed: float) → None¶

Sets the velocity, acceleration, and jerk limits to a factor [0, 1] of their respective default (maximum) values.

Parameter speed:: A double representing the speed to be set for the robot.

property default_position¶: The default robot position - used for initializing the current robot position.

property degrees_of_freedom¶: The degrees of freedom (or number of axis) of the robot.

property end_effector¶

Get the (optional) end effector attached to the robot’s flange.

Returns:: An (optional) end effector attached to the robot’s flange.

property end_effector_obstacle¶: internal An (optional) obstacle attached to the robot’s flange.

property flange_to_tcp¶: internal The transformation from the robot’s flange to the robot’s TCP, e.g., for using inverse kinematics or an item obstacle.

property item¶

Get the (optional) obstacle attached to the robot’s TCP.

Returns:: An (optional) obstacle attached to the robot’s TCP.

property item_obstacle¶: internal An (optional) obstacle attached to the robot’s TCP.

property link_obstacles¶: The obstacles for each robot link.

property max_acceleration¶: Maximum absolute acceleration for each joint. [rad/s^2]

property max_jerk¶: Maximum absolute jerk for each joint. [rad/s^3]

property max_position¶: Maximum position for each joint. [rad]

property max_velocity¶: Maximum absolute velocity for each joint. [rad/s]

property min_position¶: Minimum position for each joint. [rad]

property tcp¶

Retrieves the frame of the robot’s TCP.

Returns:: A Frame representing the frame of the robot’s TCP.

property tcp_acceleration¶

Retrieves the Cartesian acceleration of the robot’s TCP.

Returns:: A Twist representing the Cartesian acceleration of the robot’s TCP.

property tcp_position¶

Retrieves the frame of the robot’s TCP.

Returns:: A Frame representing the frame of the robot’s TCP.

property tcp_velocity¶

Retrieves the Cartesian velocity of the robot’s TCP.

Returns:: A Twist representing the Cartesian velocity of the robot’s TCP.

class jacobi.robots.DualArm¶

Bases: Robot

__init__(self: DualArm, left: RobotArm, right: RobotArm) → None¶

property left¶: The left arm of the robot

property right¶: The right arm of the robot

class jacobi.robots.ABBGoFaCRB1500010¶