API reference

Everything below ships frozen into the firmware image — import openbricks on the hub gives you all of it. The pages are generated from the package’s docstrings.

The API is layered:

• Drivers (openbricks.drivers.*) — one module per supported component. Construct these with your wiring’s pins / IDs.

• Interfaces (openbricks.interfaces, openbricks.distance) — the abstract contracts drivers implement. Higher layers depend only on these, which is what makes the system plug-and-play.

• Robotics (openbricks.robotics) — building blocks composed from interfaces, like the two-wheel DriveBase.

• Hub & runtime — board-level peripherals, BLE, program launching, and log capture.

• 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