RBQ Python SDK — Quick Start

Run a Python SDK example in 3 steps.

1. Clone and install

git clone https://github.com/RainbowRobotics/RBQ.git
cd RBQ

# Install the Python SDK
cd rbq_sdk/python
pip install -e .
cd ../..

2. Start the simulator (skip for real hardware)

The simulator runs in Docker — Docker is the only thing to install, and the script offers to install it when it is missing. The first run takes a few minutes to build its image. See MuJoCo.

bash scripts/sim.bash --no-gui

In the RBQ app on the same PC — started there, the desktop app finds this simulator on its own: Control → Auto Start → STAND. See Control home.

3. Run an example

cd rbq_sdk/python/example/sport

# Terminal CLI
python3 rbq_sport_client.py

# Joystick control
python3 rbq_sport_client_joy.py

Both examples default to the loopback interface (lo) — the same one the simulator and the on-robot stack use — so no argument is needed while the whole stack runs on this PC.

On a real robot, pass the interface that reaches it as the first argument:

python3 rbq_sport_client.py eth0

Check your interface name with ip link.

Examples overview

Example	What it does
Sport Client →	Terminal CLI — test any command
Sport Client (Joy) →	Gamepad — full button mapping