reachy_mini  by pollen-robotics

SDK for controlling an expressive robot

Created 6 months ago
296 stars

Top 89.6% on SourcePulse

GitHubView on GitHub
Project Summary

Reachy Mini provides an open-source SDK and API for its namesake robot, designed for human-robot interaction, creative coding, and AI experimentation. It aims to be an affordable, user-friendly, and hackable platform, allowing developers to focus on building AI applications rather than low-level hardware control. The project offers both a real robot and a MuJoCo simulation environment for development.

How It Works

The system is built around a daemon that acts as a central communication hub, managing interactions with the robot's motors and sensors or the MuJoCo simulation. Users can control Reachy Mini via a Python SDK for direct integration into scripts or a HTTP REST API for broader application connectivity. This dual-interface approach facilitates flexible development workflows, from rapid prototyping in simulation to complex AI integrations.

Quick Start & Requirements

  • Installation: Install via pip: pip install reachy-mini. For development from source: git clone https://github.com/pollen-robotics/reachy_mini followed by pip install -e ./reachy_mini.
  • Prerequisites: Python 3.10-3.13, git-lfs. For simulation: pip install reachy-mini[mujoco].
  • Running the Daemon: Execute reachy-mini-daemon or python -m reachy_mini.daemon.app.main. For simulation, use reachy-mini-daemon --sim. For the Lite (USB) version, specify the serial port: reachy-mini-daemon -p <serial_port>.
  • Assembly: Estimated assembly time is approximately 3 hours.
  • Documentation: Python SDK documentation and HTTP API documentation are available.

Highlighted Details

  • Offers both a Python SDK for programmatic control and a REST API for external application integration.
  • Includes a MuJoCo simulation environment for prototyping applications before deploying on physical hardware.
  • Features a conversational demo (reachy_mini_conversation_demo) and showcases various applications on Hugging Face Spaces.

Maintenance & Community

This project is actively maintained by the Pollen Robotics and Hugging Face teams. Contributions are welcomed through GitHub issues for bug reports/feature requests and pull requests for code contributions.

Licensing & Compatibility

The software is licensed under the Apache 2.0 License. The license for the robot design files is marked as "TODO". The system is supported on Linux and macOS, with partial support and less testing on Windows.

Limitations & Caveats

Reachy Mini is currently in beta, meaning users should expect bugs, some of which may not be prioritized for immediate fixes. Windows support is less tested. The licensing for the robot's design files is not yet specified.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
54
Issues (30d)
53
Star History
79 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.