Skip to content

Releases

biorxiv-v1 — version described in the bioRxiv preprint

Choose a tag to compare

@dhuzard dhuzard released this 09 Nov 10:40
2904e9c

Open-BEATBox (Open - BEhavioural and AuTonomous operant Box) is an open-source, modular, low-cost platform for autonomous home-cage operant conditioning in rodents. This release accompanies the bioRxiv preprint.

Contents

  • pc_app/ — PC application (Qt): training stages S1–S4, CSV result files, multi-box control.
  • micropython/ — RP2040 module firmware (main, feeder, nosepoke, screen, lighting, IR barrier), CAN protocol and its specification, validation CLI, MicroPython UF2 (v1.28.0, Adafruit Feather RP2040).

Important: submodules

Release archives, including the Zenodo record, do not contain the two submodule libraries. Fetch them at these commits (see the README):

  • micropython/libs/beatbox-protocol — ICM beatbox-protocol @ fbb6d08 (MIT)
  • micropython/libs/ILI9341-parallel-TFT-driver-for-micropython — @ 6c82d2f (GPL-3.0)

Or clone: git clone --recurse-submodules --branch biorxiv-v1 https://github.com/Open-BeatBox/Open-BeatBox_Software.git

State

Firmware host tests: 86 passed. PC-application tests: 19 passed on Windows (3 files need Linux/macOS). Known limitations are listed on the manual's status page.

Licence: AGPL-3.0-or-later (third-party libraries keep their own licences).