The ioHub Mouse Device

Platforms: Windows, OS X, Linux

Mouse Device Configuration Settings

# This file includes all valid Mouse Device
# settings that can be specified in an iohub_config.yaml
# or in Python dictionary form and passed to the launchHubServer
# method. Any device parameters not specified when the device class is
# created by the ioHub Process will be assigned the default value
# indicated here.
#
Mouse:
    # name: The name you want to assign the Mouse device for the experiment
    #   This name is what will be used to access the device within the experiment
    #   script via the devices.[device_name] property of the ioHubConnection or
    #   ioHubExperimentRuntime classes.
    #
    name: mouse

    # enable: Specifies if the device should be enabled by ioHub and monitored
    #   for events.
    #   True = Enable the device on the ioHub Server Process
    #   False = Disable the device on the ioHub Server Process. No mouse events will
    #   be reported by the ioHub Server.
    #
    enable: True
 
    # monitor_event_types: *If* the ioHubDataStore is enabled for the experiment, then
    #   indicate if events for this device should be saved to the
    #   monitor_event_types: Specified which Mouse Event types should be monitored
    #   for and therefore saved to the DataStore or sent to the Experiment Process.
    #
    monitor_event_types:  [MouseMoveEvent, MouseDragEvent, MouseScrollEvent, MouseButtonPressEvent, MouseButtonReleaseEvent, MouseMultiClickEvent]

    #   save_events: Save Mouse events to the data_collection/Mouse event 
    #   group in the hdf5 event file.
    #   True = Save events for this device to the ioDataStore.
    #   False = Do not save events for this device in the ioDataStore.
    #
    save_events: True

    # streamEvents: Indicate if events from this device should be made available
    #   during experiment runtime to the Experiment / PsychoPy Process.
    #   True = Send events for this device to  the Experiment Process in real-time.
    #   False = Do *not* send events for this device to the Experiment Process in real-time.
    #
    stream_events: True

    # auto_report_events: Indicate if events from this device should start being
    #   processed by the ioHub as soon as the device is loaded at the start of an experiment,
    #   or if events should only start to be monitored on the device when a call to the
    #   device's enableEventReporting method is made with a parameter value of True.
    #   True = Automatically start reporting events for this device when the experiment starts.
    #   False = Do not start reporting events for this device until enableEventReporting(True)
    #       is set for the device during experiment runtime.
    #
    auto_report_events: True

    # event_buffer_length: Specify the maximum number of events (for each
    #   event type the device produces) that can be stored by the ioHub Server
    #   before each new event results in the oldest event of the same type being
    #   discarded from the ioHub device event buffer.
    #
    event_buffer_length: 256
    
    # device_number: The device number to assign to the device. 
    #   Device_number is not used by this device type.
    #
    device_number: 0

    # serial_number: The serial number for the specific isnstance of device used
    #   can be specified here. It is not used by the ioHub, so is FYI only.
    #
    serial_number: N/A

    # manufacture_date: The date of manufactiurer of the device 
    # can be specified here. It is not used by the ioHub,
    # so is FYI only.
    #   
    manufacture_date: DD-MM-YYYY

    # The device manufacturer's name.
    #   It is not used by the ioHub, so is FYI only.
    #
    manufacturer_name: N/A

    # model_name: The device model name can be specified here.
    #   It is not used by the ioHub, so is FYI only.
    #
    model_name: N/A

    # model_number: The device model number can be specified here.
    #   It is not used by the ioHub, so is FYI only.
    #
    model_number: N/A
    
    # software_version: The device driver and / or SDK software version number.
    #   This field is not used by ioHub, so is FYI only. 
    #
    software_version: N/A

    # hardware_version: The device's hardware version can be specified here.
    #   It is not used by the ioHub, so is FYI only.
    #
    hardware_version: N/A
    
    # firmware_version: If the device has firmware, its revision number
    #   can be indicated here. It is not used by the ioHub, so is FYI only.
    #
    firmware_version: N/A

Mouse Device Constants

class psychopy.iohub.constants.MouseConstants[source]

Bases: psychopy.iohub.constants.Constants

MouseConstants provides access to ioHub Mouse Device specific constants.

MOUSE_BUTTON_NONE = 0

Constant representing that no Mouse buttons are pressed.

MOUSE_BUTTON_LEFT = 1

Constant representing that the left Mouse button is pressed.

MOUSE_BUTTON_RIGHT = 2

Constant representing that the right Mouse button is pressed.

MOUSE_BUTTON_MIDDLE = 4

Constant representing that the middle Mouse button is pressed.

MOUSE_BUTTON_STATE_RELEASED = 10

Constant representing a mouse button is in a released state.

MOUSE_BUTTON_STATE_PRESSED = 11

Constant representing a mouse button is in a pressed state.

MOUSE_BUTTON_STATE_MULTI_CLICK = 12

Constant representing a mouse is in a multiple click state.

classmethod getClass(id)

Return the constant’s ioHub CLass Name given constant id. If no class is associated with the specified constant value, None is returned.

Args:
id (int): The constant’s id value to look-up the string name for.
Returns:
class: The ioHub class associated with the constant id provided.
classmethod getID(name)

Return the constant’s id given a valid constant name string.

Args:
name (str): The constant’s name value to look-up the int id for.
Returns:
int: The id for the given constant name.
classmethod getName(id)

Return the constant’s name given a valid constant id.

Args:
id (int): The constant’s id value to look-up the string name for.
Returns:
str: The name for the given constant id.

Mouse Event Types

Notes and Considerations

None at this time.