45 releases (24 breaking)

0.24.0 Apr 13, 2021
0.23.0 Mar 3, 2021
0.22.1 Feb 10, 2021
0.21.2 Dec 24, 2020
0.6.0 Nov 23, 2017

#12 in Algorithms

Download history 445/week @ 2021-01-16 667/week @ 2021-01-23 485/week @ 2021-01-30 362/week @ 2021-02-06 617/week @ 2021-02-13 673/week @ 2021-02-20 473/week @ 2021-02-27 130/week @ 2021-03-06 259/week @ 2021-03-13 305/week @ 2021-03-20 555/week @ 2021-03-27 543/week @ 2021-04-03 658/week @ 2021-04-10 710/week @ 2021-04-17 334/week @ 2021-04-24 322/week @ 2021-05-01

1,961 downloads per month
Used in 11 crates (8 directly)

Apache-2.0

145KB
2K SLoC

k: Kinematics library for rust-lang

Build and Test crates.io codecov docs

k has below functionalities.

  1. Forward kinematics
  2. Inverse kinematics
  3. URDF Loader

k uses nalgebra as math library.

See Document and examples/ for more details.

API is unstable.

Requirements to build examples

sudo apt install g++ cmake xorg-dev libglu1-mesa-dev

IK example with GUI

cargo run --release --example interactive_ik

ik_sample

Push below keys to move the end of the manipulator.

  • f: forward
  • b: backward
  • p: up
  • n: down
  • l: left
  • r: right
  • z: reset the manipulator state.

Create link tree from urdf and solve IK

use k::prelude::*;

fn main() {
    // Load urdf file
    let chain = k::Chain::<f32>::from_urdf_file("urdf/sample.urdf").unwrap();
    println!("chain: {}", chain);

    // Set initial joint angles
    let angles = vec![0.2, 0.2, 0.0, -1.0, 0.0, 0.0, 0.2, 0.2, 0.0, -1.0, 0.0, 0.0];

    chain.set_joint_positions(&angles).unwrap();
    println!("initial angles={:?}", chain.joint_positions());

    let target_link = chain.find("l_wrist_pitch").unwrap();

    // Get the transform of the end of the manipulator (forward kinematics)
    chain.update_transforms();
    let mut target = target_link.world_transform().unwrap();

    println!("initial target pos = {}", target.translation);
    println!("move z: +0.1");
    target.translation.vector.z += 0.1;

    // Create IK solver with default settings
    let solver = k::JacobianIkSolver::default();

    // Create a set of joints from end joint
    let arm = k::SerialChain::from_end(target_link);
    // solve and move the manipulator angles
    solver.solve(&arm, &target).unwrap();
    println!("solved angles={:?}", chain.joint_positions());

    chain.update_transforms();
    let solved_pose = target_link.world_transform().unwrap();
    println!("solved target pos = {}", solved_pose.translation);
}

Structure of API

Top level interface is Chain struct. It contains Nodes and they have the relations between nodes (parent/children). Actual data (joint angle(position), transform between nodes) is stored in Joint object inside nodes.

ik_sample

You can get local/world transform of nodes. See below figure to understand what is the node's local_transfrom() and world_transfrom().

ik_sample

Dependencies

~5.5MB
~125K SLoC