Skip to main content

An Event Triggered Recorder

Project description

Code Health


Mouse Record

A cheap, modular, behavior recording program

Mouserecord\_logo.jpg

Purpose

The program’s is designed to record rodent behavior at specific intervals of time, based on the initiation of a trigger event (e.g., the press of a lever).

Installation

Installation requires setuptools; install using the following command (may require sudo):

python setup.py install

Testing

Test the program using the following command:

python setup.py test

Documentation

Documentation can be built from source on any platform easily. Just run the following command.

python setup.py build_sphinx

This will generate HTML documentation, which can be open using this file build/sphinx/html/index.html in the current directory.

For more build options, simply run the following command.

python setup.py build_sphinx --help

Other build targets can be specified using the -b or --builder option. Beyond the standard options that Sphinx provides, we add the pdf option.

Cleaning

To clean up the directory after building, one can use the clean option. This will eliminate all intermediates build products. The syntax is shown below.

python setup.py clean

If this is not sufficient, and one wishes to eliminate the final products this can be done with the flag -a or --all. This adjustment to the syntax is shown below.

python setup.py clean --all

Usage

Picture Usage

Execution of the program consists of the program name and a single argument, the directory in which the picture is to be saved into. If a directory is not specified, the current directory will be assumed.

mouse-picture ~/Destkop

Preview Usage

Execution of the program consists of the program name and a single argument: the time desired length of the camera preview (in seconds). If the time is not specified, this will default to 15 seconds. Additionally, the user can exit at any time by entering Ctrl + c

mouse-preview 60

Record Usage

Execution of the program consists of the program name and respectve arguments: time to record before trigger event (in seconds), time to record after (in seconds), and directory of the file to be saved into. If a directory is not specified, the current directory will be assumed. An example is shown below:

sudo mouse-record 2 2 /home/pi/Desktop

Also, as mentioned before, the program will end when a Ctrl + c is entered into the terminal.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mouse_record-0.0.6.tar.gz (21.2 kB view details)

Uploaded Source

File details

Details for the file mouse_record-0.0.6.tar.gz.

File metadata

File hashes

Hashes for mouse_record-0.0.6.tar.gz
Algorithm Hash digest
SHA256 bd4da5b6df266db9d22492cb55e7511e007528c2c26a6aad6e8738595ed6385d
MD5 fb07518539ce95069687c730c78d694e
BLAKE2b-256 d186444271c7f940b99b389cfb46e87c2717614b819f536bf69f852b2963e0e5

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page