This repo holds everything needed to build a working MIROSLAV device. Arduino firmware and Record-a-SLAV, a Python data acquisition script, can be found in the MIROSLAV-firmware repository. A complete, user-friendly MIROSLAV software toolkit for analysis of MIROSLAV data, from raw data to statistical analysis, can be found in the MIROSLAV-analysis repository - also contains an example dataset of real data recorded in our lab.
MIROSLAV (Multicage InfraRed Open Source Locomotor Activity eValuator) is a platform for non-invasive monitoring of circadian locomotor activity in laboratory rodents. MIROSLAV is fully open source and scalable to hundreds of cages. All of its hardware and software components are described in the paper: https://doi.org/10.1101/2024.06.25.600592
-
bom/- Bill of Materials for all needed parts and an informative order sheet for the PCBs. Note that the PCBs are panelised so e.g. 10 pcs of the sensor board refer to 10x2 panels - total 200 boards. -
gerbers/- Last produced gerber files - MIROSLAV v0.4, as described in the paper -
KiCad board project directories:
main_board/power_board/sensor_board/serialization_board/
-
symbols/- Contains additional individual symbols and footprints used. -
miro-v04.pretty/- Contains additional symbols, packed into a.prettylibrary (footprints) -
miro-v04.kicad_sym- Contains additional symbols, packed into a.kicad_symlibrary (schematic symbols)
MIROSLAV's current hardware revision is v0.4, designed in Dec 2021 in KiCad 6.0. At that time, we generated Gerbers and produced the PCBs through JLCPCB. The devices have been successfully in the proof-of-concept study described in the paper.
The only change made in the meantime was a verbatim conversion of project files to KiCad 8.0 format for convenience of further development. Original Gerber files still remain so that a tested MIROSLAV design can be easily reproduced.
Note the v0.5 branch which contains updated designs that haven't been produced/tested yet.
To reproduce MIROSLAV, it is sufficient to download the Gerbers and send them to a PCB manufacturer.
Additional part symbols and footprints used in the design are contained in miro-v04.kicad_sym and miro-v04.pretty libraries, respectively.
MIROSLAV-firmware- Arduino firmware and Record-a-SLAV, a Python data acquisition script. Once you build the device, you need to flash the firmware, set up an MQTT broker, and run Record-a-SLAV on a PC to start recording data.mirofile- Your buddy for dealing with raw MIROSLAV data. A Python library used by Prepare-a-SLAV to parse raw MIROSLAV logs into a dataframe.MIROSLAV-analysis- A complete, user-friendly MIROSLAV software toolkit for analysis of MIROSLAV data, from raw data to statistical analysis. Also contains an example dataset with real data recorded in our lab.
You can modify any part of MIROSLAV freely under the GPLv3 license - if you have any questions, problems, or ideas on how to improve MIROSLAV, feel free to reach out to us, submit a GitHub issue, or a pull request.
The MIROSLAV logo is created by Petra Šoštarić Mužić and licensed under the CC BY-NC-SA 4.0 license - more details can be found in the repository's logo/ directory.