Skip to content

RBQ Python SDK — Quick Start

Run a Python SDK example in 3 steps.

1. Clone and install

bash
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)

bash
bash scripts/sim.bash

In RBQGUI: ConnectAuto Start RobotStance (2).

3. Run an example

bash
cd rbq_sdk/python/example/sport

# Terminal CLI
python3 rbq_sport_client.py eth0

# Joystick control
python3 rbq_sport_client_joy.py eth0

Replace eth0 with your network interface (ifconfig to check).

Examples overview

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

This user manual is intended for RBQ users.