Generic Devices

Run the API locally on your own device

Known working devices

Cameras

• Any Luxonis OAK camera from the OAK-1 or OAK-D series

Controllers

• Any Unipi controller from the Patron or Neuron series.

Running from source

Robopipe API is open source and free for anyone to download, play with, and modify. Follow these steps to get Robopipe API running on your local device. The source code can be found here.

System requirements

Before you run Robopipe API on your device, make sure you have the following prerequisites.

• You have cloned the Robopipe API GitHub repository.

• You have Python 3.11.10 or higher installed.

• Though it is not a requirement for running the API, you should be able to connect to a Luxonis device, otherwise the things you can do with the API are greatly limited.

• If you also wish to use the controller API, you need to run the API on a Unipi device.

Running the API

Clone the Robopipe API GitHub repository.

git clone https://github.com/Robopipe/api.git

In your terminal, change directory to the one containing the Robopipe API source code.

cd robopipe-api

Set up and activate virtual environment (this step is optional if you have venv already active).

python -m venv .venv 
source .venv/bin/activate

Configure the API according to configuration reference.

Install dependencies.

python -m pip install -r requirements.txt

Run the API.

Running on uvicorn server

python3 -m robopipe_api

Running via FastAPI CLI

If you want to run the API using FastAPI CLI, you also need to install the CLI additionally to already installed dependencies. To learn more about FastAPI CLI please refer to this documentation.

python -m pip install "fastapi-cli[standard]"
fastapi run robopipe_api/robopipe.py