Skip to content

Commit 3bdf118

Browse files
committed
Add i2rt submodule
1 parent c53a82e commit 3bdf118

File tree

5 files changed

+24
-14
lines changed

5 files changed

+24
-14
lines changed

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "i2rt"]
2+
path = i2rt
3+
url = https://github.com/i2rt-robotics/i2rt.git

i2rt

Submodule i2rt added at f3dbf01

pyproject.toml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,7 @@ intelrealsense = [
114114
"pyrealsense2-macosx>=2.54,<2.55.0 ; sys_platform == 'darwin'",
115115
]
116116
phone = ["hebi-py>=2.8.0,<2.12.0", "teleop>=0.1.0,<0.2.0", "fastapi<1.0"]
117-
yam = [
118-
"i2rt>=0.0.1",
119-
"portal>=3.7.0,<4.0.0",
120-
]
117+
yam = ["portal>=3.7.0,<4.0.0"]
121118

122119
# Policies
123120
pi = ["transformers @ git+https://github.com/huggingface/transformers.git@fix/lerobot_openpi"]

src/lerobot/robots/bi_yam_follower/README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,29 @@ ip link show can_leader_l
3636

3737
### Install Dependencies
3838

39-
Install LeRobot with Yam support:
39+
**Step 1: Clone with submodules**
4040
```bash
41-
pip install -e ".[yam]"
41+
# If you haven't cloned yet:
42+
git clone --recursive https://github.com/huggingface/lerobot.git
43+
44+
# If you already cloned without --recursive:
45+
git submodule update --init --recursive
4246
```
4347

44-
This will install:
45-
- `portal` library for client-server communication
46-
- `i2rt` library for low-level motor control of Yam arms
48+
**Step 2: Install i2rt library** (required for the server processes)
49+
```bash
50+
cd i2rt
51+
pip install -e .
52+
cd ..
53+
```
4754

48-
**Note**: If `i2rt` is not available on PyPI, you may need to install it separately from source:
55+
**Step 3: Install LeRobot with Yam support**
4956
```bash
50-
pip install git+https://github.com/your-org/i2rt.git
51-
# OR from a local clone:
52-
# cd /path/to/i2rt && pip install -e .
57+
pip install -e ".[yam]"
5358
```
5459

60+
This will install the `portal` library for client-server communication.
61+
5562
## Running the System
5663

5764
### Step 1: Start the Server Processes

src/lerobot/scripts/setup_bi_yam_servers.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ def find_i2rt_script():
8080
return script_path
8181
except ImportError:
8282
raise RuntimeError(
83-
"Could not import i2rt. Please install it with: pip install -e '.[yam]'"
83+
"Could not import i2rt. Please install it separately:\n"
84+
" cd i2rt && pip install -e . && cd ..\n"
85+
"Then install LeRobot: pip install -e '.[yam]'"
8486
)
8587

8688
raise RuntimeError(

0 commit comments

Comments
 (0)