Skip to content

Commit 772019d

Browse files
committed
Added demo instructions
1 parent bc6b0fa commit 772019d

1 file changed

Lines changed: 116 additions & 0 deletions

File tree

tests/RUN_DEMO.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# Running OpenArm Demos
2+
3+
This guide shows you how to run the included demonstration examples on your OpenArm bimanual robot.
4+
5+
## Prerequisites
6+
7+
- OpenArm module installed and configured
8+
- Robot powered on and connected via CAN bus
9+
- CAN interfaces configured (should auto-configure via udev rules)
10+
11+
## Safety First: Move to Zero Position
12+
13+
**IMPORTANT:** Always start by moving the arms to their zero position before running any demo.
14+
15+
```bash
16+
cd ~/humanoids/openarm_module
17+
python scripts/move_to_zero.py
18+
```
19+
20+
This ensures the robot starts from a safe, known configuration.
21+
22+
---
23+
24+
## Demo 1: Wave Demo (Scripted Motion)
25+
26+
A simple scripted demonstration where both arms perform a wave motion.
27+
28+
```bash
29+
cd ~/humanoids/openarm_module
30+
python tests/openarm_wave_demo.py
31+
```
32+
33+
**What it does:** Moves right arm in a synchronized waving pattern.
34+
35+
---
36+
37+
## Demo 2: Replay Recorded Demonstrations
38+
39+
The following demos replay teleoperated demonstrations that were previously recorded.
40+
41+
### RPL Demo 1
42+
43+
```bash
44+
lerobot-replay \
45+
--robot.type=bi_openarm_follower \
46+
--robot.left_arm_config.port=can1 \
47+
--robot.left_arm_config.side=left \
48+
--robot.right_arm_config.port=can0 \
49+
--robot.right_arm_config.side=right \
50+
--dataset.fps=60 \
51+
--dataset.repo_id=$HOME/humanoids/openarm_module/tests/rpl_demo \
52+
--dataset.episode=0
53+
```
54+
55+
### RPL Demo 2
56+
57+
```bash
58+
lerobot-replay \
59+
--robot.type=bi_openarm_follower \
60+
--robot.left_arm_config.port=can1 \
61+
--robot.left_arm_config.side=left \
62+
--robot.right_arm_config.port=can0 \
63+
--robot.right_arm_config.side=right \
64+
--dataset.fps=60 \
65+
--dataset.repo_id=$HOME/humanoids/openarm_module/tests/rpl_demo2 \
66+
--dataset.episode=0
67+
```
68+
69+
### RPL Demo 3
70+
71+
```bash
72+
lerobot-replay \
73+
--robot.type=bi_openarm_follower \
74+
--robot.left_arm_config.port=can1 \
75+
--robot.left_arm_config.side=left \
76+
--robot.right_arm_config.port=can0 \
77+
--robot.right_arm_config.side=right \
78+
--dataset.fps=60 \
79+
--dataset.repo_id=$HOME/humanoids/openarm_module/tests/rpl_demo3 \
80+
--dataset.episode=0
81+
```
82+
83+
---
84+
85+
## Safety Notes
86+
87+
- Always ensure the workspace is clear before running demos
88+
- Keep the emergency stop within reach
89+
- Start with `move_to_zero.py` before each demo session
90+
- If the robot behaves unexpectedly, press Ctrl+C to stop execution
91+
92+
---
93+
94+
## Recording Your Own Demos
95+
96+
To record your own demonstrations:
97+
98+
```bash
99+
lerobot-record \
100+
--robot.type=bi_openarm_follower \
101+
--robot.left_arm_config.port=can1 \
102+
--robot.left_arm_config.side=left \
103+
--robot.right_arm_config.port=can0 \
104+
--robot.right_arm_config.side=right \
105+
--teleop.type=openarm_bi_gamepad_joints \
106+
--teleop.joint_velocity_scale=60.0 \
107+
--dataset.repo_id=$HOME/humanoids/openarm_module/examples/my_demo \
108+
--dataset.single_task="Your task description" \
109+
--dataset.fps=60 \
110+
--dataset.num_episodes=1 \
111+
--dataset.episode_time_s=30 \
112+
--dataset.reset_time_s=10 \
113+
--dataset.push_to_hub=false
114+
```
115+
116+
See the main [README.md](README.md) for full teleoperation and recording instructions.

0 commit comments

Comments
 (0)