Python inverse kinematics for articulated robot models, based on Pinocchio.
For best performance we recommended installing Pink from Conda:
conda install -c conda-forge pink
You can also install it from PyPI:
pip install pin-pink
Pink solves differential inverse kinematics by weighted tasks. A task is defined by a residual function
In differential inverse kinematics, we compute a velocity
where
Pink provides an API to describe the problem as tasks with targets, and automatically build and solve the underlying quadratic program.
Here is the example of a biped robot that controls the position and orientation of its base, left and right contact frames. A fourth "posture" task, giving a preferred angle for each joint, is added for regularization:
from pink.tasks import FrameTask, PostureTask
tasks = {
"base": FrameTask(
"base",
position_cost=1.0, # [cost] / [m]
orientation_cost=1.0, # [cost] / [rad]
),
"left_contact": FrameTask(
"left_contact",
position_cost=[0.1, 0.0, 0.1], # [cost] / [m]
orientation_cost=0.0, # [cost] / [rad]
),
"right_contact": FrameTask(
"right_contact",
position_cost=[0.1, 0.0, 0.1], # [cost] / [m]
orientation_cost=0.0, # [cost] / [rad]
),
"posture": PostureTask(
cost=1e-3, # [cost] / [rad]
),
}
Orientation (similarly position) costs can be scalars or 3D vectors. They specify how much each radian of angular error "costs" in the overall normalized objective. When using 3D vectors, components are weighted anisotropically along each axis of the body frame.
Aside from their costs, most tasks take a second set of parameters called target. For example, a frame task aims for a target transform, while a posture task aims for a target configuration vector. Targets are set by the set_target
function:
tasks["posture"].set_target(
[1.0, 0.0, 0.0, 0.0] + # floating base quaternion
[0.0, 0.0, 0.0] + # floating base position
[0.0, 0.2, 0.0, 0.0, -0.2, 0.0] # joint angles
)
Body tasks can be initialized, for example, from the robot's neutral configuration:
import pink
from robot_descriptions.loaders.pinocchio import load_robot_description
robot = load_robot_description("upkie_description")
configuration = pink.Configuration(robot.model, robot.data, robot.q0)
for body, task in tasks.items():
if type(task) is FrameTask:
task.set_target(configuration.get_transform_frame_to_world(body))
A task can be added to the inverse kinematics once both its cost and target (if applicable) are defined.
Pink solves differential inverse kinematics, meaning it outputs a velocity that steers the robot towards achieving all tasks at best. If we keep integrating that velocity, and task targets don't change over time, we will converge to a stationary configuration:
dt = 6e-3 # [s]
for t in np.arange(0.0, 42.0, dt):
velocity = solve_ik(configuration, tasks.values(), dt, solver="quadprog")
configuration.integrate_inplace(velocity, dt)
time.sleep(dt)
If task targets are continuously updated, there will be no stationary solution to converge to, but the model will keep on tracking each target at best. Note that solve_ik
will take care of both configuration and velocity limits read from the robot model.
Basic examples to get started:
Pink works with all kinds of robot morphologies:
- Arms: Kinova Gen2, UR3
- Humanoids: JVRC-1, SigmaBan
- Mobile base: Omnidirectional robot, Stretch R1
- Wheeled biped: Upkie
Check out the examples directory for more code.
- Can I solve global inverse kinematics?
- Can I make velocities smoother?
- My configuration gets stuck somewhere and does not solve the task, what is going on?
Pink implements differential inverse kinematics, a first-order algorithm that converges to the closest optimum of its cost function. It is a local method that does not solve the more difficult problem of global inverse kinematics. That is, it may converge to a global optimum, or to a local one stuck to some configuration limits. This behavior is illustrated in the simple pendulum with configuration limit example.
Install the library and use it! Report bugs in the issue tracker. If you are a developer with some robotics experience looking to hack on open source, check out the contribution guidelines.
If you use Pink in your scientific works, please cite it e.g. as follows:
@software{pink2024,
title = {{Pink: Python inverse kinematics based on Pinocchio}},
author = {Caron, Stéphane and De Mont-Marin, Yann and Budhiraja, Rohan and Bang, Seung Hyeon and Domrachev, Ivan and Nedelchev, Simeon},
license = {Apache-2.0},
url = {https://github.com/stephane-caron/pink},
version = {3.0.0},
year = {2024}
}
Software:
- mink: differential inverse kinematics in Python, based on the MuJoCo physics engine.
- Jink.jl: Julia package for differential multi-task inverse kinematics.
- PlaCo: C++ inverse kinematics based on Pinocchio.
- pymanoid: precursor to Pink based on OpenRAVE.
- TSID: C++ inverse kinematics based on Pinocchio.
Technical notes:
- Inverse kinematics: a general introduction to differential inverse kinematics.
- Jacobian of a kinematic task and derivatives on manifolds.
- Control Barrier Functions.
pink's People
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.