📦 インストールガイド
このガイドでは、ロボットを操作し始めるための Python SDK とデーモンのインストール方法を説明します。
| 🐧 Linux | 🍎 macOS | 🪟 Windows |
|---|---|---|
| ✅ 対応 | ✅ 対応 | ✅ 対応 |
サポートが必要ですか? 問題が発生した場合は、遠慮なくissue を作成してください。
コマンドラインを使うのは初めてですか? 🖥️
コマンドライン(ターミナルやコマンドプロンプトとも呼ばれます)は、コンピュータと対話するためにコマンドを入力するテキストベースのインターフェースです。心配はいりません——見た目よりずっと簡単です!
コマンドラインの開き方:
- Windows:
Win + Rを押し、cmdまたはpowershellと入力して Enter を押します - macOS:
Cmd + Spaceを押し、Terminalと入力して Enter を押します - Linux:
Ctrl + Alt + Tを押すか、アプリケーションで「Terminal」を検索します
基本的なヒント:
- 手順に記載されているコマンドは、表示されているとおりに正確に入力してください
- 各コマンドを入力したら
Enterを押して実行します - コマンドはコピー&ペーストできます(ほとんどのコマンドラインインターフェースでは右クリックで貼り付けできます)
怖がらないでください! コマンドラインは、コンピュータに指示を与えるもう一つの方法にすぎません。コマンドを一つずつ順番に実行していけば、すぐに Reachy Mini を操作できるようになります!
1. 📋 前提条件
| ツール | バージョン | 目的 |
|---|---|---|
| 🐍 Python | 3.10 - 3.12 | Reachy Mini SDK を実行 |
| 📂 Git | 最新 | ソースコードとアプリをダウンロード |
| 📦 Git LFS | 最新 | モデルアセットをダウンロード |
🐍 Python をインストールする
ここでは uv を使用します。これは、高速な Python パッケージマネージャで、インストールを簡単にしてくれます!
ステップ 1: uv をインストールする
ターミナルで次を実行します:
curl -LsSf https://astral.sh/uv/install.sh | sh
ターミナルで次を実行します:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
インストールが完了したら、ターミナルを一度閉じて新しく開き直してください。次のコマンドで、すべてが正しくインストールされたか確認できます:
uv --version
ステップ 2: Python をインストールする
ターミナルで次を実行します:
uv python install 3.12 --default
Reachy Mini では、サポートされている最新バージョンである Python 3.12 を推奨します。
📂 Git と Git LFS をインストールする
1. Homebrew をインストールする(未インストールの場合)
ターミナルで次を実行します:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Apple Silicon(M1, M2 など)の場合、次のコマンドを実行するように求められます:
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"
インストールが完了したら、次のコマンドで正しくインストールされたか確認できます:
brew --version
2. Git と Git LFS をインストールする
ターミナルで次を実行します:
brew install git git-lfs
:::
Git for Windows をダウンロードしてインストールする
Git for Windows をダウンロードしてインストールします: https://git-scm.com/install/windows
最後に、次のコマンドで Git LFS を初期化する必要があります:
git lfs install
2. 🏠 仮想環境をセットアップする
Reachy Mini のインストールを分離し、他の Python プロジェクトとの競合を防ぐためです。現在の Python 開発では必須の手法です!
環境を作成する
ターミナルで次を実行します:
uv venv reachy_mini_env --python 3.12
環境を有効化する
ターミナルで次を実行します:
source reachy_mini_env/bin/activate
仮想環境を有効化する前に、Windows にスクリプトの実行を許可する必要があります。これは一度だけ行えば大丈夫です!
ステップ 1: 管理者としてターミナルを開く
Win + Rを押し、powershellと入力します- 「Windows PowerShell」を右クリックし、「Run as administrator」を選択します
ステップ 2: スクリプト実行を有効化する
管理者権限のターミナルで次を実行します:
powershell Set-ExecutionPolicy RemoteSigned
ステップ 3: 管理者権限のターミナルを閉じ、通常のターミナルを開く
これで、次のコマンドを実行して仮想環境を有効化できるようになります:
reachy_mini_env\Scripts\activate
コマンドラインプロンプトの先頭に (reachy_mini_env) と表示されていれば成功です!
3. 🚀 Reachy Mini をインストールする
インストール方法を選択してください:
| 📦 PyPI からインストール | 🔧 ソースからインストール |
|---|---|
| すべてのユーザー向け | 開発者向け |
| すぐに利用可能 | コードを変更可能 |
📦 オプション A: PyPI からインストール
ロボットを操作したいだけですか?この方法がおすすめです!
ターミナルで次を実行します:
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
シミュレーションモードを使用したい場合は、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
gstreamer のインストール後処理は、PyPi に関するissue が原因で必要になっており、将来的には解決される予定です。
🔧 オプション B: ソースからインストール
SDK を変更したり、コントリビュートしたい場合は、このオプションを選択してください!
ターミナルで次を実行します:
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
シミュレーションモードを使用したい場合は、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
🐧 Linux ユーザー向け
Reachy Mini のシリアルポートへのアクセス権を付与する必要があります。
ターミナルで次のコマンドを実行します:
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
変更を反映させるには、一度ログアウトしてから再度ログインしてください!
デフォルトのバックエンドで音声機能を有効にするには、システムに portaudio がインストールされていることを確認してください。
ターミナルで次のコマンドを実行します:
sudo apt-get install libportaudio2
Gstreamer
メディア管理は GStreamer ライブラリによって行われます。Windows と MacOSX ユーザーは、pip を使ってインストールできます:
uv pip install --upgrade --index-url https://gitlab.freedesktop.org/api/v4/projects/1340/packages/pypi/simple gstreamer==1.28.0
Linux ユーザーは、追加の手順に従う必要があります:
🎉 おめでとうございます!
Reachy Mini のインストールが完了しました!ロボットを動かす準備が整いました。
❓ トラブルシューティング
問題が発生しましたか? 👉 トラブルシューティング & FAQ ガイドを確認してください
次のステップ
- クイックスタートガイド: Reachy Mini で最初の挙動を実行する
- Python SDK: 動かす・見る・話す・聞く方法を学ぶ
- AI 連携: LLM を接続し、アプリを構築して Hugging Face に公開する
- コアコンセプト: アーキテクチャ、座標系、安全制限について