Skip to main content

A fast inverse kinematics (IK) solver for xArm7 with/without the linear rail and base rotation offset support

Project description

Fast Inverse Kinematics Solver for xArm7

This package provides a fast inverse kinematics (IK) solver for the xArm7 robotic arm, capable of running at approximately 150 Hz on a laptop with an i7-11800H CPU. It supports both standard 7-DOF xArm7 and configurations with a linear rail (8-DOF).

Features

  • Fast inverse kinematics for xArm7 (7-DOF) and xArm7 with linear rail (8-DOF)
  • Supports quaternion, Euler angle, and axis-angle rotation representations
  • Lightweight and easy to integrate

Installation

Requirements:

Install via pip:

pip install xarm7-ik

Or clone this repo and:

pip install .
# or, for example dependencies (Mujoco):
pip install .[examples]

Usage

To use the IK solver in your own code:

  1. Import the solver and rotation representation:

    from xarm7_ik.solver import InverseKinematicsSolver
    
  2. Create an instance of the solver:

    • For a standard xArm7 (7-DOF):
      ik_solver = InverseKinematicsSolver(use_linear_motor=False, rotation_repr="quaternion")
      
    • For xArm7 with linear rail (8-DOF):
      ik_solver = InverseKinematicsSolver(use_linear_motor=True, rotation_repr="quaternion")
      
  3. Call the inverse kinematics method:

    result = ik_solver.inverse_kinematics(
        initial_configuration,         # np.ndarray of joint angles (7 or 8 elements)
        target_gripper_pos,            # np.ndarray, shape (3,)
        target_gripper_rot,            # np.ndarray, shape depends on the rotation representation
        
        # Quaternions are in the W-X-Y-Z order
        # Euler angles are X-Y-Z
        # Axis-angle representations are (axis, angle)
    )
    # result: np.ndarray of joint angles
    

For more complete usage and simulation integration, see the scripts in the examples/ folder. \

Citation

This project was originally developed for our paper that uses xArm7. If you find this project useful, please consider citing our paper:

@article{sun2025dynamic,
  title={Dynamic Rank Adjustment in Diffusion Policies for Efficient and Flexible Training},
  author={Sun, Xiatao and Yang, Shuo and Chen, Yinxing and Fan, Francis and Liang, Yiyan and Rakita, Daniel},
  journal={arXiv preprint arXiv:2502.03822},
  year={2025}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xarm7_ik-0.2.0.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xarm7_ik-0.2.0-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file xarm7_ik-0.2.0.tar.gz.

File metadata

  • Download URL: xarm7_ik-0.2.0.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.15

File hashes

Hashes for xarm7_ik-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8c7803d5f24220150420be965c32a11622f941d2cb63a9d3977280a80e8cd6cb
MD5 0be21774a7cfd7bd9ee5c526deaec217
BLAKE2b-256 f7cf6b013e3dec486a8a791a974545c4412d1d6fef6c619fdf45fc692888ab42

See more details on using hashes here.

File details

Details for the file xarm7_ik-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: xarm7_ik-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.15

File hashes

Hashes for xarm7_ik-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cf55ffead4634433060cf0e9685b6d99583dc356a5c6acdbc9493b922f9015cf
MD5 1eb67c2da92d4f0d2c305db776062e88
BLAKE2b-256 ba3682da8f6da59d371d730545c85c726680af0ef70048bf10a2c3b11b13e8f4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page