Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] main from huggingface:main #11

Merged
merged 1 commit into from
Feb 25, 2025
Merged

[pull] main from huggingface:main #11

merged 1 commit into from
Feb 25, 2025

Conversation

pull[bot]
Copy link

@pull pull bot commented Feb 25, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

This pull request introduces support for the LeKiwi robot, a mobile manipulator platform, including configuration files, control scripts, and documentation. It adds a new robot type, lekiwi, with configurations for the leader and follower arms, cameras, and teleoperation keys. The changes also include a remote control mode that allows controlling the robot's follower arm and mobile base via ZeroMQ sockets, and a new tutorial for using the LeKiwi robot with LeRobot.

New Features:

  • Introduces the LeKiwi robot configuration, a mobile manipulator with a leader arm for teleoperation and a follower arm on a mobile base.
  • Adds a remote control mode for the LeKiwi robot, enabling control of the follower arm and mobile base via ZeroMQ sockets.

Enhancements:

  • Adds keyboard teleoperation support for the LeKiwi robot's mobile base, allowing users to control the robot's movement using keyboard inputs.
  • Improves the calibration process for Feetech motors by adding manual calibration routines.
  • Adds support for reading and sending camera frames and motor states over ZeroMQ sockets.

Build:

  • Adds pynput and pyzmq as dependencies to the project.

Documentation:

  • Adds a tutorial for using the LeKiwi robot with LeRobot, including instructions for sourcing parts, installing software, assembling the robot, calibrating the arms, teleoperating the robot, recording datasets, visualizing datasets, replaying episodes, training a policy, and evaluating the policy.

Tests:

  • Adds a test to ensure that the LeKiwi robot configuration is correctly loaded.

@pull pull bot added the ⤵️ pull label Feb 25, 2025
@pull pull bot merged commit aca464c into Stars1233:main Feb 25, 2025
Copy link

sourcery-ai bot commented Feb 25, 2025

Reviewer's Guide by Sourcery

This pull request introduces support for the LeKiwi mobile manipulator robot, including new robot configurations, control scripts, and a comprehensive example. It also adds dependencies and updates the SO100 example.

Sequence diagram for LeKiwi teleoperation

sequenceDiagram
    participant User
    participant Laptop
    participant LeKiwiServer
    participant Motors

    User->>Laptop: Presses keys (w, a, s, d, z, x, r, f)
    Laptop->>LeKiwiServer: Sends wheel commands and leader arm positions
    LeKiwiServer->>Motors: Sets motor speeds and arm positions
    LeKiwiServer->>Laptop: Sends camera feed and robot state
    Laptop->>User: Displays camera feed and robot state
Loading

Updated class diagram for RobotConfig and subclasses

classDiagram
    class RobotConfig {
        +type: str
        +register_subclass(cls: type) : type
    }
    class StretchRobotConfig {
        +mock: bool
    }
    class LeKiwiRobotConfig {
        +max_relative_target: int | None
        +ip: str
        +port: int
        +video_port: int
        +cameras: dict[str, CameraConfig]
        +calibration_dir: str
        +leader_arms: dict[str, MotorsBusConfig]
        +follower_arms: dict[str, MotorsBusConfig]
        +teleop_keys: dict[str, str]
        +mock: bool
    }
    RobotConfig <|-- StretchRobotConfig : inherits
    RobotConfig <|-- LeKiwiRobotConfig : inherits
    class CameraConfig {
        <<Abstract>>
    }
    class MotorsBusConfig {
        <<Abstract>>
    }
    LeKiwiRobotConfig *-- CameraConfig : cameras
    LeKiwiRobotConfig *-- MotorsBusConfig : leader_arms
    LeKiwiRobotConfig *-- MotorsBusConfig : follower_arms
    note for LeKiwiRobotConfig "New class for LeKiwi robot configuration"
Loading

Updated class diagram for ControlConfig and subclasses

classDiagram
    class ControlConfig {
        +type: str
        +register_subclass(cls: type) : type
    }
    class ReplayControlConfig {
        +local_files_only: bool
    }
    class RemoteRobotConfig {
        +log_interval: int
    }
    ControlConfig <|-- ReplayControlConfig : inherits
    ControlConfig <|-- RemoteRobotConfig : inherits
    note for RemoteRobotConfig "New class for remote robot control configuration"
Loading

File-Level Changes

Change Details Files
Introduces a new robot configuration for the LeKiwi mobile manipulator, including network settings, camera configurations, and motor bus configurations for both leader and follower arms.
  • Adds LeKiwiRobotConfig class with fields for network IP and ports, camera settings, calibration directory, leader/follower arm configurations, and teleoperation keys.
  • Defines default configurations for cameras (front and wrist) using OpenCVCameraConfig.
  • Specifies motor bus configurations for leader and follower arms using FeetechMotorsBusConfig, including motor mappings (name to index and model).
  • Introduces default teleoperation key mappings for movement and speed control.
lerobot/common/robot_devices/robots/configs.py
Adds support for controlling the LeKiwi robot via a remote robot control type, including calibration and teleoperation functionalities.
  • Adds a RemoteRobotConfig class for remote robot control settings.
  • Modifies control_robot function to include a case for RemoteRobotConfig, which calls run_lekiwi to start the remote control process.
  • Adds conditional calibration logic for LeKiwi robots, allowing calibration of either the leader or follower arm independently.
  • Adds example usage for remote controlled robots like LeKiwi.
lerobot/scripts/control_robot.py
Adds the LeKiwi robot type to the robot factory function.
  • Adds a case to make_robot_config to return a LeKiwiRobotConfig instance when robot_type is 'lekiwi'.
  • Adds a case to make_robot_from_config to return a MobileManipulator instance when the config is a LeKiwiRobotConfig.
lerobot/common/robot_devices/robots/utils.py
Adds a new class for controlling the LeKiwi mobile manipulator robot.
  • Introduces MobileManipulator class for connecting to and controlling a remote mobile manipulator robot.
  • Implements methods for connecting to the robot, calibrating the leader and follower arms, capturing observations, sending actions, and disconnecting.
  • Includes logic for keyboard teleoperation of the mobile base, with adjustable speed levels.
  • Uses ZeroMQ sockets for communication with the remote robot.
  • Implements helper functions for converting between body-frame velocities and wheel raw commands.
  • Adds LeKiwi class for controlling the mobile base wheels.
lerobot/common/robot_devices/robots/mobile_manipulator.py
Adds a new script for running the LeKiwi robot in remote mode.
  • Introduces run_lekiwi function to set up cameras, motors, and ZeroMQ sockets for remote control.
  • Includes logic for calibrating the follower arm, processing incoming commands, and sending back sensor and camera data.
  • Uses threading for asynchronous camera capture.
lerobot/common/robot_devices/robots/lekiwi_remote.py
Adds a new example for using the LeKiwi robot with LeRobot.
  • Introduces a new markdown file with instructions for sourcing parts, installing software, assembling the robot, calibrating, teleoperating, recording datasets, visualizing datasets, replaying episodes, training policies, and evaluating policies.
examples/11_use_lekiwi.md
Adds dependencies to the project.
  • Adds pynput and pyzmq as dependencies.
pyproject.toml
Updates the SO100 example.
  • Updates the SO100 example to include a Discord link.
examples/10_use_so100.md
Adds support for LeKiwi to torque enable.
  • Adds lekiwi to the list of robots that use TorqueMode.
lerobot/common/robot_devices/robots/manipulator.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

gitstream-cm bot commented Feb 25, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 2204/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

Copy link

coderabbitai bot commented Feb 25, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant