Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/lerobot/record.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,28 @@
# <- Policy optional if you want to record with a policy \
# --policy.path=${HF_USER}/my_policy \
```

Example recording with bimanual so100:
```shell
python -m lerobot.record \
--robot.type=bi_so100_follower \
--robot.left_arm_port=/dev/tty.usbmodem5A460851411 \
--robot.right_arm_port=/dev/tty.usbmodem5A460812391 \
--robot.id=bimanual_follower \
--robot.cameras='{
left: {"type": "opencv", "index_or_path": 0, "width": 640, "height": 480, "fps": 30},
top: {"type": "opencv", "index_or_path": 1, "width": 640, "height": 480, "fps": 30},
right: {"type": "opencv", "index_or_path": 2, "width": 640, "height": 480, "fps": 30}
}' \
--teleop.type=bi_so100_leader \
--teleop.left_arm_port=/dev/tty.usbmodem5A460828611 \
--teleop.right_arm_port=/dev/tty.usbmodem5A460826981 \
--teleop.id=bimanual_leader \
--display_data=true \
--dataset.repo_id=${HF_USER}/bimanual-so100-handover-cube \
--dataset.num_episodes=25 \
--dataset.single_task="Grab and handover the red cube to the other arm"
```
"""

import logging
Expand All @@ -57,6 +79,7 @@
from lerobot.robots import ( # noqa: F401
Robot,
RobotConfig,
bi_so100_follower,
hope_jr,
koch_follower,
make_robot_from_config,
Expand All @@ -66,6 +89,7 @@
from lerobot.teleoperators import ( # noqa: F401
Teleoperator,
TeleoperatorConfig,
bi_so100_leader,
homunculus,
koch_leader,
make_teleoperator_from_config,
Expand Down
15 changes: 14 additions & 1 deletion src/lerobot/replay.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"""
Replays the actions of an episode from a dataset on a robot.

Example:
Examples:

```shell
python -m lerobot.replay \
Expand All @@ -25,6 +25,18 @@
--dataset.repo_id=aliberts/record-test \
--dataset.episode=2
```

Example replay with bimanual so100:
```shell
python -m lerobot.replay \
--robot.type=bi_so100_follower \
--robot.left_arm_port=/dev/tty.usbmodem5A460851411 \
--robot.right_arm_port=/dev/tty.usbmodem5A460812391 \
--robot.id=bimanual_follower \
--dataset.repo_id=${HF_USER}/bimanual-so100-handover-cube \
--dataset.episode=0
```

"""

import logging
Expand All @@ -39,6 +51,7 @@
from lerobot.robots import ( # noqa: F401
Robot,
RobotConfig,
bi_so100_follower,
hope_jr,
koch_follower,
make_robot_from_config,
Expand Down
18 changes: 18 additions & 0 deletions src/lerobot/robots/bi_so100_follower/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/usr/bin/env python

# Copyright 2025 The HuggingFace Inc. team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from .bi_so100_follower import BiSO100Follower
from .config_bi_so100_follower import BiSO100FollowerConfig
163 changes: 163 additions & 0 deletions src/lerobot/robots/bi_so100_follower/bi_so100_follower.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
#!/usr/bin/env python

# Copyright 2025 The HuggingFace Inc. team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import logging
import time
from functools import cached_property
from typing import Any

from lerobot.cameras.utils import make_cameras_from_configs
from lerobot.robots.so100_follower import SO100Follower
from lerobot.robots.so100_follower.config_so100_follower import SO100FollowerConfig

from ..robot import Robot
from .config_bi_so100_follower import BiSO100FollowerConfig

logger = logging.getLogger(__name__)


class BiSO100Follower(Robot):
"""
[Bimanual SO-100 Follower Arms](https://github.com/TheRobotStudio/SO-ARM100) designed by TheRobotStudio
This bimanual robot can also be easily adapted to use SO-101 follower arms, just replace the SO100Follower class with SO101Follower and SO100FollowerConfig with SO101FollowerConfig.
"""

config_class = BiSO100FollowerConfig
name = "bi_so100_follower"

def __init__(self, config: BiSO100FollowerConfig):
super().__init__(config)
self.config = config

left_arm_config = SO100FollowerConfig(
id=f"{config.id}_left" if config.id else None,
calibration_dir=config.calibration_dir,
port=config.left_arm_port,
disable_torque_on_disconnect=config.left_arm_disable_torque_on_disconnect,
max_relative_target=config.left_arm_max_relative_target,
use_degrees=config.left_arm_use_degrees,
cameras={},
)

right_arm_config = SO100FollowerConfig(
id=f"{config.id}_right" if config.id else None,
calibration_dir=config.calibration_dir,
port=config.right_arm_port,
disable_torque_on_disconnect=config.right_arm_disable_torque_on_disconnect,
max_relative_target=config.right_arm_max_relative_target,
use_degrees=config.right_arm_use_degrees,
cameras={},
)

self.left_arm = SO100Follower(left_arm_config)
self.right_arm = SO100Follower(right_arm_config)
self.cameras = make_cameras_from_configs(config.cameras)

@property
def _motors_ft(self) -> dict[str, type]:
return {f"left_{motor}.pos": float for motor in self.left_arm.bus.motors} | {
f"right_{motor}.pos": float for motor in self.right_arm.bus.motors
}

@property
def _cameras_ft(self) -> dict[str, tuple]:
return {
cam: (self.config.cameras[cam].height, self.config.cameras[cam].width, 3) for cam in self.cameras
}

@cached_property
def observation_features(self) -> dict[str, type | tuple]:
return {**self._motors_ft, **self._cameras_ft}

@cached_property
def action_features(self) -> dict[str, type]:
return self._motors_ft

@property
def is_connected(self) -> bool:
return (
self.left_arm.bus.is_connected
and self.right_arm.bus.is_connected
and all(cam.is_connected for cam in self.cameras.values())
)

def connect(self, calibrate: bool = True) -> None:
self.left_arm.connect(calibrate)
self.right_arm.connect(calibrate)

for cam in self.cameras.values():
cam.connect()

@property
def is_calibrated(self) -> bool:
return self.left_arm.is_calibrated and self.right_arm.is_calibrated

def calibrate(self) -> None:
self.left_arm.calibrate()
self.right_arm.calibrate()

def configure(self) -> None:
self.left_arm.configure()
self.right_arm.configure()

def setup_motors(self) -> None:
self.left_arm.setup_motors()
self.right_arm.setup_motors()

def get_observation(self) -> dict[str, Any]:
obs_dict = {}

# Add "left_" prefix
left_obs = self.left_arm.get_observation()
obs_dict.update({f"left_{key}": value for key, value in left_obs.items()})

# Add "right_" prefix
right_obs = self.right_arm.get_observation()
obs_dict.update({f"right_{key}": value for key, value in right_obs.items()})

for cam_key, cam in self.cameras.items():
start = time.perf_counter()
obs_dict[cam_key] = cam.async_read()
dt_ms = (time.perf_counter() - start) * 1e3
logger.debug(f"{self} read {cam_key}: {dt_ms:.1f}ms")

return obs_dict

def send_action(self, action: dict[str, Any]) -> dict[str, Any]:
# Remove "left_" prefix
left_action = {
key.removeprefix("left_"): value for key, value in action.items() if key.startswith("left_")
}
# Remove "right_" prefix
right_action = {
key.removeprefix("right_"): value for key, value in action.items() if key.startswith("right_")
}

send_action_left = self.left_arm.send_action(left_action)
send_action_right = self.right_arm.send_action(right_action)

# Add prefixes back
prefixed_send_action_left = {f"left_{key}": value for key, value in send_action_left.items()}
prefixed_send_action_right = {f"right_{key}": value for key, value in send_action_right.items()}

return {**prefixed_send_action_left, **prefixed_send_action_right}

def disconnect(self):
self.left_arm.disconnect()
self.right_arm.disconnect()

for cam in self.cameras.values():
cam.disconnect()
39 changes: 39 additions & 0 deletions src/lerobot/robots/bi_so100_follower/config_bi_so100_follower.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#!/usr/bin/env python

# Copyright 2025 The HuggingFace Inc. team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from dataclasses import dataclass, field

from lerobot.cameras import CameraConfig

from ..config import RobotConfig


@RobotConfig.register_subclass("bi_so100_follower")
@dataclass
class BiSO100FollowerConfig(RobotConfig):
left_arm_port: str
right_arm_port: str

# Optional
left_arm_disable_torque_on_disconnect: bool = True
left_arm_max_relative_target: int | None = None
left_arm_use_degrees: bool = False
right_arm_disable_torque_on_disconnect: bool = True
right_arm_max_relative_target: int | None = None
right_arm_use_degrees: bool = False

# cameras (shared between both arms)
cameras: dict[str, CameraConfig] = field(default_factory=dict)
4 changes: 3 additions & 1 deletion src/lerobot/robots/so100_follower/config_so100_follower.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Copyright 2024 The HuggingFace Inc. team. All rights reserved.
#!/usr/bin/env python

# Copyright 2025 The HuggingFace Inc. team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
4 changes: 4 additions & 0 deletions src/lerobot/robots/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ def make_robot_from_config(config: RobotConfig) -> Robot:
from .hope_jr import HopeJrArm

return HopeJrArm(config)
elif config.type == "bi_so100_follower":
from .bi_so100_follower import BiSO100Follower

return BiSO100Follower(config)
elif config.type == "mock_robot":
from tests.mocks.mock_robot import MockRobot

Expand Down
23 changes: 23 additions & 0 deletions src/lerobot/teleoperate.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,27 @@
--teleop.id=blue \
--display_data=true
```

Example teleoperation with bimanual so100:

```shell
python -m lerobot.teleoperate \
--robot.type=bi_so100_follower \
--robot.left_arm_port=/dev/tty.usbmodem5A460851411 \
--robot.right_arm_port=/dev/tty.usbmodem5A460812391 \
--robot.id=bimanual_follower \
--robot.cameras='{
left: {"type": "opencv", "index_or_path": 0, "width": 1920, "height": 1080, "fps": 30},
top: {"type": "opencv", "index_or_path": 1, "width": 1920, "height": 1080, "fps": 30},
right: {"type": "opencv", "index_or_path": 2, "width": 1920, "height": 1080, "fps": 30}
}' \
--teleop.type=bi_so100_leader \
--teleop.left_arm_port=/dev/tty.usbmodem5A460828611 \
--teleop.right_arm_port=/dev/tty.usbmodem5A460826981 \
--teleop.id=bimanual_leader \
--display_data=true
```

"""

import logging
Expand All @@ -43,6 +64,7 @@
from lerobot.robots import ( # noqa: F401
Robot,
RobotConfig,
bi_so100_follower,
hope_jr,
koch_follower,
make_robot_from_config,
Expand All @@ -52,6 +74,7 @@
from lerobot.teleoperators import ( # noqa: F401
Teleoperator,
TeleoperatorConfig,
bi_so100_leader,
gamepad,
homunculus,
koch_leader,
Expand Down
18 changes: 18 additions & 0 deletions src/lerobot/teleoperators/bi_so100_leader/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/usr/bin/env python

# Copyright 2025 The HuggingFace Inc. team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from .bi_so100_leader import BiSO100Leader
from .config_bi_so100_leader import BiSO100LeaderConfig
Loading
Loading