Skip to content

Commit 295f06b

Browse files
committed
readme
1 parent e9d0ab8 commit 295f06b

File tree

2 files changed

+20
-43
lines changed

2 files changed

+20
-43
lines changed

README.md

Lines changed: 20 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,59 +4,36 @@
44
![linter](https://github.com/pollen-robotics/reachy2_symbolic_ik/actions/workflows/lint.yml/badge.svg)
55
![pytest](https://github.com/pollen-robotics/reachy2-sdk/actions/workflows/unit_tests.yml/badge.svg)
66

7-
## About
8-
9-
<!-- Row 1: Text on the left, GIF 1 on the right -->
10-
<div style="display: flex; align-items: center; margin-bottom: 20px;">
11-
<div style="flex: 1; padding-right: 10px;">
12-
<p>Top grasp is a fundamental robotic manipulation technique used to grip objects securely.
13-
This demonstration shows its practical application on the real robot.</p>
14-
</div>
15-
<div style="flex: 1;">
16-
<img src="./docs/img/topgrasp.gif" alt="Top grasp demo" style="width: 100%; border: 1px solid #ddd;">
17-
</div>
7+
A kinematics library that provides two core features for Reachy2:
8+
- A **symbolic inverse kinematics solver**. Handles joint limits, it's precise, solves reachability questions and provides complete knowledge of the nullspace.
9+
- A **control algorithm** to follow trajectories in task space. e.g., during teleoperation.
10+
11+
<div style="display: flex; justify-content: space-around;">
12+
13+
<div>
14+
<img src="./docs/img/topgrasp.gif " alt="First GIF" width="90%">
15+
<p style="text-align: center;">Reachy2 things</p>
1816
</div>
1917

20-
<!-- Row 2: GIF 2 on the left, Text on the right -->
21-
<div style="display: flex; align-items: center; margin-bottom: 20px;">
22-
<div style="flex: 1;">
23-
<img src="./docs/img/nullspace.gif" alt="Null space demo" style="width: 100%; border: 1px solid #ddd;">
24-
</div>
25-
<div style="flex: 1; padding-left: 10px;">
26-
<p>The null space control demo showcases how redundant degrees of freedom in a robot arm
27-
can be exploited to achieve multiple objectives simultaneously.</p>
28-
</div>
18+
<div>
19+
<img src="./docs/img/nullspace.gif" alt="Second GIF" width="100%">
20+
<p style="text-align: center;">Null space visualisation</p>
2921
</div>
3022

31-
<!-- Row 3: Text on the left, Thumbnail of Video on the right -->
32-
<div style="display: flex; align-items: center; margin-bottom: 20px;">
33-
<div style="flex: 1; padding-right: 10px;">
34-
<p>This video explains the principles of inverse kinematics (IK) and how it is implemented in the Reachy2 robot.</p>
35-
</div>
36-
<div style="flex: 1;">
37-
<a href="https://youtu.be/FHZdJbMAmRA?si=wepM4vH2sNLo85QP&t=344" title="IK explained">
38-
<img src="./docs/img/thumbnail.jpeg" alt="IK explained" style="width: 100%; border: 1px solid #ddd;">
39-
</a>
40-
</div>
4123
</div>
4224

43-
xxxxxxxx
4425

4526

46-
<!-- Row 1: Text on the left, GIF 1 on the right -->
47-
| Text | GIF |
48-
|------|-----|
49-
| Top grasp is a fundamental robotic manipulation technique used to grip objects securely. This demonstration shows its practical application on the real robot. | ![Top grasp demo](./docs/img/topgrasp.gif) |
27+
## Understanding how it works
28+
The main ideas behind the symbolic solution are fairly straightforward. We made a video explaining the concepts below (in French with English subtitles):
29+
30+
<p align="center">
31+
<a href="https://youtu.be/FHZdJbMAmRA?si=wepM4vH2sNLo85QP&t=344" title="IK explained">
32+
<img src="./docs/img/thumbnail.jpeg" alt="IK explained" width="60%">
33+
</a>
34+
</p>
5035

51-
<!-- Row 2: GIF 2 on the left, Text on the right -->
52-
| GIF | Text |
53-
|-----|------|
54-
| ![Null space demo](./docs/img/nullspace.gif) | The null space control demo showcases how redundant degrees of freedom in a robot arm can be exploited to achieve multiple objectives simultaneously. |
5536

56-
<!-- Row 3: Text on the left, Thumbnail of Video on the right -->
57-
| Text | Image |
58-
|------|-------|
59-
| This video explains the principles of inverse kinematics (IK) and how it is implemented in the Reachy2 robot. | [![IK explained](./docs/img/thumbnail.jpeg)](https://youtu.be/FHZdJbMAmRA?si=wepM4vH2sNLo85QP&t=344 "IK explained") |
6037

6138

6239
## Install

docs/img/nullspace.gif

55.6 KB
Loading

0 commit comments

Comments
 (0)