228 lines
9.2 KiB
Python
228 lines
9.2 KiB
Python
#!/usr/bin/env python
|
|
|
|
# Copyright 2024 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 json
|
|
import logging
|
|
import time
|
|
from typing import Any
|
|
|
|
from lerobot.common.cameras.utils import make_cameras_from_configs
|
|
from lerobot.common.constants import OBS_IMAGES, OBS_STATE
|
|
from lerobot.common.errors import DeviceAlreadyConnectedError, DeviceNotConnectedError
|
|
from lerobot.common.motors import CalibrationMode, Motor, TorqueMode
|
|
from lerobot.common.motors.dynamixel import (
|
|
DynamixelMotorsBus,
|
|
OperatingMode,
|
|
run_arm_calibration,
|
|
)
|
|
|
|
from ..robot import Robot
|
|
from ..utils import ensure_safe_goal_position
|
|
from .configuration_koch import KochRobotConfig
|
|
|
|
|
|
class KochRobot(Robot):
|
|
"""
|
|
- [Koch v1.0](https://github.com/AlexanderKoch-Koch/low_cost_robot), with and without the wrist-to-elbow
|
|
expansion, developed by Alexander Koch from [Tau Robotics](https://tau-robotics.com)
|
|
- [Koch v1.1](https://github.com/jess-moss/koch-v1-1) developed by Jess Moss
|
|
"""
|
|
|
|
config_class = KochRobotConfig
|
|
name = "koch"
|
|
|
|
def __init__(self, config: KochRobotConfig):
|
|
super().__init__(config)
|
|
self.config = config
|
|
self.robot_type = config.type
|
|
|
|
self.arm = DynamixelMotorsBus(
|
|
port=self.config.port,
|
|
motors={
|
|
"shoulder_pan": Motor(1, "xl430-w250", CalibrationMode.RANGE_M100_100),
|
|
"shoulder_lift": Motor(2, "xl430-w250", CalibrationMode.RANGE_M100_100),
|
|
"elbow_flex": Motor(3, "xl330-m288", CalibrationMode.RANGE_M100_100),
|
|
"wrist_flex": Motor(4, "xl330-m288", CalibrationMode.RANGE_M100_100),
|
|
"wrist_roll": Motor(5, "xl330-m288", CalibrationMode.RANGE_M100_100),
|
|
"gripper": Motor(6, "xl330-m288", CalibrationMode.RANGE_0_100),
|
|
},
|
|
)
|
|
self.cameras = make_cameras_from_configs(config.cameras)
|
|
|
|
self.is_connected = False
|
|
self.logs = {}
|
|
|
|
@property
|
|
def state_feature(self) -> dict:
|
|
return {
|
|
"dtype": "float32",
|
|
"shape": (len(self.arm),),
|
|
"names": {"motors": list(self.arm.motors)},
|
|
}
|
|
|
|
@property
|
|
def action_feature(self) -> dict:
|
|
return self.state_feature
|
|
|
|
@property
|
|
def camera_features(self) -> dict[str, dict]:
|
|
cam_ft = {}
|
|
for cam_key, cam in self.cameras.items():
|
|
cam_ft[cam_key] = {
|
|
"shape": (cam.height, cam.width, cam.channels),
|
|
"names": ["height", "width", "channels"],
|
|
"info": None,
|
|
}
|
|
return cam_ft
|
|
|
|
def configure(self) -> None:
|
|
for name in self.arm.names:
|
|
# Torque must be deactivated to change values in the motors' EEPROM area
|
|
# We assume that at configuration time, arm is in a rest position,
|
|
# and torque can be safely disabled to run calibration.
|
|
self.arm.write("Torque_Enable", name, TorqueMode.DISABLED.value)
|
|
if name != "gripper":
|
|
# Use 'extended position mode' for all motors except gripper, because in joint mode the servos
|
|
# can't rotate more than 360 degrees (from 0 to 4095) And some mistake can happen while
|
|
# assembling the arm, you could end up with a servo with a position 0 or 4095 at a crucial
|
|
# point
|
|
self.arm.write("Operating_Mode", name, OperatingMode.Extended_Position.value)
|
|
|
|
# Use 'position control current based' for gripper to be limited by the limit of the current.
|
|
# For the follower gripper, it means it can grasp an object without forcing too much even tho,
|
|
# its goal position is a complete grasp (both gripper fingers are ordered to join and reach a touch).
|
|
# For the leader gripper, it means we can use it as a physical trigger, since we can force with our finger
|
|
# to make it move, and it will move back to its original target position when we release the force.
|
|
self.arm.write("Operating_Mode", "gripper", OperatingMode.Current_Position.value)
|
|
|
|
# Set better PID values to close the gap between recorded states and actions
|
|
# TODO(rcadene): Implement an automatic procedure to set optimal PID values for each motor
|
|
self.arm.write("Position_P_Gain", "elbow_flex", 1500)
|
|
self.arm.write("Position_I_Gain", "elbow_flex", 0)
|
|
self.arm.write("Position_D_Gain", "elbow_flex", 600)
|
|
|
|
for name in self.arm.names:
|
|
self.arm.write("Torque_Enable", name, TorqueMode.ENABLED.value)
|
|
|
|
logging.info("Torque enabled.")
|
|
|
|
# Move gripper to 45 degrees so that we can use it as a trigger.
|
|
self.arm.write("Goal_Position", "gripper", self.config.gripper_open_degree)
|
|
|
|
@property
|
|
def is_connected(self) -> bool:
|
|
return self.arm.is_connected # TODO(aliberts): add cam.is_connected for cam in self.cameras
|
|
|
|
def connect(self) -> None:
|
|
if self.is_connected:
|
|
raise DeviceAlreadyConnectedError(
|
|
"ManipulatorRobot is already connected. Do not run `robot.connect()` twice."
|
|
)
|
|
|
|
logging.info("Connecting arm.")
|
|
self.arm.connect()
|
|
self.configure()
|
|
# self.calibrate() # TODO
|
|
|
|
# Check arm can be read
|
|
self.arm.sync_read("Present_Position")
|
|
|
|
# Connect the cameras
|
|
for cam in self.cameras.values():
|
|
cam.connect()
|
|
|
|
self.is_connected = True
|
|
|
|
def calibrate(self) -> None:
|
|
"""After calibration all motors function in human interpretable ranges.
|
|
Rotations are expressed in degrees in nominal range of [-180, 180],
|
|
and linear motions (like gripper of Aloha) in nominal range of [0, 100].
|
|
"""
|
|
if self.calibration_fpath.exists():
|
|
with open(self.calibration_fpath) as f:
|
|
calibration = json.load(f)
|
|
else:
|
|
# TODO(rcadene): display a warning in __init__ if calibration file not available
|
|
logging.info(f"Missing calibration file '{self.calibration_fpath}'")
|
|
calibration = run_arm_calibration(self.arm, self.robot_type, self.name, "follower")
|
|
|
|
logging.info(f"Calibration is done! Saving calibration file '{self.calibration_fpath}'")
|
|
self.calibration_fpath.parent.mkdir(parents=True, exist_ok=True)
|
|
with open(self.calibration_fpath, "w") as f:
|
|
json.dump(calibration, f)
|
|
|
|
self.arm.set_calibration(calibration)
|
|
|
|
def get_observation(self) -> dict[str, Any]:
|
|
obs_dict = {}
|
|
|
|
# Read arm position
|
|
before_read_t = time.perf_counter()
|
|
obs_dict[OBS_STATE] = self.arm.sync_read("Present_Position")
|
|
self.logs["read_pos_dt_s"] = time.perf_counter() - before_read_t
|
|
|
|
# Capture images from cameras
|
|
for cam_key, cam in self.cameras.items():
|
|
before_camread_t = time.perf_counter()
|
|
obs_dict[f"{OBS_IMAGES}.{cam_key}"] = cam.async_read()
|
|
self.logs[f"read_camera_{cam_key}_dt_s"] = cam.logs["delta_timestamp_s"]
|
|
self.logs[f"async_read_camera_{cam_key}_dt_s"] = time.perf_counter() - before_camread_t
|
|
|
|
return obs_dict
|
|
|
|
def send_action(self, action: dict[str, float]) -> dict[str, float]:
|
|
"""Command arm to move to a target joint configuration.
|
|
|
|
The relative action magnitude may be clipped depending on the configuration parameter
|
|
`max_relative_target`. In this case, the action sent differs from original action.
|
|
Thus, this function always returns the action actually sent.
|
|
|
|
Args:
|
|
action (dict[str, float]): The goal positions for the motors.
|
|
|
|
Returns:
|
|
dict[str, float]: The action sent to the motors, potentially clipped.
|
|
"""
|
|
goal_pos = action
|
|
|
|
# Cap goal position when too far away from present position.
|
|
# /!\ Slower fps expected due to reading from the follower.
|
|
if self.config.max_relative_target is not None:
|
|
present_pos = self.arm.sync_read("Present_Position")
|
|
goal_present_pos = {key: (g_pos, present_pos[key]) for key, g_pos in goal_pos.items()}
|
|
goal_pos = ensure_safe_goal_position(goal_present_pos, self.config.max_relative_target)
|
|
|
|
# Send goal position to the arm
|
|
self.arm.sync_write("Goal_Position", goal_pos)
|
|
|
|
return goal_pos
|
|
|
|
def print_logs(self):
|
|
# TODO(aliberts): move robot-specific logs logic here
|
|
pass
|
|
|
|
def disconnect(self):
|
|
if not self.is_connected:
|
|
raise DeviceNotConnectedError(
|
|
"ManipulatorRobot is not connected. You need to run `robot.connect()` before disconnecting."
|
|
)
|
|
|
|
self.arm.disconnect()
|
|
for cam in self.cameras.values():
|
|
cam.disconnect()
|
|
|
|
self.is_connected = False
|