Metadata-Version: 2.4
Name: reachy-mini-bwc
Version: 1.3.1.post1
Summary: Brain Wave Collective maintained fork of reachy-mini (originally developed by Pollen Robotics).
Author-email: Pollen Robotics <contact@pollen-robotics.com>
Maintainer: Brain Wave Collective
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.2.5
Requires-Dist: scipy<2.0.0,>=1.15.3
Requires-Dist: reachy_mini_motor_controller>=1.5.3
Requires-Dist: eclipse-zenoh~=1.7.0
Requires-Dist: opencv-python<=5.0
Requires-Dist: cv2_enumerate_cameras>=1.2.1
Requires-Dist: psutil
Requires-Dist: jinja2
Requires-Dist: uvicorn[standard]
Requires-Dist: fastapi
Requires-Dist: pyserial
Requires-Dist: huggingface-hub>=1.4.0
Requires-Dist: sounddevice<0.6,>=0.5.1
Requires-Dist: soundfile==0.13.1
Requires-Dist: reachy-mini-rust-kinematics>=1.0.3
Requires-Dist: asgiref
Requires-Dist: aiohttp
Requires-Dist: log-throttling==0.0.3
Requires-Dist: pyusb>=1.2.1
Requires-Dist: libusb_package>=1.0.26.3
Requires-Dist: pip>=25
Requires-Dist: rich
Requires-Dist: questionary
Requires-Dist: websockets<16,>=12
Requires-Dist: toml
Requires-Dist: rustypot>=1.4.2
Requires-Dist: pyyaml>=6.0
Requires-Dist: requests>=2.28.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Requires-Dist: ruff==0.12.0; extra == "dev"
Requires-Dist: onshape-to-robot==1.7.6; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: mypy==1.18.2; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: types-toml; extra == "dev"
Provides-Extra: examples
Requires-Dist: pynput; extra == "examples"
Provides-Extra: mujoco
Requires-Dist: mujoco==3.3.0; extra == "mujoco"
Provides-Extra: nn-kinematics
Requires-Dist: onnxruntime==1.22.1; extra == "nn-kinematics"
Provides-Extra: placo-kinematics
Requires-Dist: placo==0.9.14; sys_platform != "win32" and extra == "placo-kinematics"
Provides-Extra: gstreamer
Requires-Dist: PyGObject<=3.46.0,>=3.42.2; extra == "gstreamer"
Provides-Extra: rerun
Requires-Dist: rerun-sdk==0.27.2; extra == "rerun"
Requires-Dist: urdf-parser-py==0.0.4; extra == "rerun"
Provides-Extra: wireless-version
Requires-Dist: semver<4,>=3; extra == "wireless-version"
Requires-Dist: nmcli>=1.5; sys_platform == "linux" and extra == "wireless-version"
Requires-Dist: pollen_BMI088_imu_library; sys_platform == "linux" and extra == "wireless-version"
Requires-Dist: gpiozero>=2.0.0; sys_platform == "linux" and extra == "wireless-version"
Requires-Dist: lgpio>=0.2.2.0; sys_platform == "linux" and extra == "wireless-version"
Provides-Extra: all
Requires-Dist: reachy-mini-bwc[dev]; extra == "all"
Requires-Dist: reachy-mini-bwc[examples]; extra == "all"
Requires-Dist: reachy-mini-bwc[mujoco]; extra == "all"
Requires-Dist: reachy-mini-bwc[nn_kinematics]; extra == "all"
Requires-Dist: reachy-mini-bwc[placo_kinematics]; extra == "all"
Requires-Dist: reachy-mini-bwc[gstreamer]; extra == "all"
Requires-Dist: reachy-mini-bwc[rerun]; extra == "all"
Requires-Dist: reachy-mini-bwc[wireless-version]; extra == "all"
Dynamic: license-file

# ⚠️ reachy-mini-bwc — Brain Wave Collective Maintained Fork

> **Important:** This package (`reachy-mini-bwc`) is a maintained fork of the official `reachy-mini` SDK developed by **Pollen Robotics**.
>
> Official upstream project:
> https://github.com/pollen-robotics/reachy_mini
>
> If you are not using Brain Wave Collective software or Anima integrations, you most likely want the official package and NOT this repo:
>
> ```
> pip install reachy-mini
> ```

## Why does this fork exist?

`reachy-mini-bwc` exists to provide a version of the Reachy Mini SDK that is:

- Compatible with **Anima**
- Compatible with **Anima Reachy Conversation**
- Compatible with other Brain Wave Collective integrations
- Released independently when upstream dependency constraints conflict with BWC systems

This fork applies **minimal changes** to upstream `reachy-mini`, primarily limited to:

- Dependency resolution adjustments
- Version coordination with BWC ecosystem components

We do not modify core robot functionality unless explicitly documented.

## Version Mapping

| reachy-mini-bwc | Upstream reachy-mini | Notes |
|-----------------|----------------------|-------|
| 1.3.1.post1     | 1.3.1                | Dependency adjustments for Anima compatibility |

Future releases will document their upstream base version in this table.


## Attribution

Original SDK:
- © Pollen Robotics
- https://github.com/pollen-robotics/reachy_mini

This fork:
- Maintained by Brain Wave Collective
- https://brainwavecollective.ai

All original licensing from upstream is preserved.

---

# Reachy Mini 🤖

[![Ask on HuggingChat](https://img.shields.io/badge/Read_the-Documentation-yellow?logo=huggingface&logoColor=yellow)](https://huggingface.co/docs/reachy_mini/)
[![Discord](https://img.shields.io/badge/Discord-Join_the_Community-7289DA?logo=discord&logoColor=white)](https://discord.gg/Y7FgMqHsub)

**Reachy Mini is an open-source, expressive robot made for hackers and AI builders.**

🛒 [**Buy Reachy Mini**](https://www.hf.co/reachy-mini/)

[![Reachy Mini Hello](/docs/assets/reachy_mini_hello.gif)](https://www.pollen-robotics.com/reachy-mini/)

## ⚡️ Build and start your own robot

**Choose your platform to access the specific guide:**

| **🤖 Reachy Mini (Wireless)** | **🔌 Reachy Mini Lite** | **💻 Simulation** |
| :---: | :---: | :---: |
| The full autonomous experience.<br>Raspberry Pi 4 + Battery + WiFi. | The developer version.<br>USB connection to your computer. | No hardware required.<br>Prototype in MuJoCo. |
| 👉 [**Go to Wireless Guide**](https://huggingface.co/docs/reachy_mini/platforms/reachy_mini/get_started) | 👉 [**Go to Lite Guide**](https://huggingface.co/docs/reachy_mini/platforms/reachy_mini_lite/get_started) | 👉 [**Go to Simulation**](https://huggingface.co/docs/reachy_mini/platforms/simulation/get_started) |



> ⚡ **Pro tip:** Install [uv](https://docs.astral.sh/uv/getting-started/installation/) for 10-100x faster app installations (auto-detected, falls back to `pip`).

<br>

## 📱 Apps & Ecosystem

Reachy Mini comes with an app store powered by Hugging Face Spaces. You can install these apps directly from your robot's dashboard with one click!

* **🗣️ [Conversation App](https://huggingface.co/spaces/pollen-robotics/reachy_mini_conversation_app):** Talk naturally with Reachy Mini (powered by LLMs).
* **📻 [Radio](https://huggingface.co/spaces/pollen-robotics/reachy_mini_radio):** Listen to the radio with Reachy Mini!
* **👋 [Hand Tracker](https://huggingface.co/spaces/pollen-robotics/hand_tracker_v2):** The robot follows your hand movements in real-time.

👉 [**Browse all apps on Hugging Face**](https://hf.co/reachy-mini/#/apps)

<br>

## 🚀 Getting Started with Reachy Mini SDK

### User guides
* **[Installation](https://huggingface.co/docs/reachy_mini/SDK/installation)**: 5 minutes to set up your computer
* **[Quickstart Guide](https://huggingface.co/docs/reachy_mini/SDK/quickstart)**: Run your first behavior on Reachy Mini
* **[Python SDK](https://huggingface.co/docs/reachy_mini/SDK/python-sdk)**: Learn to move, see, speak, and hear.
* **[AI Integrations](https://huggingface.co/docs/reachy_mini/SDK/integration)**: Connect LLMs, build Apps, and publish to Hugging Face.
* **[Core Concepts](https://huggingface.co/docs/reachy_mini/SDK/core-concept)**: Architecture, coordinate systems, and safety limits.
* 🤗[**Share your app with the community**](https://huggingface.co/blog/pollen-robotics/make-and-publish-your-reachy-mini-apps)
* 📂 [**Browse the Examples Folder**](examples)

### 🤖 AI-Assisted Development

Using an AI coding agent (Claude Code, Codex, Copilot, etc.)? You can start building apps right away. Paste this prompt to your agent:

> *I'd like to create a Reachy Mini app. Start by reading https://github.com/pollen-robotics/reachy_mini/blob/develop/agents.md*

This [**agents.md**](agents.md) guide gives AI agents everything they need: SDK patterns, best practices, example apps, and step-by-step skills.

### Quick Look
After [installing the SDK](https://huggingface.co/docs/reachy_mini/SDK/installation), once your robot is awake, you can control it in just **a few lines of code**:

```python
from reachy_mini import ReachyMini
from reachy_mini.utils import create_head_pose

with ReachyMini() as mini:
    # Look up and tilt head
    mini.goto_target(
        head=create_head_pose(z=10, roll=15, degrees=True, mm=True),
        duration=1.0
    )
```

<br>

## 🛠 Hardware Overview

Reachy Mini robots are sold as kits and generally take **2 to 3 hours** to assemble. Detailed step-by-step guides are available in the platform-specific folders linked above.

* **Reachy Mini (Wireless):** Runs onboard (RPi 4), autonomous, includes IMU. [See specs](https://huggingface.co/docs/reachy_mini/platforms/reachy_mini/hardware).
* **Reachy Mini Lite:** Runs on your PC, powered via wall outlet. [See specs](https://huggingface.co/docs/reachy_mini/platforms/reachy_mini_lite/hardware).

<br>

## ❓ Troubleshooting

Encountering an issue? 👉 **[Check the Troubleshooting & FAQ Guide](https://huggingface.co/docs/reachy_mini/troubleshooting)**

<br>

## 🤝 Community & Contributing

* **Join the Community:** Join [Discord](https://discord.gg/2bAhWfXme9) to share your moments with Reachy, build apps together, and get help.
* **Found a bug?** Open an issue on this repository.


## License

This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.
Hardware design files are licensed under Creative Commons BY-SA-NC.
