259 lines
10 KiB
Python
259 lines
10 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 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 Motor, MotorCalibration, MotorNormMode
|
|
from lerobot.common.motors.feetech import (
|
|
FeetechMotorsBus,
|
|
OperatingMode,
|
|
)
|
|
|
|
from ..robot import Robot
|
|
from ..utils import ensure_safe_goal_position
|
|
from .config_lekiwi import LeKiwiConfig
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class LeKiwi(Robot):
|
|
"""
|
|
The robot includes a three omniwheel mobile base and a remote follower arm.
|
|
The leader arm is connected locally (on the laptop) and its joint positions are recorded and then
|
|
forwarded to the remote follower arm (after applying a safety clamp).
|
|
In parallel, keyboard teleoperation is used to generate raw velocity commands for the wheels.
|
|
"""
|
|
|
|
config_class = LeKiwiConfig
|
|
name = "lekiwi"
|
|
|
|
def __init__(self, config: LeKiwiConfig):
|
|
super().__init__(config)
|
|
self.config = config
|
|
self.id = config.id
|
|
self.bus = FeetechMotorsBus(
|
|
port=self.config.port,
|
|
motors={
|
|
# arm
|
|
"arm_shoulder_pan": Motor(1, "sts3215", MotorNormMode.RANGE_M100_100),
|
|
"arm_shoulder_lift": Motor(2, "sts3215", MotorNormMode.RANGE_M100_100),
|
|
"arm_elbow_flex": Motor(3, "sts3215", MotorNormMode.RANGE_M100_100),
|
|
"arm_wrist_flex": Motor(4, "sts3215", MotorNormMode.RANGE_M100_100),
|
|
"arm_wrist_roll": Motor(5, "sts3215", MotorNormMode.RANGE_M100_100),
|
|
"arm_gripper": Motor(6, "sts3215", MotorNormMode.RANGE_0_100),
|
|
# base
|
|
"base_left_wheel": Motor(7, "sts3215", MotorNormMode.RANGE_M100_100),
|
|
"base_right_wheel": Motor(8, "sts3215", MotorNormMode.RANGE_M100_100),
|
|
"base_back_wheel": Motor(9, "sts3215", MotorNormMode.RANGE_M100_100),
|
|
},
|
|
calibration=self.calibration,
|
|
)
|
|
self.arm_motors = [m for m in self.bus.names if m.startswith("arm")]
|
|
self.base_motors = [m for m in self.bus.names if m.startswith("base")]
|
|
self.cameras = make_cameras_from_configs(config.cameras)
|
|
|
|
@property
|
|
def state_feature(self) -> dict:
|
|
return {
|
|
"dtype": "float32",
|
|
"shape": (len(self.bus),),
|
|
"names": {"motors": list(self.bus.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
|
|
|
|
@property
|
|
def is_connected(self) -> bool:
|
|
# TODO(aliberts): add cam.is_connected for cam in self.cameras
|
|
return self.bus.is_connected
|
|
|
|
def connect(self) -> None:
|
|
if self.is_connected:
|
|
raise DeviceAlreadyConnectedError(f"{self} already connected")
|
|
|
|
self.bus.connect()
|
|
if not self.is_calibrated:
|
|
self.calibrate()
|
|
|
|
for cam in self.cameras.values():
|
|
cam.connect()
|
|
|
|
self.configure()
|
|
logger.info(f"{self} connected.")
|
|
|
|
@property
|
|
def is_calibrated(self) -> bool:
|
|
return self.bus.is_calibrated
|
|
|
|
# TODO(Steven): I think we should extend this to give the user the option of re-calibrate
|
|
# calibrate(recalibrate: bool = False) -> None:
|
|
# If true, then we overwrite the previous calibration file with new values
|
|
def calibrate(self) -> None:
|
|
logger.info(f"\nRunning calibration of {self}")
|
|
|
|
motors = self.arm_motors + self.base_motors
|
|
|
|
self.bus.disable_torque(self.arm_motors)
|
|
for name in self.arm_motors:
|
|
self.bus.write("Operating_Mode", name, OperatingMode.POSITION.value)
|
|
|
|
input("Move robot to the middle of its range of motion and press ENTER....")
|
|
homing_offsets = self.bus.set_half_turn_homings(motors)
|
|
|
|
# TODO(Steven): Might be worth to do this also in other robots but it should be added in the docs
|
|
full_turn_motor = [
|
|
motor for motor in motors if any(keyword in motor for keyword in ["wheel", "gripper"])
|
|
]
|
|
unknown_range_motors = [motor for motor in motors if motor not in full_turn_motor]
|
|
|
|
print(
|
|
f"Move all arm joints except '{full_turn_motor}' sequentially through their "
|
|
"entire ranges of motion.\nRecording positions. Press ENTER to stop..."
|
|
)
|
|
range_mins, range_maxes = self.bus.record_ranges_of_motion(unknown_range_motors)
|
|
for name in full_turn_motor:
|
|
range_mins[name] = 0
|
|
range_maxes[name] = 4095
|
|
|
|
self.calibration = {}
|
|
for name, motor in self.bus.motors.items():
|
|
self.calibration[name] = MotorCalibration(
|
|
id=motor.id,
|
|
drive_mode=0,
|
|
homing_offset=homing_offsets[name],
|
|
range_min=range_mins[name],
|
|
range_max=range_maxes[name],
|
|
)
|
|
|
|
self.bus.write_calibration(self.calibration)
|
|
self._save_calibration()
|
|
print("Calibration saved to", self.calibration_fpath)
|
|
|
|
def configure(self):
|
|
# Set-up arm actuators (position mode)
|
|
# We assume that at connection time, arm is in a rest position,
|
|
# and torque can be safely disabled to run calibration.
|
|
self.bus.disable_torque(self.arm_motors)
|
|
for name in self.arm_motors:
|
|
self.bus.write("Operating_Mode", name, OperatingMode.POSITION.value)
|
|
# Set P_Coefficient to lower value to avoid shakiness (Default is 32)
|
|
self.bus.write("P_Coefficient", name, 16)
|
|
# Set I_Coefficient and D_Coefficient to default value 0 and 32
|
|
self.bus.write("I_Coefficient", name, 0)
|
|
self.bus.write("D_Coefficient", name, 32)
|
|
# Set Maximum_Acceleration to 254 to speedup acceleration and deceleration of
|
|
# the motors. Note: this configuration is not in the official STS3215 Memory Table
|
|
self.bus.write("Maximum_Acceleration", name, 254)
|
|
self.bus.write("Acceleration", name, 254)
|
|
|
|
for name in self.base_motors:
|
|
self.bus.write("Operating_Mode", name, OperatingMode.VELOCITY.value)
|
|
|
|
self.bus.enable_torque() # TODO(Steven): Operation has failed with: ConnectionError: Failed to write 'Lock' on id_=6 with '1' after 1 tries. [TxRxResult] Incorrect status packet!
|
|
|
|
def get_observation(self) -> dict[str, Any]:
|
|
if not self.is_connected:
|
|
raise DeviceNotConnectedError(f"{self} is not connected.")
|
|
|
|
obs_dict = {OBS_IMAGES: {}}
|
|
|
|
# Read actuators position for arm and vel for base
|
|
start = time.perf_counter()
|
|
arm_pos = self.bus.sync_read("Present_Position", self.arm_motors)
|
|
base_vel = self.bus.sync_read("Present_Speed", self.base_motors)
|
|
obs_dict[OBS_STATE] = {**arm_pos, **base_vel}
|
|
dt_ms = (time.perf_counter() - start) * 1e3
|
|
logger.debug(f"{self} read state: {dt_ms:.1f}ms")
|
|
|
|
# Capture images from cameras
|
|
for cam_key, cam in self.cameras.items():
|
|
start = time.perf_counter()
|
|
obs_dict[OBS_IMAGES][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]:
|
|
# Copied from S100 robot
|
|
"""Command lekiwi 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.
|
|
|
|
Raises:
|
|
RobotDeviceNotConnectedError: if robot is not connected.
|
|
|
|
Returns:
|
|
np.ndarray: the action sent to the motors, potentially clipped.
|
|
"""
|
|
if not self.is_connected:
|
|
raise DeviceNotConnectedError(f"{self} is not connected.")
|
|
|
|
arm_goal_pos = {k: v for k, v in action.items() if k in self.arm_motors}
|
|
base_goal_vel = {k: v for k, v in action.items() if k in self.base_motors}
|
|
|
|
# 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.bus.sync_read("Present_Position", self.arm_motors)
|
|
goal_present_pos = {key: (g_pos, present_pos[key]) for key, g_pos in arm_goal_pos.items()}
|
|
arm_safe_goal_pos = ensure_safe_goal_position(goal_present_pos, self.config.max_relative_target)
|
|
arm_goal_pos = arm_safe_goal_pos
|
|
|
|
# TODO(Steven): Message fetching failed: Magnitude 34072 exceeds 32767 (max for sign_bit_index=15)
|
|
# TODO(Steven): IMO, this should be a check in the motor bus
|
|
|
|
# Send goal position to the actuators
|
|
self.bus.sync_write("Goal_Position", arm_goal_pos)
|
|
self.bus.sync_write("Goal_Speed", base_goal_vel)
|
|
|
|
return {**arm_goal_pos, **base_goal_vel}
|
|
|
|
def stop_base(self):
|
|
self.bus.sync_write("Goal_Speed", dict.fromkeys(self.base_motors, 0), num_retry=5)
|
|
logger.info("Base motors stopped")
|
|
|
|
def disconnect(self):
|
|
if not self.is_connected:
|
|
raise DeviceNotConnectedError(f"{self} is not connected.")
|
|
|
|
self.stop_base()
|
|
self.bus.disconnect(self.config.disable_torque_on_disconnect)
|
|
for cam in self.cameras.values():
|
|
cam.disconnect()
|
|
|
|
logger.info(f"{self} disconnected.")
|