Beatbox logoBEATBox - The BEhavioural and AuTonomous Box

BEATBox

Build Beatbox, flash the firmware, start streaming data.

Open hardware, open firmware, and open APIs.

Hardware

  1. 1
    Download CAD, STL, PCB, and wiring diagrams from the Beatbox repository.
  2. 2
    Order components using the Bill of Materials.
  3. 3
    Assemble the chamber and modules following the build guide.
  4. 4
    <!-- TODO: link exact GitHub repo and hardware docs. -->

Firmware

  1. 1
    Install the toolchain for the chosen microcontroller.
  2. 2
    Clone the firmware repository.
  3. 3
    Configure the build for your hardware variant.
  4. 4
    Flash the firmware onto the Beatbox controller.
  5. 5
    <!-- TODO: add exact commands and microcontroller type. -->

Software & API

  1. 1
    Install the Python client package and/or Docker stack.
  2. 2
    Start the Beatbox server and confirm streaming from the device.
  3. 3
    Use the REST or WebSocket API to subscribe to events and time-series.
  4. 4
    Explore the example Jupyter notebooks for analysis workflows.

Contributing

Contributions are welcome. Please follow the coding style and pull request process described in the repository.