openbricks

Getting started

  • Installation
    • 1. Install the host tooling
    • 2. Get a firmware image
    • 3. Flash the hub
    • 4. Run your first program
    • Troubleshooting
  • Hardware guide
    • Recommended starter robot
    • Power budget
    • GPIO map (ESP32-S3)
    • Sensor wiring (I2C)
      • TCS34725 LED pin
    • Serial bus servo notes (ST-3032 / ST-3215)
    • Calibrating the drivebase
    • Alternative: DC gear motors with encoders
      • Calibrating encoder counts
  • Command-line tool
    • Reference
      • Positional Arguments
      • Named Arguments
      • Sub-commands
  • Simulator
    • Commands
    • Notes
  • Examples
    • Drive a square (ST-3032 drivebase)
    • Full robot (drivebase + IMU + color sensor array)

API reference

  • API reference
    • robotics — DriveBase
      • DriveBase
    • Motor drivers
      • Serial bus servos (recommended)
      • DC gear motors with encoders
      • H-bridge drivers (open loop)
    • Sensor drivers
      • BNO055 (IMU)
      • TCS34725 (color)
      • HC-SR04 (ultrasonic distance)
      • VL53L0X (laser distance)
      • VL53L1X (laser distance, long range)
    • Display & bus drivers
      • SSD1306 (OLED display)
      • TCA9548A (I2C multiplexer)
    • Interfaces
      • Core interfaces
      • Distance sensors
    • Hubs
      • StatusLED
      • Button
      • Hub
      • SimpleLED
      • NeoPixelLED
      • PushButton
      • ESP32DevkitHub
      • ESP32S3DevkitHub
    • Runtime services
      • Program launcher
      • Run logs
      • Bluetooth (BLE REPL & console)
      • BLE toggle button

Internals

  • Architecture
    • Four layers
    • Pybricks-parity control, in C
    • Host tooling
    • Status
  • Building the firmware
    • One-time setup
      • 1. Initialise all submodules
      • 2. Install the target toolchain
    • Building
    • Flashing
    • Verifying the image at the REPL
    • Running tests
    • CI
    • Troubleshooting
openbricks
  • Search

© Copyright 2026, the openbricks contributors.

Built with Sphinx using a theme provided by Read the Docs.