Skip to content

Commit ebb1951

Browse files
committed
docs(example): gello teleop and dependencies
- moved teleop script to examples, replacing the quest teleop script - added gello to readme documentation - added gello dependencies - fixed simpub version dependency
1 parent 48d719a commit ebb1951

4 files changed

Lines changed: 26 additions & 402 deletions

File tree

examples/teleop/README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,35 @@
1-
# Teleoperation with Meta Quest
1+
# Franka Teleoperation
2+
3+
## Teleoperation with Meta Quest 3
24
Teleoperate your robot (optinally dual arm) with the Meta Quest
35

4-
## How does it work?
5-
In the script [`quest_iris_dual_arm.py`](quest_iris_dual_arm.py) we use the [IRIS platform](https://intuitive-robots.github.io/iris-project-page/index.html) to get controller poses from the meta quest.
6+
### How does it work?
7+
In the script [`franka.py`](franka.py) we use the [IRIS platform](https://intuitive-robots.github.io/iris-project-page/index.html) to get controller poses from the meta quest.
68
With the relative space wrapper and the relative to configured origin setting theses poses are then apply to the robot in a delta fashion whenever the trigger button is pressed.
79
The buttons are used to start and stop data recording with the [`StorageWrapper`](robot-control-stack/python/rcs/envs/storage_wrapper.py).
810

9-
## Installation
11+
### Installation
1012
[Install RCS](https://robotcontrolstack.org/getting_started/index.html) and the [FR3 extension](https://robotcontrolstack.org/extensions/rcs_fr3.html) (the script is writte for the FR3 as example but can be easily adapted for other robots).
11-
Install the IRIS APK on your quest following [these instructions](https://github.com/intuitive-robots/IRIS-Meta-Quest3).
12-
Finally, install [SimPub](https://github.com/intuitive-robots/SimPublisher) the IRIS python client by
13+
Install the IRIS APK on your quest following [these instructions](https://github.com/intuitive-robots/IRIS-Meta-Quest3) use the apk released [here](https://github.com/RobotControlStack/IRIS-Meta-Quest3/releases/tag/rcsv1) to ensure compatiblity.
14+
Finally, install [SimPub](https://github.com/intuitive-robots/SimPublisher) the IRIS python client by (make sure to install it via requirements file to have the correct version)
1315

1416
```shell
1517
pip install -r requirements.txt
1618
```
1719

18-
## Configuration
20+
### Configuration
1921

20-
### Teleoperating in sim
22+
#### Teleoperating in sim
2123

22-
1. go to [`quest_iris_dual_arm.py`](quest_iris_dual_arm.py) and set `ROBOT_INSTANCE = RobotPlatform.SIMULATION`
24+
1. go to [`franka.py`](quest_iris_dual_arm.py) and set `ROBOT_INSTANCE = RobotPlatform.SIMULATION`
2325

24-
### Teleoperating a real robot
26+
#### Teleoperating a real robot
2527
Note that dual arm is only supported for a aloha like setup where the robot face each other (for more advanced setups you need to change the transformation between the robots yourself).
2628
1. put your robots into FCI mode
27-
2. go to [`quest_iris_dual_arm.py`](quest_iris_dual_arm.py), set `ROBOT_INSTANCE = RobotPlatform.HARDWARE` and set your IP addresses of your robots. Remove the left robot if you only have one.
29+
2. go to [`franka.py`](quest_iris_dual_arm.py), set `ROBOT_INSTANCE = RobotPlatform.HARDWARE` and set your IP addresses of your robots. Remove the left robot if you only have one.
2830

2931

30-
## Running
32+
### Running
3133
1. make sure your computer and quest is in the same subnetwork and they can ping each other.
3234
2. start IRIS meta quest app on your quest (it should be located in the Library under "Unkown Sources" after installation)
3335
3. run the [`quest_align_frame.py`](quest_align_frame.py) script once. Navigate to the link printed on the top likly [http://127.0.0.1:7000](http://127.0.0.1:7000).
@@ -39,5 +41,13 @@ Note that dual arm is only supported for a aloha like setup where the robot face
3941
5. use the right controller to change the orientation of the coordinate axis to fit your right robot (for franka: x front, y left, z up)
4042
6. click the "teleportation scene" button on the still open website
4143
7. cancel the script
42-
8. start the teleoperation script [`quest_iris_dual_arm.py`](quest_iris_dual_arm.py) and enjoy.
44+
8. start the teleoperation script [`franka.py`](quest_iris_dual_arm.py) and enjoy.
45+
4346

47+
## Teleoperation with Franka GELLO Duo
48+
Teleoperate your Franka Duo using the [Franka GELLO Duo](https://franka.de/de-de/product-prototypes).
49+
Install dependencies via
50+
```shell
51+
pip install -r requirements.txt
52+
```
53+
and make sure the `GelloConfig` is commented in and the `QuestConfig` is commented out and adapt your USB IDs to it.

0 commit comments

Comments
 (0)