Software for the Open-BEATBox apparatus: the PC application and the firmware of the box modules.
pc_app/— the host application (PC), which runs the experimental protocol and talks to theMAINmodule over serial.micropython/— the module firmware (RP2040). See its own README for flashing, deployment and tests.ARCHITECTURE.md— how the host application, the main module and the peripheral modules fit together.
An early, hardware-free tkinter mock-up of the interface is kept for
reference on the
mock_gui
branch. It is deprecated.
Two firmware libraries are Git submodules, so clone with:
git clone --recurse-submodules https://github.com/Open-BeatBox/Open-BeatBox_Software.git
Archive downloads (the GitHub Download ZIP button, release archives and the Zenodo record) do not contain submodules: the two folders below arrive empty. Fetch them at the pinned commits if you start from an archive:
| Folder | Source | Commit |
|---|---|---|
micropython/libs/beatbox-protocol |
ICM beatbox-protocol |
fbb6d08 |
micropython/libs/ILI9341-parallel-TFT-driver-for-micropython |
HughMaingauche/ILI9341-parallel-TFT-driver-for-micropython | 6c82d2f |
pc_app installs the same beatbox-protocol commit from its pyproject.toml.
This is an ongoing development version. Interfaces, CAN payloads and the host
wire protocol are still moving; see the roadmap in
ARCHITECTURE.md.
GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later). See
LICENSE.
Third-party libraries under micropython/libs/ keep their own licences:
| Library | Licence |
|---|---|
microPython_MCP2515 (CAN driver, from capella-ben, with project changes) |
MIT |
CircuitPython_PCA9955B (LED driver, from noelanderson, with a MicroPython port) |
MIT |
ILI9341-parallel-TFT-driver-for-micropython (screen driver, submodule) |
GPL-3.0 |
beatbox-protocol (host wire format, ICM RnD unit, submodule) |
MIT |
If you use this software, please cite it with the metadata in
CITATION.cff (GitHub's Cite this repository button). Each
release is archived on Zenodo with its own DOI.
- Project website: https://open-beatbox.github.io/
- Manual: https://open-beatbox.github.io/docs/manual/
Please report problems with this software in this repository's issue tracker.
