Skip to content

Commit fcde881

Browse files
committed
docs: mention yam
1 parent 3cb449c commit fcde881

3 files changed

Lines changed: 13 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
**Robot Control Stack (RCS)** is a flexible, native [Gymnasium](https://gymnasium.farama.org/) wrapper-based robot control interface designed specifically for modern robot learning and Vision-Language-Action (VLA) models.
1616

17-
It completely unifies **MuJoCo simulation** and real-world physical robot control into a single, seamless API. Currently, RCS natively supports four robots out-of-the-box: **Franka FR3/Panda, xArm7, UR5e, and SO101.**
17+
It completely unifies **MuJoCo simulation** and real-world physical robot control into a single, seamless API. Currently, RCS natively supports five robots out-of-the-box: **Franka FR3/Panda, xArm7, UR5e, SO101, and I2RT YAM.**
1818

1919
![RCS Demo](https://raw.githubusercontent.com/RobotControlStack/robotcontrolstack.github.io/refs/heads/master/static/videos/grid.webp)
2020

@@ -26,7 +26,7 @@ Traditional robotics middleware (like ROS/ROS2) and complex motion planning pipe
2626
* **Zero ROS Overhead:** No complex message-passing, middleware, or network configuration required. Run natively in Python with a lightweight C++ backend.
2727
* **Frictionless Sim-to-Real:** Train your Reinforcement Learning or VLA policies in our MuJoCo Gymnasium wrapper, and deploy the *exact same code* directly to physical hardware.
2828
* **Synchronous Execution:** Optimized specifically for the highly parallelized, synchronous data collection required by modern ML workflows.
29-
* **Ready-to-Use Apps:** Ships with pre-built applications for data collection via teleoperation and remote model inference via [vlagents](https://github.com/RobotControlStack/vlagents). See [examples/teleop/README.md](examples/teleop/README.md) and [examples/inference/README.md](examples/inference/README.md).
29+
* **Ready-to-Use Apps:** Ships with pre-built applications for data collection via teleoperation and remote model inference via [vlagents](https://github.com/RobotControlStack/vlagents). See the [teleoperation guide](examples/teleop/README.md), and [inference guide](examples/inference/README.md).
3030

3131
## 🧩 Wrapper-Based Architecture
3232

@@ -168,7 +168,7 @@ export RCS_PREFIX=/path/to/rcs-assets
168168

169169
## 🦾 Hardware Extensions
170170

171-
RCS supports various hardware extensions to seamlessly connect your policies to the real world (e.g., FR3, xArm7, RealSense). These are located in the `extensions` directory.
171+
RCS supports various hardware extensions to seamlessly connect your policies to the real world (e.g., FR3, xArm7, YAM, RealSense). These are located in the `extensions` directory.
172172

173173
To install a specific robot extension (example for Franka FR3):
174174

‎docs/apps/index.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ RCS ships with ready-to-use applications for common operator workflows such as r
44

55
## Teleoperation
66

7-
Use the Franka teleoperation app when you want to collect demonstrations or directly control a robot from an operator interface.
7+
Use the Meta Quest 3 teleoperation examples when you want to collect demonstrations or directly control a robot from an operator interface. RCS provides examples for Franka and I2RT YAM arms.
88

99
- Example guide: [examples/teleop/README.md](../../examples/teleop/README.md)
10-
- Main script: [examples/teleop/franka.py](../../examples/teleop/franka.py)
10+
- Franka example: [examples/teleop/franka.py](../../examples/teleop/franka.py)
11+
- YAM example: [examples/teleop/yam.py](../../examples/teleop/yam.py)
1112

12-
The current example focuses on Franka teleoperation with Meta Quest 3 and GELLO-based setups.
13+
The Franka example supports Meta Quest 3 and GELLO-based setups. The YAM example supports dual-arm Meta Quest 3 teleoperation in simulation or on hardware; install the [YAM extension](../extensions/rcs_yam.md) before using real YAM hardware.
1314

1415
## Inference
1516

‎docs/extensions/rcs_yam.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,9 @@ See `extensions/rcs_yam/README.md` for the full extension documentation and
5858
`extensions/rcs_yam/src/rcs_yam/scripts/test_robot.py` for a bring-up script. For a maintained
5959
example, see `examples/yam/yam_env_cartesian_control.py`, which moves the TCP forward and backward in
6060
synchronous Cartesian mode in simulation or on hardware.
61+
62+
## Teleoperation example
63+
64+
Use [examples/teleop/yam.py](../../examples/teleop/yam.py) to teleoperate YAM arms with a Meta Quest
65+
3. The example runs against simulation or hardware, and can optionally record RealSense cameras. See
66+
the [teleoperation README](../../examples/teleop/README.md) for setup instructions.

0 commit comments

Comments
 (0)