Skip to main content

Mouse joystick interface for communicating with mouse joystick controller.

Project description

This Python package creates a class named MouseJoystickInterface.

Authors:

Peter Polidoro <polidorop@janelia.hhmi.org>

License:

BSD

Example Usage:

dev = MouseJoystickInterface() # Might automatically find devices if available
# if devices not found automatically, specify ports directly
dev = MouseJoystickInterface(use_ports=['/dev/ttyACM0','/dev/ttyACM0']) # Linux specific ports
dev = MouseJoystickInterface(use_ports=['/dev/tty.usbmodem262471','/dev/tty.usbmodem262472']) # Mac OS X specific ports
dev = MouseJoystickInterface(use_ports=['COM3','COM4']) # Windows specific ports
# abort_assay prematurely stops a running assay and leaves the rig ready to start a new assay
dev.abort_assay()
# start_assay is the main method that starts the assay, collects assay data, and saves data files
dev.start_assay()

# optional mouse_joystick_controller methods
dev.mouse_joystick_controller.set_properties_to_defaults(['ALL'])
dev.mouse_joystick_controller.get_property_values(['ALL'])
dev.mouse_joystick_controller.reach_position1_means('getValue')
dev.mouse_joystick_controller.reach_position1_means('setValue',[100,160,200])
dev.mouse_joystick_controller.reach_position1_means('setArrayLength',2)
dev.mouse_joystick_controller.reach_position1_means('setValue',[100,200])
dev.mouse_joystick_controller.trial_count('setValue',3)
dev.mouse_joystick_controller.repeat_aborted_trial('setValue',False)
dev.mouse_joystick_controller.get_assay_status()
dev.mouse_joystick_controller.move_joystick_to_base_position()
dev.mouse_joystick_controller.move_joystick_to_reach_position()
count = 1
dev.mouse_joystick_controller.activate_lickport(count)
dev.mouse_joystick_controller.get_trial_timing_data()
dev.mouse_joystick_controller.abort_trial()

# optional encoder_interface methods
dev.encoder_interface.set_properties_to_defaults(['ALL'])
dev.encoder_interface.get_property_values(['ALL'])
dev.encoder_interface.sample_period('setValue',15)
dev.encoder_interface.get_positions()
dev.encoder_interface.get_sample_count()
dev.encoder_interface.get_samples()

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_joystick_interface-1.1.0.tar.gz (6.4 kB view details)

Uploaded Source

File details

Details for the file mouse_joystick_interface-1.1.0.tar.gz.

File metadata

File hashes

Hashes for mouse_joystick_interface-1.1.0.tar.gz
Algorithm Hash digest
SHA256 c1ef01dd12eab85de7ed67b88dfcc88fbfdbe1db2b6a5698d5cb786f4c3c50a9
MD5 109a08b093b5b8d8c8266553ede29b34
BLAKE2b-256 0b0f88804c9634c08b15cd41b680851c9d3029e28789996edc21acd9e3122199

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