📦 Guia de Instalação

Bem-vindo ao Reachy Mini!

Este guia ajudará você a instalar o Python SDK e o daemon para começar a controlar seu robô.

🐧 Linux	🍎 macOS	🪟 Windows
✅ Suportado	✅ Suportado	✅ Suportado

Precisa de ajuda? Sinta-se à vontade para abrir uma issue se encontrar qualquer problema.

Primeira vez usando a linha de comando? 🖥️

Novo na linha de comando?

Uma linha de comando (também chamada de terminal ou prompt de comando) é uma interface baseada em texto onde você pode digitar comandos para interagir com o computador. Não se preocupe — é mais simples do que parece!

Como abrir a linha de comando:

• Windows: Pressione Win + R, digite cmd ou powershell e pressione Enter
• macOS: Pressione Cmd + Space, digite Terminal e pressione Enter
• Linux: Pressione Ctrl + Alt + T ou procure por "Terminal" em seus aplicativos

Dicas básicas:

• Digite os comandos exatamente como mostrados nas instruções
• Pressione Enter após digitar cada comando para executá-lo
• Você pode copiar e colar comandos (clique com o botão direito para colar na maioria das interfaces de linha de comando)

dica

Não se intimide! A linha de comando é apenas outra forma de dar instruções ao seu computador. Siga os comandos passo a passo e você estará controlando seu Reachy Mini em pouco tempo!

1. 📋 Pré-requisitos

Ferramenta	Versão	Finalidade
🐍 Python	3.10 - 3.12	Executar Reachy Mini SDK
📂 Git	Mais recente	Baixar código-fonte e aplicativos
📦 Git LFS	Mais recente	Baixar recursos de modelos

🐍 Instalar Python

Usaremos o uv — um gerenciador de pacotes Python rápido que torna a instalação simples!

Etapa 1: Instalar uv

Linux / macOS

No seu terminal, execute:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows

No seu terminal, execute:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Verificar instalação

Quando a instalação estiver concluída, feche seu terminal e abra um novo. Você pode verificar se tudo correu bem com:

uv --version

Etapa 2: Instalar Python

No seu terminal, execute:

uv python install 3.12 --default

dica

Recomendamos o Python 3.12, pois é a versão mais recente suportada para o Reachy Mini.

📂 Instalar Git e Git LFS

Linux

Instalar Git e Git LFS

No seu terminal, execute:

sudo apt install git git-lfs

macOS

1. Instalar Homebrew (se ainda não estiver instalado)

No seu terminal, execute:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Para Apple Silicon (M1, M2, etc.), você também será solicitado a executar:

echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

Verificar Homebrew

Quando a instalação estiver concluída, você pode verificar se deu tudo certo com:

brew --version

2. Instalar Git e Git LFS

No seu terminal, execute:

brew install git git-lfs

:::

Windows

Baixar e instalar Git para Windows

Baixe e instale o Git para Windows: https://git-scm.com/install/windows

Finalizar instalação

Por fim, o Git LFS precisa ser inicializado com o comando:

git lfs install

2. 🏠 Configurar um Ambiente Virtual

Por que usar um ambiente virtual?

Ele mantém sua instalação do Reachy Mini isolada e evita conflitos com outros projetos Python. O desenvolvimento moderno em Python exige isso!

Criar o ambiente

No seu terminal, execute:

uv venv reachy_mini_env --python 3.12

Ativar o ambiente

Linux / macOS

No seu terminal, execute:

source reachy_mini_env/bin/activate

Windows - Configuração da primeira vez

Antes de poder ativar seu ambiente virtual, o Windows precisa de permissão para executar scripts. Você só precisa fazer isso uma vez!

Etapa 1: Abra o terminal como Administrador

• Pressione Win + R, digite powershell
• Clique com o botão direito em "Windows PowerShell" e selecione "Executar como administrador"

Etapa 2: Habilitar execução de scripts

No terminal de administrador, execute:

powershell Set-ExecutionPolicy RemoteSigned

Etapa 3: Feche o terminal de administrador e abra um terminal comum

Agora você pode ativar seu ambiente virtual executando:

reachy_mini_env\Scripts\activate

Indicador de sucesso

Você deve ver (reachy_mini_env) no início do seu prompt de linha de comando!

3. 🚀 Instalar Reachy Mini

Escolha seu método de instalação:

📦 Instalação via PyPI	🔧 Instalação a partir do código-fonte
Para todos	Para desenvolvedores
Pronto para uso	Modificar o código

📦 Opção A: Instalar a partir do PyPI

Recomendado para a maioria dos usuários

Só quer controlar seu robô? Esta opção é para você!

No seu terminal, execute:

uv pip install "reachy-mini"
uv pip install --upgrade --index-url https://gitlab.freedesktop.org/api/v4/projects/1340/packages/pypi/simple gstreamer==1.28.0

Se você quiser usar o modo de simulação, precisa adicionar o extra mujoco:

uv pip install "reachy-mini[mujoco]"
uv pip install --upgrade --index-url https://gitlab.freedesktop.org/api/v4/projects/1340/packages/pypi/simple gstreamer==1.28.0

nota

A pós-instalação do gstreamer se deve a um problema com o PyPi e deverá ser resolvida no futuro.

🔧 Opção B: Instalar a partir do código-fonte

Para desenvolvedores

Quer modificar o SDK ou contribuir? Escolha esta opção!

No seu terminal, execute:

git clone https://github.com/pollen-robotics/reachy_mini
cd reachy_mini
uv pip install -e .
uv pip install --upgrade --index-url https://gitlab.freedesktop.org/api/v4/projects/1340/packages/pypi/simple gstreamer==1.28.0

Se você quiser usar o modo de simulação, precisa adicionar o extra mujoco:

uv pip install -e ".[mujoco]"
uv pip install --upgrade --index-url https://gitlab.freedesktop.org/api/v4/projects/1340/packages/pypi/simple gstreamer==1.28.0

🐧 Usuários Linux

Linux + conexão USB?

Você precisa conceder acesso à porta serial do Reachy Mini.

Execute estes comandos no seu terminal:

echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="1a86", ATTRS{idProduct}=="55d3", MODE="0666", GROUP="dialout"
SUBSYSTEM=="usb", ATTRS{idVendor}=="38fb", ATTRS{idProduct}=="1001", MODE="0666", GROUP="dialout"' \
| sudo tee /etc/udev/rules.d/99-reachy-mini.rules

sudo udevadm control --reload-rules && sudo udevadm trigger
sudo usermod -aG dialout $USER

atenção

Saia da sessão e entre novamente para que as alterações tenham efeito!

PortAudio

Certifique-se de que o portaudio esteja instalado no seu sistema para habilitar recursos de áudio com o backend padrão.

Execute este comando no seu terminal:

sudo apt-get install libportaudio2

Gstreamer

O gerenciamento de mídia é realizado pela biblioteca GStreamer. Usuários de Windows e MacOSX podem usar pip para instalá-la:

uv pip install --upgrade --index-url https://gitlab.freedesktop.org/api/v4/projects/1340/packages/pypi/simple gstreamer==1.28.0

Usuários Linux têm etapas extras a seguir:

🎉 Parabéns!

Você instalou o Reachy Mini com sucesso! Seu robô está pronto para ganhar vida.

❓ Solução de Problemas

Encontrou algum problema? 👉 Confira o Guia de Solução de Problemas & FAQ

Próximos Passos

• Guia de Início Rápido: Execute seu primeiro comportamento no Reachy Mini
• Python SDK: Aprenda a mover, ver, falar e ouvir.
• Integrações de IA: Conecte LLMs, construa Apps e publique na Hugging Face.
• Conceitos Centrais: Arquitetura, sistemas de coordenadas e limites de segurança.