Open — BEhavioural and AuTonomous operant Box — is an open-source, modular, low-cost platform for autonomous home-cage operant conditioning and long-duration behavioural data acquisition in rodents.
Mice interact with behavioural tasks inside their home cage over long periods, which reduces repeated handling while increasing within-subject data density. Everything needed to build, run and extend a system is published here: mechanical design, electronics, firmware, control software and documentation.
🌐 open-beatbox.github.io · 📖 Technical manual · 🎬 Video tutorials
| I want to… | Go to |
|---|---|
| Understand what the system does | Project website |
| Build one | Assembly tutorials |
| Follow an interactive bench guide | Interactive assembly guide |
| Read the full technical reference | Technical manual |
| Order parts | Master bill of materials |
| Watch the build | YouTube channel |
Each layer lives in its own repository under the open licence that suits it.
| Repository | Contents | Licence |
|---|---|---|
| Open-BeatBox_Hardware | CAD, enclosure, PCB and mechanical design files (V2 and V3), with print- and laser-ready exports | CERN-OHL-S-2.0 |
| Open-BeatBox_firmware | Embedded firmware for the modules, device control and telemetry | GPL-3.0 |
| Open-BeatBox_Software | GUI, data acquisition, experiment control and analysis tools | AGPL-3.0 |
| Open-BeatBox_Documentation | Source of the technical manual, protocols, technical notes and media | CC-BY-4.0 |
| assembly-tutorials | Step-by-step module assembly guides and the master BOM | see repository |
| Open-BeatBox.github.io | The public website and its build pipeline | AGPL-3.0 |
The website builds the manual at deploy time by pulling the documentation in as a submodule, which in turn pulls in the assembly tutorials. The three engineering repositories stand alone.
flowchart TD
W["Open-BeatBox.github.io<br/>website + CI"] -->|submodule| D["Open-BeatBox_Documentation<br/>manual source"]
D -->|submodule| A["assembly-tutorials<br/>module guides + BOM"]
W -.->|links to| H["Open-BeatBox_Hardware"]
W -.->|links to| F["Open-BeatBox_firmware"]
W -.->|links to| S["Open-BeatBox_Software"]
Clone the website with git clone --recurse-submodules, or the documentation alone if you only want the manual.
A BEATBox is an instrumented home cage built from independent modules, so a lab can build only the parts a protocol needs.
| Module | Role |
|---|---|
| Frame and enclosure | Laser-cut and 3D-printed structure that carries the modules |
| Feeder | Motorised pellet delivery with IR verification |
| Photobeam gate | Infrared passage detection between compartments |
| Screen | Touchscreen stimulus and response surface |
| Light ring | Controlled illumination and visual cueing |
| Water bottle mount | Fixed bottle position and guide |
Typical uses: autonomous operant conditioning, reward-delivery and sensor-triggered tasks, longitudinal home-cage monitoring, and circadian or motivational dynamics.
Open-BEATBox uses layer-specific open licences, so each part carries terms appropriate to its medium:
- Hardware — CERN-OHL-S-2.0 (strongly reciprocal open hardware)
- Firmware — GPL-3.0
- Software and website — AGPL-3.0
- Documentation — CC-BY-4.0
Each repository's own LICENSE file is authoritative for that layer.
Contributions are welcome. File issues and pull requests in the repository that owns the material:
- Assembly steps, BOM entries and supplier references → assembly-tutorials
- Manual pages, protocols and technical notes → Open-BeatBox_Documentation
- CAD, PCB and mechanical design → Open-BeatBox_Hardware
- Firmware → Open-BeatBox_firmware
- GUI, acquisition and analysis → Open-BeatBox_Software
- Website and documentation build → Open-BeatBox.github.io
Validation reports, troubleshooting notes and reproducible data-output examples from other labs are particularly useful.
Developed at the Centre de Recherche en Neurosciences de Lyon (CRNL), CH Le Vinatier, Bron, France.
