​
Install phosphobot

The quickest way to get started is to use the install script. In a terminal, run the following command:

curl -fsSL https://raw.githubusercontent.com/phospho-app/phosphobot/main/install.sh | bash

Then, run the phosphobot server:

phosphobot run

It can take up to 15 seconds for the server to start.

On the same computer, open a web browser and navigate to localhost. You should now see the phosphobot dashboard.

Send your first commands

Discover how to control your robot arm from the dashboard and from the Meta Quest app.

​
MacOS (brew)

Use Homebrew to install phosphobot:

brew tap phospho-app/phosphobot
brew install phosphobot

To update phosphobot, run the following command:

brew update && brew upgrade phosphobot

You can also directly download the binaries here.

​
Linux (apt)

On Linux, we use apt to distribute the software and you need additional packages. That’s why you need to run the install script with sudo:

curl -fsSL https://raw.githubusercontent.com/phospho-app/phosphobot/main/install.sh | sudo bash

To update phosphobot, run the following command:

sudo apt update && sudo apt install --only-upgrade phosphobot

​
Raspberry Pi (apt)

phosphobot on Raspberry Pi has advanced features to make it easier to use (led ticking, bluetooth connection, extra dependencies already installed).

1. SSH into the Raspberry Pi

SSH (Secure Shell) allows you to access the Raspberry Pi remotely from your main computer through the terminal.

Turn on the Raspberry Pi by plugging it to a power source. Wait for it to boot (look for the LED pattern)

Then, open a terminal and SSH into your Raspberry Pi. If you’ve followed the previous part, this means running on your computer this command :

ssh phosphobot@phosphobot.local

If you didn’t follow the previous part, the username@hostname.local and password may be different.

When asked about the authenticity of host phosphobot.local, type yes to accept.

And when asked for password, enter password123 .

2. Install the software

When you’ve successfully SSH in the Raspberry Pi, run this to install the teleoperation server :

curl -fsSL https://raw.githubusercontent.com/phospho-app/phosphobot/main/install.sh | sudo bash

Your Raspberry Pi should be connected to the internet.

  • When prompted btberrywifi install location, leave blank.
  • When prompted bluetooth password, leave blank
  • When prompted Enter your country code, specify your country code (eg: US, FR…)

After that, the installation script will download install dependencies. It can take a few minutes depending on your connection speed.

3. Once the installation is complete, reboot your Raspberry Pi.

sudo reboot
Every time the control module is powered on, it will check for updates and install them automatically. They will be available the next time you power it on.

​
Windows

​
Windows (Install script)

  1. To install or update phosphobot, run the following command in PowerShell:
powershell -ExecutionPolicy Bypass -Command "irm https://raw.githubusercontent.com/phospho-app/phosphobot/main/install.ps1 | iex"
  1. To start the phosphobot server, run the following command in PowerShell.
phosphobot run
  1. When the “Windows protected your PC” warning appears, click “More info”, then click “Run anyway”.

The warning only appears on first run. Subsequent launches work normally.

​
Windows (manual)

You can also directly download the binaries here.. After downloading, run phosphobot this way:

C:\path\to\phosphobot.exe run

Change C:\path\to\ to the path where you downloaded phosphobot. To make this easier, we recommand you to rename the file to phosphobot.exe and move it to your Desktop.

Then, you can create a shortcut to launch C:\Users\<your_username>\Desktop\phosphobot.exe run from anywhere.

​
Support

Discord

Join the Discord to ask questions, get help from others and get updates

Was this page helpful?