Skip to main content

Dual Quaternion based MPC generating screw motion for n-DOF robot arm.

Project description

screwmpcpy

Actions Status Documentation Status PyPI version PyPI platforms GitHub Discussion

Generate smooth motions for a n-DOF robot arm end effector using Dual Quaternions while enforcing velocity-, acceleration- and jerk constraints. The package includes a base optimization scheme and a base motion generator, which can be easily extended for custom robot arms. A motion generator for the Franka Emika Panda robot is included.

Install

The package is available in PyPI, you can install it via pip:

pip install screwmpcpy

Getting started

The motion generators yield velocity commands for an n-DoF robot arm. For the basic usage have a look at examples/motiongenerator.py. You can also use the dual quaternions to generate waypoints. Check it out the example for the panda robot at examples/panda_screwmotion_ik.py. To install the required package dependencies execute pip install screwmpcpy[examples]. You can find advanced usage examples here. We include two generators for the panda robot:
The basic screw motion generator and a modified variant, which includes manipulability maximization from [1].

Extending the available robots

You can easily extend the base class by adding your custom robot arm. Ensure the forward kinematics of your robot are available.
Create a new file your_robot_mg.py in folder src/screwmpc.py.

Custom robot example

from dqrobotics import DQ
from .basemg import BaseMotionGenerator
from .screwmpc import BOUND


class YourRobotMotionGenerator(BaseMotionGenerator):

    def __init__(
                self,
                n_p: int,
                n_c: int,
                q_mpc: float,
                r_mpc: float,
                lu_bound_vel: BOUND,
                lu_bound_acc: BOUND,
                lu_bound_jerk: BOUND,
                ) -> None:
        super().__init__(
            n_p, n_c, q_mpc, r_mpc, lu_bound_vel, lu_bound_acc, lu_bound_jerk
        )
        # custom attributes here
        self._kin = YourRobotKinematics()

    def step(self, q_robot: np.ndarray, goal: DQ) -> np.ndarray:

        # Initialize Dual Quaternion with 6D pose
        x_current = DQ(self._kin.your_forward_kinematics(q_robot))
        error, smooth_traj = super()._step(x_current, goal)
        # calculate commanded dq here
        ...
        return dq

References

[1] Haviland, J., & Corke, P. (2020). A Purely-Reactive Manipulability-Maximising Motion Controller. ArXiv. /abs/2002.11901

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

screwmpcpy-0.5.3.tar.gz (48.3 kB view details)

Uploaded Source

Built Distribution

screwmpcpy-0.5.3-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file screwmpcpy-0.5.3.tar.gz.

File metadata

  • Download URL: screwmpcpy-0.5.3.tar.gz
  • Upload date:
  • Size: 48.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for screwmpcpy-0.5.3.tar.gz
Algorithm Hash digest
SHA256 931e8ffd53a3e3d74ef9fa997d30a941db797a7e54d44c5972c3855c87adde4e
MD5 e45b77c75a7b8fc1ac44f39cfc43d03e
BLAKE2b-256 bc91482e7b2691268de10bb3f7249c7aa6b62ac556f8ceab50bb77e788e13813

See more details on using hashes here.

File details

Details for the file screwmpcpy-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: screwmpcpy-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for screwmpcpy-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 64fb07b00d07bad66feaf1f15a1ace49c7673061a264085eaebb532510ce100b
MD5 ba825a62ea346a8a34fe46278927f016
BLAKE2b-256 f2876889b5ddbc06643938f8be8060390e3bb587539d407177ad4366e8a19426

See more details on using hashes here.

Supported by

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