Skip to main content

openbricks (host CLI + sim)

Host-side tooling for openbricks hubs — same UX as pybricksdev, built on commodity Python tooling (bleak, esptool, mpremote). One package, one console script: openbricks flash / list / run / upload / stop / log. The MuJoCo-backed simulator is built in too — openbricks sim … opens the sim's CLI when the [sim] extra is installed.

Website: https://openbricks.dev · Documentation: https://docs.openbricks.dev

Install

Recommended — with pipx so the CLI lands in an isolated venv and avoids the "externally managed environment" error on modern macOS / Linux distros:

pipx install openbricks            # CLI only (lightweight; bleak / esptool / mpremote)
pipx install 'openbricks[sim]'     # CLI + MuJoCo physics simulator

Plain pip works too:

pip install openbricks
pip install 'openbricks[sim]'

For development against a repo checkout (editable install):

pip install -e 'tools/openbricks[sim]'

[sim] adds mujoco (~50 MB, native OpenGL) and numpy — most users (flash + run + log) don't need it. Without [sim], openbricks sim … prints a helpful "pip install openbricks[sim]" hint instead of crashing.

Note: binary wheels (manylinux, macOS universal2, Windows AMD64; CPython 3.9–3.13) ship on PyPI since 0.10.3, so installs are toolchain-free on common platforms. On anything outside that matrix, pip falls back to the sdist and compiles the bundled native extension (openbricks_sim._native), which needs a C compiler + Python headers.

Commands

flash — program a hub

openbricks flash \
    --name RobotA \
    --port /dev/tty.usbserial-XXXX \
    --firmware native/micropython/ports/esp32/build-openbricks_esp32s3/firmware.bin

Writes the firmware image and bakes the hub's BLE advertising name into NVS. --name is mandatory: two hubs with the same name can't be individually addressed over BLE.

Port syntax: /dev/ttyUSB0 (Linux), /dev/cu.usbserial-* (macOS), COM5 (Windows).

Useful flags: --chip esp32s3, --baud 921600, --skip-erase (faster dev loop, keeps stale NVS).

list — scan for hubs

openbricks list [--timeout 5.0] [--all]

Runs a BLE scan and prints every named device found, sorted by RSSI (strongest first). --all includes unnamed devices too.

run — stage and launch; button stops it; client exits on stop

openbricks run -n RobotA examples/hello.py

Stages the script to /program.py (same target as upload) and triggers the hub's launcher to execute it immediately. Output streams back to your terminal in real time.

  • Button stop. Pressing the hub button while the program runs raises KeyboardInterrupt via the same launcher path upload+button uses. The client sees the clean "stopped by button press" line and exits.
  • Program completion. When the program finishes (or raises), the client disconnects and exits — same as pybricksdev run.
  • Script persists. Because run stages to /program.py, the hub can re-run the last program via a button press without another upload. upload and run differ only in whether the client auto-launches after upload.

Stderr (e.g. exception tracebacks) arrives after stdout and is surfaced with a blank-line separator. No paste-mode === echo — raw-paste mode is clean.

stop — interrupt the running program

openbricks stop -n RobotA

Sends a single Ctrl-C byte over the NUS REPL bridge, which MicroPython surfaces as KeyboardInterrupt. Useful when openbricks run has already exited but the hub's still chewing on a long-running user program.

upload — stage a script; hub button launches it

openbricks upload -n RobotA examples/wander.py

Writes the script to /program.py on the hub. The code does not run automatically. Place your robot, press the program button (GPIO 4), and the program starts. Press again to stop it mid-run.

(Pybricks calls this same operation download from the hub's "download to me" perspective. We name by direction-of-data-travel — bytes flow up to the hub, hence upload.)

This works because the firmware ships a frozen main.py that:

  1. Brings BLE + REPL bridge up immediately (so openbricks run / upload / stop are always reachable, even when no program is running).
  2. Instantiates the board's Hub, which wires the BLE-toggle button (short-press on GPIO 5) with LED feedback.
  3. Watches the program button (GPIO 4) via openbricks.launcher.run() — a short-press runs /program.py, a second short-press raises KeyboardInterrupt in the running program.

Two separate pins (4 for program, 5 for BLE toggle), each handled by short-press only — no duration-based dispatch.

Pass --path /alt.py to stage at a different filename (if you've written your own main.py that reads from there).

Tests

cd tools/openbricks
PYTHONPATH=. python -m unittest discover -s tests -t .

No real hardware needed — esptool, mpremote, and bleak are mocked.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openbricks-1.83.3.tar.gz (3.8 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

openbricks-1.83.3-cp313-cp313-win_amd64.whl (3.6 MB view details)

Uploaded CPython 3.13Windows x86-64

openbricks-1.83.3-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

openbricks-1.83.3-cp313-cp313-macosx_10_13_universal2.whl (3.6 MB view details)

Uploaded CPython 3.13macOS 10.13+ universal2 (ARM64, x86-64)

openbricks-1.83.3-cp312-cp312-win_amd64.whl (3.6 MB view details)

Uploaded CPython 3.12Windows x86-64

openbricks-1.83.3-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

openbricks-1.83.3-cp312-cp312-macosx_10_13_universal2.whl (3.6 MB view details)

Uploaded CPython 3.12macOS 10.13+ universal2 (ARM64, x86-64)

openbricks-1.83.3-cp311-cp311-win_amd64.whl (3.6 MB view details)

Uploaded CPython 3.11Windows x86-64

openbricks-1.83.3-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

openbricks-1.83.3-cp311-cp311-macosx_10_9_universal2.whl (3.6 MB view details)

Uploaded CPython 3.11macOS 10.9+ universal2 (ARM64, x86-64)

openbricks-1.83.3-cp310-cp310-win_amd64.whl (3.6 MB view details)

Uploaded CPython 3.10Windows x86-64

openbricks-1.83.3-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

openbricks-1.83.3-cp310-cp310-macosx_10_9_universal2.whl (3.6 MB view details)

Uploaded CPython 3.10macOS 10.9+ universal2 (ARM64, x86-64)

openbricks-1.83.3-cp39-cp39-win_amd64.whl (3.6 MB view details)

Uploaded CPython 3.9Windows x86-64

openbricks-1.83.3-cp39-cp39-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (3.6 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.28+ x86-64manylinux: glibc 2.5+ x86-64

openbricks-1.83.3-cp39-cp39-macosx_10_9_universal2.whl (3.6 MB view details)

Uploaded CPython 3.9macOS 10.9+ universal2 (ARM64, x86-64)

File details

Details for the file openbricks-1.83.3.tar.gz.

File metadata

  • Download URL: openbricks-1.83.3.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for openbricks-1.83.3.tar.gz
Algorithm Hash digest
SHA256 5d49e82b4e108145d8e702b35b5278378291f2074ba213a3317e67ef4bf7f2a1
MD5 b68e6e370a07e4b685944155ad6d645f
BLAKE2b-256 a06accf7281b69c44a6f77472b9f96ee5e18903b10474a170e4dc8f34af2ade0

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3.tar.gz:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 4677ca8efba9358881ac6fa4a6b5cbb58c6ba1b40e36a8bb93bd82653877bcdc
MD5 6975bc88ea256d1880bb28b702a8a48b
BLAKE2b-256 d7993d08389450e82d978ddba8d352e6ea2d1e9f429fdca0ab9a95026e5d57f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp313-cp313-win_amd64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Algorithm Hash digest
SHA256 d8a6cc4443d6aa332ad4c57e105a67cb23bc63773d6c8b81465a91bbc72ece6e
MD5 a17dd0717af3d9ab4f2712213a7a9db4
BLAKE2b-256 5caa47932014b9b22bd0fa469d499af1eae34bca4ca5cb6c735e686dc92084d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp313-cp313-macosx_10_13_universal2.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp313-cp313-macosx_10_13_universal2.whl
Algorithm Hash digest
SHA256 d0cfd9e472c4f7bfc74029bba76ecd7dde29edb52a1cdcfd583ba9d3ad632aad
MD5 439d4801d31b37b49031dbbeb2d0fe18
BLAKE2b-256 226e2767f4f6714aaa1660d5a08bbd836d9af94a6b8d05a85c1bece4822e5e83

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp313-cp313-macosx_10_13_universal2.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 f821e51c15af3c9f8bce9aa0e4c6ad9b93ca51a2c728ab3d5af7e43bcfa5b5b8
MD5 ef043dc6694c33ec66254b1a509d6234
BLAKE2b-256 6b12095071b767a8c6cff565093eb61604154802786f09dc2aedf7900af9a63c

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp312-cp312-win_amd64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Algorithm Hash digest
SHA256 579f0d2d8d6ca9afecea398aa498451fd112a8b430f4233c1b9f67d6950b768b
MD5 b9c39ab02d3fd533df487c7be4e5e3b7
BLAKE2b-256 8e858e99c7770f8ca71b25277d4ed5a81fba0b7fa68102911aab70408dd9fe16

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp312-cp312-macosx_10_13_universal2.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp312-cp312-macosx_10_13_universal2.whl
Algorithm Hash digest
SHA256 c4882207cc16223a7f15f4c99412c4f599e5562f83e59be29b0b8d77c776bf0c
MD5 39be06d66f8eadbf969c89686f1ed502
BLAKE2b-256 187d22e94eb09bb21e2d4b633496574de82371e464a560cb0584e9dc1e9ca7ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp312-cp312-macosx_10_13_universal2.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 416a4eda1e85bda04539b1b4b6fabf47b5449e3d3dd086750674a6c8d0987cba
MD5 401c4dc5abea8d774d0268dd36536042
BLAKE2b-256 462a3ad127bd71bd1911827b733e33fe2f0946e72c768a9e1c0ccf4133beb712

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp311-cp311-win_amd64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Algorithm Hash digest
SHA256 7bf1fa3bd415df010f2a8390c010de06aeca69bb0c2d374fc7f975fb043525b8
MD5 2f3dad18f7ece5d19e8b152d5af29a5a
BLAKE2b-256 62b37bf38a5fd791eece6ce03e534c80430bb99acbc1f0eaef4f8a15e1c87bcd

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp311-cp311-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp311-cp311-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 42a6491ea53c2c71d2e1e9dcb970ff175b24c9aca09695cc9191122d6f76e68c
MD5 433bd540601224b4f401e50d46a1a41c
BLAKE2b-256 929560398772c45cd66ec66322dfda8e6055a005fa6e7f8c90e9ca62ac8dedf9

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp311-cp311-macosx_10_9_universal2.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 4e7119c94f3250b65183f2c82039c0333591820e71fe00d132800574759cc1b5
MD5 d8037c0ff660a8b5cb6d733f5af1e46e
BLAKE2b-256 49700b61484f4ddb7480b2c9065fd3e9b4141ff33d1fe1e6a114b1578564ef89

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp310-cp310-win_amd64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Algorithm Hash digest
SHA256 74e5e8ab4a86a6390e675965a936aa6bb02748f95d17e650c0ef1160947ed5a2
MD5 0eb1732435d11f32bd2d133f70587f3c
BLAKE2b-256 5686846ccbb284f17594facdf6324c7a1180c73b5829fcd8ffbe8d4419f125fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp310-cp310-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp310-cp310-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 cf00291aa1116ecd7ae0a3fb6cc5885df1b09472887fb6864aa4f08d93951cfb
MD5 72d8b0d43ec926a596f4e650c228f1ff
BLAKE2b-256 dbfcc5d3767cf9179088d6d58e4cf7782708cc1380c6b21cc614bc11d5cdff40

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp310-cp310-macosx_10_9_universal2.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: openbricks-1.83.3-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for openbricks-1.83.3-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 d35a3ca1535d18f7dde31f29cdcc1574f20a7253907bc1a29949c1c80caa9530
MD5 f18bc5f1e339374d73de98978b6e903c
BLAKE2b-256 8528a7684fad35ec9f573e6b70640a0556fceb53ce47e1523690bfed3a74b0b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp39-cp39-win_amd64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp39-cp39-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp39-cp39-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Algorithm Hash digest
SHA256 e5cd69e106ef83c1734fd272bc2b2bb1962ab041270ca0093de5c34a77b971e2
MD5 62b370705486c7293529c0668fc4001e
BLAKE2b-256 e3a2e92f5334444499475d77daaf166235fdf504e4f4f3299a68480d32e2642d

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp39-cp39-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openbricks-1.83.3-cp39-cp39-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for openbricks-1.83.3-cp39-cp39-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 2c558599b81d7c56169c3f364c35b02a6db27b08c43c4759023b526a39681ccd
MD5 29c813da33825ccb515b084c414fa5cd
BLAKE2b-256 e0f027e1bb0a91c779200db00739af2a66a069f99c0f2aeeb5f3626d0efa118f

See more details on using hashes here.

Provenance

The following attestation bundles were made for openbricks-1.83.3-cp39-cp39-macosx_10_9_universal2.whl:

Publisher: ci.yaml on 1e0ng/openbricks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page