psychopy 2024.2.5__py3-none-any.whl → 2025.1.0__py3-none-any.whl

psychopy/experiment/components/settings/__init__.py

@@ -7,12 +7,13 @@ from pathlib import Path
 from xml.etree.ElementTree import Element
 import re
 from psychopy import logging, plugins
+from psychopy.preferences import prefs
 from psychopy.experiment.components import Param, _translate
+from psychopy.experiment.components.settings.eyetracking import knownEyetrackerBackends
 from psychopy.experiment.routines import Routine, BaseStandaloneRoutine
 from psychopy.experiment.routines.eyetracker_calibrate import EyetrackerCalibrationRoutine
 from psychopy.experiment import utils as exputils
 from psychopy.monitors import Monitor
-from psychopy.iohub import util as ioUtil
 from psychopy.alerts import alert
 from psychopy.tools.filetools import genDelimiter
 from psychopy.data.utils import parsePipeSyntax
@@ -41,11 +42,6 @@ _numpyImports = ['sin', 'cos', 'tan', 'log', 'log10', 'pi', 'average',
                  'sqrt', 'std', 'deg2rad', 'rad2deg', 'linspace', 'asarray']
 _numpyRandomImports = ['random', 'randint', 'normal', 'shuffle', 'choice as randchoice']
 
-# this is not a standard component - it will appear on toolbar not in
-# components panel
-ioDeviceMap = dict(ioUtil.getDeviceNames(device_name="eyetracker.hw"))
-ioDeviceMap['None'] = ""
-
 # Keyboard backend options
 keyboardBackendMap = {
     "ioHub": "iohub",
@@ -53,6 +49,9 @@ keyboardBackendMap = {
     "Pyglet": "event"
 }
 
+# possible expInfo keys for participant ID
+participantIdAliases = ('participant', 'Participant', 'Subject', 'Observer')
+
 
 # # customize the Proj ID Param class to
 # class ProjIDParam(Param):
@@ -79,6 +78,11 @@ class SettingsComponent:
     targets = ['PsychoPy', 'PsychoJS']
     iconFile = Path(__file__).parent / 'settings.png'
     tooltip = _translate("Edit settings for this experiment")
+    plugin = None
+    version = "0.0.0"
+    beta = False
+    # an experiment only has one SettingsComponent, so hide it from the Components panel
+    hidden = True
 
     def __init__(
             self, parentName, exp, expName='', fullScr=True, runMode=0, rush=False,
@@ -100,6 +104,7 @@ class SettingsComponent:
             savedDataFolder='', savedDataDelim='auto',
             clockFormat="float",
             useVersion='',
+            expVersion='',
             eyetracker="None",
             mgMove='CONTINUOUS', mgBlink='MIDDLE_BUTTON', mgSaccade=0.5,
             gpAddress='127.0.0.1', gpPort=4242,
@@ -114,13 +119,11 @@ class SettingsComponent:
             plPupilRemoteAddress="127.0.0.1",
             plPupilRemotePort=50020,
             plPupilRemoteTimeoutMs=1000,
-            plPupilCaptureRecordingEnabled=True,
             plPupilCaptureRecordingLocation="",
             plCompanionAddress="neon.local",
             plCompanionPort=8080,
-            plCompanionRecordingEnabled=True,
             ecSampleRate='default',
-            keyboardBackend="ioHub",
+            keyboardBackend="PsychToolbox",
             filename=None, exportHTML='on Sync',
             endMessage=_translate("Thank you for your patience.")
     ):
@@ -144,7 +147,8 @@ class SettingsComponent:
         self.params = {}
         self.depends = []
         self.order = [
-                      'Audio lib', 'Audio latency priority', "Force stereo",  # Audio tab
+                      'expName', 'expVersion',
+                      'Audio lib', "Force stereo",  # Audio tab
                       'HTML path', 'exportHTML', 'Completed URL', 'Incomplete URL', 'End Message', 'Resources',  # Online tab
                       ]
         self.depends = []
@@ -166,6 +170,13 @@ class SettingsComponent:
             ),
             label=_translate("Experiment name")
         )
+        self.params['expVersion'] = Param(
+            expVersion, valType='str', inputType="single", categ='Basic',
+            hint=_translate(
+                "Version number of the experiment (a string). Just for your records if it's useful to store"
+            ),
+            label=_translate("Experiment version")
+        )
         self.params['runMode'] = Param(
             runMode, valType="code", inputType="choice", categ="Basic",
             allowedVals=[0, 1],
@@ -374,20 +385,6 @@ class SettingsComponent:
             hint=_translate("Which Python sound engine do you want to play your sounds?"),
             label=_translate("Audio library"), categ='Audio')
 
-        audioLatencyLabels = [
-            '0: ' + _translate('Latency not important'),
-            '1: ' + _translate('Share low-latency driver'),
-            '2: ' + _translate('Exclusive low-latency'),
-            '3: ' + _translate('Aggressive low-latency'),
-            '4: ' + _translate('Latency critical'),
-        ]
-        self.params['Audio latency priority'] = Param(
-            '3', valType='str', inputType="choice",
-            allowedVals=['0', '1', '2', '3', '4'],
-            allowedLabels=audioLatencyLabels,
-            hint=_translate("How important is audio latency for you? If essential then you may need to get all your sounds in correct formats."),
-            label=_translate("Audio latency priority"), categ='Audio')
-
         # --- Data params ---
         self.order += [
             "Data filename",
@@ -541,8 +538,8 @@ class SettingsComponent:
             "Tobii Technology": ["tbModel", "tbLicenseFile", "tbSerialNo", "tbSampleRate"],
             "Pupil Labs": ["plPupillometryOnly", "plSurfaceName", "plConfidenceThreshold",
                            "plPupilRemoteAddress", "plPupilRemotePort", "plPupilRemoteTimeoutMs",
-                           "plPupilCaptureRecordingEnabled", "plPupilCaptureRecordingLocation"],
-            "Pupil Labs (Neon)": ["plCompanionAddress", "plCompanionPort", "plCompanionRecordingEnabled"],
+                           "plPupilCaptureRecordingLocation"],
+            "Pupil Labs (Neon)": ["plCompanionAddress", "plCompanionPort"],
             "EyeLogic": ["ecSampleRate"],
         }
         for tracker in trackerParams:
@@ -563,35 +560,54 @@ class SettingsComponent:
              "false": "disable",  # permitted: hide, show, enable, disable
              }
         )
+        # arrays for eyetracker backends
+        backendValues = ["None"]
+        backendLabels = ["None"]
+        # add known backends from plugins
+        for key, cls in knownEyetrackerBackends.items():
+            backendValues.append(key)
+            backendLabels.append(cls.label or key)
+        # add backends via legacy detection method
+        try:
+            from psychopy.iohub import util as ioUtil
+            for legLbl, legKey in ioUtil.getDeviceNames(device_name="eyetracker.hw"):
+                if legKey not in backendValues:
+                    backendValues.append(legKey)
+                    backendLabels.append(legLbl)
+        except:
+            # if it doesn't work, just stick with the known backends from plugins
+            pass
 
         self.params['eyetracker'] = Param(
             eyetracker, valType='str', inputType="choice",
-            allowedVals=list(ioDeviceMap),
+            allowedVals=backendValues,
+            allowedLabels=backendLabels,
             hint=_translate("What kind of eye tracker should PsychoPy use? Select 'MouseGaze' to use "
                             "the mouse to simulate eye movement (for debugging without a tracker connected)"),
             label=_translate("Eyetracker device"), categ="Eyetracking"
         )
 
-        #mousegaze
-        self.params['mgMove'] = Param(
-            mgMove, valType='str', inputType="choice",
-            allowedVals=['CONTINUOUS', 'LEFT_BUTTON', 'MIDDLE_BUTTON', 'RIGHT_BUTTON'],
-            hint=_translate("Mouse button to press for eye movement."),
-            label=_translate("Move button"), categ="Eyetracking"
-        )
-
-        self.params['mgBlink'] = Param(
-            mgBlink, valType='list', inputType="multiChoice",
-            allowedVals=['LEFT_BUTTON', 'MIDDLE_BUTTON', 'RIGHT_BUTTON'],
-            hint=_translate("Mouse button to press for a blink."),
-            label=_translate("Blink button"), categ="Eyetracking"
-        )
-
-        self.params['mgSaccade'] = Param(
-            mgSaccade, valType='num', inputType="single",
-            hint=_translate("Visual degree threshold for Saccade event creation."),
-            label=_translate("Saccade threshold"), categ="Eyetracking"
-        )
+        # add params from backends
+        for backend in knownEyetrackerBackends.values():
+            # get params from backend
+            params, order = backend.getParams()
+            # append order
+            self.order += order
+            # iterate through params from this backend
+            for paramName, param in params.items():
+                # add param
+                self.params[paramName] = param
+                # add dependency on eyetracker param
+                self.depends.append({
+                    'dependsOn': "eyetracker",  # if...
+                    'condition': f"== '{backend.key}'",  # meets...
+                    'param': paramName,  # then...
+                    'true': "show",  # should...
+                    'false': "hide",  # otherwise...
+                })
+
+        # as users with old versions of the plugin won't have params added dynamically, add legacy 
+        # params here manually
 
         # gazepoint
         self.params['gpAddress'] = Param(
@@ -613,27 +629,23 @@ class SettingsComponent:
             hint=_translate("Eye tracker model."),
             label=_translate("Model name"), categ="Eyetracking"
         )
-
         self.params['elSimMode'] = Param(
             elSimMode, valType='bool', inputType="bool",
             hint=_translate("Set the EyeLink to run in mouse simulation mode."),
             label=_translate("Mouse simulation mode"), categ="Eyetracking"
         )
-
         self.params['elSampleRate'] = Param(
             elSampleRate, valType='num', inputType="choice",
             allowedVals=['250', '500', '1000', '2000'],
             hint=_translate("Eye tracker sampling rate."),
             label=_translate("Sampling rate"), categ="Eyetracking"
         )
-
         self.params['elTrackEyes'] = Param(
             elTrackEyes, valType='str', inputType="choice",
             allowedVals=['LEFT_EYE', 'RIGHT_EYE', 'BOTH'],
             hint=_translate("Select with eye(s) to track."),
             label=_translate("Track eyes"), categ="Eyetracking"
         )
-
         self.params['elLiveFiltering'] = Param(
             elLiveFiltering, valType='str', inputType="choice",
             allowedVals=['FILTER_LEVEL_OFF', 'FILTER_LEVEL_1', 'FILTER_LEVEL_2'],
@@ -641,7 +653,6 @@ class SettingsComponent:
                             "This may reduce the sampling speed."),
             label=_translate("Live sample filtering"), categ="Eyetracking"
         )
-
         self.params['elDataFiltering'] = Param(
             elDataFiltering, valType='str', inputType="choice",
             allowedVals=['FILTER_LEVEL_OFF', 'FILTER_LEVEL_1', 'FILTER_LEVEL_2'],
@@ -649,28 +660,24 @@ class SettingsComponent:
                             "not affect the sampling speed."),
             label=_translate("Saved sample filtering"), categ="Eyetracking"
         )
-
         self.params['elTrackingMode'] = Param(
             elTrackingMode, valType='str', inputType="choice",
             allowedVals=['PUPIL_CR_TRACKING', 'PUPIL_ONLY_TRACKING'],
             hint=_translate("Track Pupil-CR or Pupil only."),
             label=_translate("Pupil tracking mode"), categ="Eyetracking"
         )
-
         self.params['elPupilAlgorithm'] = Param(
             elPupilAlgorithm, valType='str', inputType="choice",
             allowedVals=['ELLIPSE_FIT', 'CENTROID_FIT'],
             hint=_translate("Algorithm used to detect the pupil center."),
             label=_translate("Pupil center algorithm"), categ="Eyetracking"
         )
-
         self.params['elPupilMeasure'] = Param(
             elPupilMeasure, valType='str', inputType="choice",
             allowedVals=['PUPIL_AREA', 'PUPIL_DIAMETER', 'NEITHER'],
             hint=_translate("Type of pupil data to record."),
             label=_translate("Pupil data type"), categ="Eyetracking"
         )
-
         self.params['elAddress'] = Param(
             elAddress, valType='str', inputType="single",
             hint=_translate("IP Address of the EyeLink *Host* computer."),
@@ -683,19 +690,16 @@ class SettingsComponent:
             hint=_translate("Eye tracker model."),
             label=_translate("Model name"), categ="Eyetracking"
         )
-
         self.params['tbLicenseFile'] = Param(
             tbLicenseFile, valType='str', inputType="file",
             hint=_translate("Eye tracker license file (optional)."),
             label=_translate("License file"), categ="Eyetracking"
         )
-
         self.params['tbSerialNo'] = Param(
             tbSerialNo, valType='str', inputType="single",
             hint=_translate("Eye tracker serial number (optional)."),
             label=_translate("Serial number"), categ="Eyetracking"
         )
-
         self.params['tbSampleRate'] = Param(
             tbSampleRate, valType='num', inputType="single",
             hint=_translate("Eye tracker sampling rate."),
@@ -734,11 +738,6 @@ class SettingsComponent:
             hint=_translate("Pupil remote timeout (ms)"),
             label=_translate("Pupil remote timeout (ms)"), categ="Eyetracking"
         )
-        self.params['plPupilCaptureRecordingEnabled'] = Param(
-            plPupilCaptureRecordingEnabled, valType='bool', inputType="bool",
-            hint=_translate("Pupil capture recording enabled"),
-            label=_translate("Pupil capture recording enabled"), categ="Eyetracking"
-        )
         self.params['plPupilCaptureRecordingLocation'] = Param(
             plPupilCaptureRecordingLocation, valType='str', inputType="single",
             hint=_translate("Pupil capture recording location"),
@@ -754,11 +753,6 @@ class SettingsComponent:
             hint=_translate("Companion port"),
             label=_translate("Companion port"), categ="Eyetracking"
         )
-        self.params['plCompanionRecordingEnabled'] = Param(
-            plCompanionRecordingEnabled, valType='bool', inputType="bool",
-            hint=_translate("Recording enabled"),
-            label=_translate("Recording enabled"), categ="Eyetracking"
-        )
 
         # EyeLogic
         self.params['ecSampleRate'] = Param(
@@ -918,17 +912,13 @@ class SettingsComponent:
             buff.writelines(
                 "prefs.hardware['audioLib'] = {}\n".format(self.params['Audio lib'])
             )
-        if self.params['Audio latency priority'].val.lower() != 'use prefs':
-            buff.writelines(
-                "prefs.hardware['audioLatencyMode'] = {}\n".format(self.params['Audio latency priority'])
-            )
         buff.write(
             "from psychopy import %s\n" % ', '.join(psychopyImports) +
             "from psychopy.tools import environmenttools\n"
-            "from psychopy.constants import (NOT_STARTED, STARTED, PLAYING,"
-            " PAUSED,\n"
-            "                                STOPPED, FINISHED, PRESSED, "
-            "RELEASED, FOREVER, priority)\n\n"
+            "from psychopy.constants import (\n"
+            "    NOT_STARTED, STARTED, PLAYING, PAUSED, STOPPED, STOPPING, FINISHED, PRESSED, \n"
+            "    RELEASED, FOREVER, priority\n"
+            ")\n\n"
             "import numpy as np  # whole numpy lib is available, "
             "prepend 'np.'\n"
             "from numpy import (%s,\n" % ', '.join(_numpyImports[:7]) +
@@ -983,6 +973,9 @@ class SettingsComponent:
             "# store info about the experiment session\n"
             "psychopyVersion = '%(version)s'\n"
             "expName = %(expName)s  # from the Builder filename that created this script\n"
+            "expVersion = %(expVersion)s\n"
+            "# a list of functions to run when the experiment ends (starts off blank)\n"
+            "runAtExit = []\n"
         )
         buff.writeIndentedLines(code % params)
         # get info for this experiment
@@ -990,6 +983,7 @@ class SettingsComponent:
         # add internal expInfo keys
         expInfo['date|hid'] = "data.getDateStr()"
         expInfo['expName|hid'] = "expName"
+        expInfo['expVersion|hid'] = "expVersion"
         expInfo['psychopyVersion|hid'] = "psychopyVersion"
         # construct exp info dict
         code = (
@@ -1028,6 +1022,14 @@ class SettingsComponent:
             "        _winSize = prefs.piloting['forcedWindowSize']\n"
         )
         buff.writeIndented(code % self.params)
+        for key, value in expInfo.items():
+            if key in participantIdAliases:
+                code = (
+            f"    # replace default participant ID\n"
+            f"    if prefs.piloting['replaceParticipantID']:\n"
+            f"        expInfo['{key}'] = 'pilot'\n"
+                )
+                buff.writeIndented(code % self.params)
 
     def prepareResourcesJS(self):
         """Sets up the resources folder and writes the info.php file for PsychoJS
@@ -1154,6 +1156,7 @@ class SettingsComponent:
         code = ("\n// store info about the experiment session:\n"
                 "let expName = '%s';  // from the Builder filename that created this script\n"
                 "let expInfo = %s;\n"
+                "let PILOTING = util.getUrlParameters().has('__pilotToken');\n"
                 "\n" % (jsFilename, expInfoStr))
         buff.writeIndentedLines(code)
 
@@ -1240,7 +1243,7 @@ class SettingsComponent:
 
         # figure out participant id field (if any)
         participantVal = ''
-        for target in ('participant', 'Participant', 'Subject', 'Observer'):
+        for target in participantIdAliases:
             if target in self.getInfo(removePipeSyntax=True):
                 participantVal = " + expInfo['%s']" % target
                 break
@@ -1276,7 +1279,7 @@ class SettingsComponent:
         # set up the ExperimentHandler
         code = ("\n# an ExperimentHandler isn't essential but helps with data saving\n"
                 "thisExp = data.ExperimentHandler(\n"
-                "    name=expName, version='',\n"
+                "    name=expName, version=expVersion,\n"
                 "    extraInfo=expInfo, runtimeInfo=None,\n"
                 "    originPath=%(originPath)s,\n"
                 "    savePickle=%(Save psydat file)s, saveWideText=%(Save wide csv file)s,\n"
@@ -1433,7 +1436,6 @@ class SettingsComponent:
         if inits['mgMove'].val == "CONTINUOUS":
             inits['mgMove'].val = "$"
         inits['keyboardBackend'].val = keyboardBackendMap[inits['keyboardBackend'].val]
-        inits['eyetracker'].val = ioDeviceMap[inits['eyetracker'].val]
 
         # Make ioConfig dict
         code = (
@@ -1442,244 +1444,234 @@ class SettingsComponent:
         )
         buff.writeIndentedLines(code % inits)
 
-        # Add eyetracker config
+        # add eyetracker config
         if self.params['eyetracker'] != "None":
-            # Alert user if window is not fullscreen
-            if not self.params['Full-screen window'].val:
-                alert(code=4540)
-            # Alert user if no monitor config
+            # alert user if there's no monitor config
             if self.params['Monitor'].val in ["", None, "None"]:
                 alert(code=4545)
-            # Alert user if they need calibration and don't have it
-            if not self.params['eyetracker'].val in ["MouseGaze", "Pupil Labs (Neon)"]:
-                if not any(isinstance(rt, EyetrackerCalibrationRoutine)
-                           for rt in self.exp.flow):
-                    alert(code=4510, strFields={"eyetracker": self.params['eyetracker'].val})
-
-            # Write code
+            # write opening comment
             code = (
-                "\n"
-                "# Setup eyetracking\n"
-                "ioConfig[%(eyetracker)s] = {\n"
+                "# setup eyetracking\n"
             )
-            buff.writeIndentedLines(code % inits)
-            buff.setIndentLevel(1, relative=True)
-            code = (
-                    "'name': 'tracker',\n"
-            )
-            buff.writeIndentedLines(code % inits)
-            # Initialise for MouseGaze
-            if self.params['eyetracker'] == "MouseGaze":
-                code = (
-                        "'controls': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-                code = (
-                            "'move': [%(mgMove)s],\n"
-                            "'blink':%(mgBlink)s,\n"
-                            "'saccade_threshold': %(mgSaccade)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "}\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-            elif self.params['eyetracker'] == "GazePoint":
+            buff.writeIndentedLines(code)
+            # if backend is known and has an associated class, use its methods
+            if self.params['eyetracker'].val in knownEyetrackerBackends:
+                # get backend class
+                backend = knownEyetrackerBackends[self.params['eyetracker'].val]
+                # alert user if they need fullscreen and don't have it
+                if backend.needsFullscreen and not self.params['Full-screen window'].val:
+                    alert(code=4540)
+                # alert user if they need calibration and don't have it
+                if backend.needsCalibration and not any(
+                    isinstance(rt, EyetrackerCalibrationRoutine) for rt in self.exp.flow
+                ):
+                    alert(code=4510, strFields={'eyetracker': self.params['eyetracker'].val})
+                # write code
+                backend.writeDeviceCode(inits, buff)
+            # otherwise, do it the old fashioned way
+            else:
                 code = (
-                        "'network_settings': {\n"
+                    "ioConfig[%(eyetracker)s] = {\n"
                 )
                 buff.writeIndentedLines(code % inits)
                 buff.setIndentLevel(1, relative=True)
                 code = (
-                            "'ip_address': %(gpAddress)s,\n"
-                            "'port': %(gpPort)s\n"
+                        "'name': 'tracker',\n"
                 )
                 buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "}\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-            elif self.params['eyetracker'] == "Tobii Technology":
-                code = (
-                        "'model_name': %(tbModel)s,\n"
-                        "'serial_number': %(tbSerialNo)s,\n"
+                # Initialise for MouseGaze
+                if self.params['eyetracker'] == "GazePoint":
+                    code = (
+                            "'network_settings': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+                    code = (
+                                "'ip_address': %(gpAddress)s,\n"
+                                "'port': %(gpPort)s\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                        "}\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                elif self.params['eyetracker'] == "Tobii Technology":
+                    code = (
+                            "'model_name': %(tbModel)s,\n"
+                            "'serial_number': %(tbSerialNo)s,\n"
+                            "'runtime_settings': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+                    code = (
+                                "'sampling_rate': %(tbSampleRate)s,\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                        "}\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                elif self.params['eyetracker'] == "SR Research Ltd":
+                    code = (
+                        "'model_name': %(elModel)s,\n"
+                        "'simulation_mode': %(elSimMode)s,\n"
+                        "'network_settings': %(elAddress)s,\n"
+                        "'default_native_data_file_name': 'EXPFILE',\n"
                         "'runtime_settings': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-                code = (
-                            "'sampling_rate': %(tbSampleRate)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "}\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-            elif self.params['eyetracker'] == "SR Research Ltd":
-                code = (
-                    "'model_name': %(elModel)s,\n"
-                    "'simulation_mode': %(elSimMode)s,\n"
-                    "'network_settings': %(elAddress)s,\n"
-                    "'default_native_data_file_name': 'EXPFILE',\n"
-                    "'runtime_settings': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-                code = (
-                        "'sampling_rate': %(elSampleRate)s,\n"
-                        "'track_eyes': %(elTrackEyes)s,\n"
-                        "'sample_filtering': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-                code = (
-                            "'FILTER_FILE': %(elDataFiltering)s,\n"
-                            "'FILTER_ONLINE': %(elLiveFiltering)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(-1, relative=True)
-                code = (
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+                    code = (
+                            "'sampling_rate': %(elSampleRate)s,\n"
+                            "'track_eyes': %(elTrackEyes)s,\n"
+                            "'sample_filtering': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+                    code = (
+                                "'FILTER_FILE': %(elDataFiltering)s,\n"
+                                "'FILTER_ONLINE': %(elLiveFiltering)s,\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                            "},\n"
+                            "'vog_settings': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+                    code = (
+                                "'pupil_measure_types': %(elPupilMeasure)s,\n"
+                                "'tracking_mode': %(elTrackingMode)s,\n"
+                                "'pupil_center_algorithm': %(elPupilAlgorithm)s,\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                        "}\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                        "}\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                elif self.params['eyetracker'] == "Pupil Labs":
+                    # Open runtime_settings dict
+                    code = (
+                        "'runtime_settings': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+
+                    # Define runtime_settings dict
+                    code = (
+                        "'pupillometry_only': %(plPupillometryOnly)s,\n"
+                        "'surface_name': %(plSurfaceName)s,\n"
+                        "'confidence_threshold': %(plConfidenceThreshold)s,\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                    # Open runtime_settings > pupil_remote dict
+                    code = (
+                        "'pupil_remote': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+
+                    # Define runtime_settings > pupil_remote dict
+                    code = (
+                        "'ip_address': %(plPupilRemoteAddress)s,\n"
+                        "'port': %(plPupilRemotePort)s,\n"
+                        "'timeout_ms': %(plPupilRemoteTimeoutMs)s,\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                    # Close runtime_settings > pupil_remote dict
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
                         "},\n"
-                        "'vog_settings': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-                code = (
-                            "'pupil_measure_types': %(elPupilMeasure)s,\n"
-                            "'tracking_mode': %(elTrackingMode)s,\n"
-                            "'pupil_center_algorithm': %(elPupilAlgorithm)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "}\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "}\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-            elif self.params['eyetracker'] == "Pupil Labs":
-                # Open runtime_settings dict
-                code = (
-                    "'runtime_settings': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-
-                # Define runtime_settings dict
-                code = (
-                    "'pupillometry_only': %(plPupillometryOnly)s,\n"
-                    "'surface_name': %(plSurfaceName)s,\n"
-                    "'confidence_threshold': %(plConfidenceThreshold)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-                # Open runtime_settings > pupil_remote dict
-                code = (
-                    "'pupil_remote': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-
-                # Define runtime_settings > pupil_remote dict
-                code = (
-                    "'ip_address': %(plPupilRemoteAddress)s,\n"
-                    "'port': %(plPupilRemotePort)s,\n"
-                    "'timeout_ms': %(plPupilRemoteTimeoutMs)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-                # Close runtime_settings > pupil_remote dict
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "},\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-                # Open runtime_settings > pupil_capture_recording dict
-                code = (
-                    "'pupil_capture_recording': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-
-                # Define runtime_settings > pupil_capture_recording dict
-                code = (
-                    "'enabled': %(plPupilCaptureRecordingEnabled)s,\n"
-                    "'location': %(plPupilCaptureRecordingLocation)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-                # Close runtime_settings > pupil_capture_recording dict
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "}\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-                # Close runtime_settings dict
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "}\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-            elif self.params['eyetracker'] == "Pupil Labs (Neon)":
-                # Open runtime_settings dict
-                code = (
-                    "'runtime_settings': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-
-                # Define runtime_settings dict
-                code = (
-                    "'companion_address': %(plCompanionAddress)s,\n"
-                    "'companion_port': %(plCompanionPort)s,\n"
-                    "'recording_enabled': %(plCompanionRecordingEnabled)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-                # Close runtime_settings dict
-                buff.setIndentLevel(-1, relative=True)
-                code = (
-                    "}\n"
-                )
-                buff.writeIndentedLines(code % inits)
-
-            elif self.params['eyetracker'] == "EyeLogic":
-                code = (
-                    "'runtime_settings': {\n"
-                )
-                buff.writeIndentedLines(code % inits)
-                buff.setIndentLevel(1, relative=True)
-                code = (
-                    "'sampling_rate': %(ecSampleRate)s,\n"
-                )
-                buff.writeIndentedLines(code % inits)
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                    # Open runtime_settings > pupil_capture_recording dict
+                    code = (
+                        "'pupil_capture_recording': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+
+                    # Define runtime_settings > pupil_capture_recording dict
+                    code = (
+                        "'enabled': %(plPupilCaptureRecordingEnabled)s,\n"
+                        "'location': %(plPupilCaptureRecordingLocation)s,\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                    # Close runtime_settings > pupil_capture_recording dict
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                        "}\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                    # Close runtime_settings dict
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                        "}\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                elif self.params['eyetracker'] == "Pupil Labs (Neon)":
+                    # Open runtime_settings dict
+                    code = (
+                        "'runtime_settings': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+                    # Define runtime_settings dict
+                    code = (
+                        "'companion_address': %(plCompanionAddress)s,\n"
+                        "'companion_port': %(plCompanionPort)s,\n"
+                        "'recording_enabled': %(plCompanionRecordingEnabled)s,\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                    # Close runtime_settings dict
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                        "}\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                elif self.params['eyetracker'] == "EyeLogic":
+                    code = (
+                        "'runtime_settings': {\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(1, relative=True)
+                    code = (
+                        "'sampling_rate': %(ecSampleRate)s,\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+                    buff.setIndentLevel(-1, relative=True)
+                    code = (
+                        "}\n"
+                    )
+                    buff.writeIndentedLines(code % inits)
+
+                # Close ioDevice dict
                 buff.setIndentLevel(-1, relative=True)
                 code = (
                     "}\n"
                 )
                 buff.writeIndentedLines(code % inits)
 
-            # Close ioDevice dict
-            buff.setIndentLevel(-1, relative=True)
-            code = (
-                "}\n"
-            )
-            buff.writeIndentedLines(code % inits)
-
         # Add keyboard to ioConfig
         if self.params['keyboardBackend'] == 'ioHub':
             code = (
@@ -1920,11 +1912,15 @@ class SettingsComponent:
         )
         buff.writeIndentedLines(code)
 
-        # show/hide pilot indicator
+        # post-init window adjustments for piloting mode
         code = (
-            "# show a visual indicator if we're in piloting mode\n"
-            "if PILOTING and prefs.piloting['showPilotingIndicator']:\n"
-            "    win.showPilotingIndicator()\n"
+            "if PILOTING:\n"
+            "    # show a visual indicator if we're in piloting mode\n"
+            "    if prefs.piloting['showPilotingIndicator']:\n"
+            "        win.showPilotingIndicator()\n"
+            "    # always show the mouse in piloting mode\n"
+            "    if prefs.piloting['forceMouseVisible']:\n"
+            "        win.mouseVisible = True\n"
         )
         buff.writeIndentedLines(code)
 
@@ -2009,9 +2005,9 @@ class SettingsComponent:
         buff.writeIndentedLines(code)
 
     def writePauseCode(self, buff):
-        # Open function def
+        # open function def for pause
         code = (
-            'def pauseExperiment(thisExp, win=None, timers=[], playbackComponents=[]):\n'
+            'def pauseExperiment(thisExp, win=None, timers=[], currentRoutine=None):\n'
             '    """\n'
             '    Pause this experiment, preventing the flow from advancing to the next routine until resumed.\n'
             '    \n'
@@ -2024,9 +2020,9 @@ class SettingsComponent:
             '        Window for this experiment.\n'
             '    timers : list, tuple\n'
             '        List of timers to reset once pausing is finished.\n'
-            '    playbackComponents : list, tuple\n'
-            '        List of any components with a `pause` method which need to be paused.\n'
-            '    """'
+            '    currentRoutine : psychopy.data.Routine\n'
+            '        Current Routine we are in at time of pausing, if any. This object tells PsychoPy what Components to pause/play/dispatch.\n'
+            '    """\n'
         )
         buff.writeIndentedLines(code)
         buff.setIndentLevel(+1, relative=True)
@@ -2040,8 +2036,9 @@ class SettingsComponent:
             "# start a timer to figure out how long we're paused for\n"
             "pauseTimer = core.Clock()\n"
             "# pause any playback components\n"
-            "for comp in playbackComponents:\n"
-            "    comp.pause()\n"
+            "if currentRoutine is not None:\n"
+            "    for comp in currentRoutine.getPlaybackComponents():\n"
+            "        comp.pause()\n"
             "# make sure we have a keyboard\n"
             "defaultKeyboard = deviceManager.getDevice('defaultKeyboard')\n"
             "if defaultKeyboard is None:\n"
@@ -2060,21 +2057,25 @@ class SettingsComponent:
             "        endExperiment(thisExp, win=win)\n"
             )
         code += (
+            "    # dispatch messages on response components\n"
+            "    if currentRoutine is not None:\n"
+            "        for comp in currentRoutine.getDispatchComponents():\n"
+            "            comp.device.dispatchMessages()\n"
             "    # sleep 1ms so other threads can execute\n"
             "    clock.time.sleep(0.001)\n"
             "# if stop was requested while paused, quit\n"
             "if thisExp.status == FINISHED:\n"
             "    endExperiment(thisExp, win=win)\n"
             "# resume any playback components\n"
-            "for comp in playbackComponents:\n"
-            "    comp.play()\n"
+            "if currentRoutine is not None:\n"
+            "    for comp in currentRoutine.getPlaybackComponents():\n"
+            "        comp.play()\n"
             "# reset any timers\n"
             "for timer in timers:\n"
             "    timer.addTime(-pauseTimer.getTime())\n"
         )
         buff.writeIndentedLines(code % self.params)
-
-        # Exit function def
+        # exit function def
         buff.setIndentLevel(-1, relative=True)
         buff.writeIndentedLines("\n")
 
@@ -2113,6 +2114,9 @@ class SettingsComponent:
             "logging.console.setLevel(logging.WARNING)\n"
             "# mark experiment handler as finished\n"
             "thisExp.status = FINISHED\n"
+            "# run any 'at exit' functions\n"
+            "for fcn in runAtExit:\n"
+            "    fcn()\n"
         )
         if self.params['Save log file'].val:
             code += (