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

psychopy/hardware/minolta.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
 # Distributed under the terms of the GNU General Public License (GPL).
 
 """Interfaces for Minolta light-measuring devices.
@@ -12,12 +12,22 @@ These are optional components that can be obtained by installing the
 
 """
 
-from psychopy.tools.pkgtools import PluginStub
+from psychopy.plugins import PluginStub
 
 
-class CS100A(PluginStub, plugin="psychopy-minolta", doclink="https://psychopy.github.io/psychopy-minolta/coder/CS100A"):
+class CS100A(
+    PluginStub, 
+    plugin="psychopy-minolta", 
+    docsHome="https://psychopy.github.io/psychopy-minolta",
+    docsRef="/coder/CS100A"
+):
     pass
 
 
-class LS100(PluginStub, plugin="psychopy-minolta", doclink="https://psychopy.github.io/psychopy-minolta/coder/LS100"):
+class LS100(
+    PluginStub, 
+    plugin="psychopy-minolta", 
+    docsHome="https://psychopy.github.io/psychopy-minolta",
+    docsRef="/coder/LS100"
+):
     pass

psychopy/hardware/mouse/__init__.py

@@ -5,7 +5,7 @@
 """
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
 # Distributed under the terms of the GNU General Public License (GPL).
 
 __all__ = [

psychopy/hardware/photometer/__init__.py

@@ -9,7 +9,7 @@ by calling the :func:`getAllPhotometers()` function.
 """
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
 # Distributed under the terms of the GNU General Public License (GPL).
 
 __all__ = [
@@ -18,7 +18,7 @@ __all__ = [
     'getAllPhotometerClasses'
 ]
 
-from psychopy.tools.pkgtools import PluginStub
+from psychopy.plugins import PluginStub
 
 # Special handling for legacy classes which have been offloaded to optional
 # packages. This will change to allow more flexibility in the future to avoid

psychopy/hardware/pr.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
 # Distributed under the terms of the GNU General Public License (GPL).
 
 """Interfaces for Photo Research Inc. spectroradiometers.
@@ -12,12 +12,22 @@ These are optional components that can be obtained by installing the
 
 """
 
-from psychopy.tools.pkgtools import PluginStub
+from psychopy.plugins import PluginStub
 
 
-class PR650(PluginStub, plugin="psychopy-photoresearch", doclink="https://psychopy.github.io/psychopy-photoresearch/coder/PR650"):
+class PR650(
+    PluginStub, 
+    plugin="psychopy-photoresearch", 
+    docsHome="https://psychopy.github.io/psychopy-photoresearch",
+    docsRef="/coder/PR650"
+):
     pass
 
 
-class PR655(PluginStub, plugin="psychopy-photoresearch", doclink="https://psychopy.github.io/psychopy-photoresearch/coder/PR655"):
+class PR655(
+    PluginStub, 
+    plugin="psychopy-photoresearch", 
+    docsHome="https://psychopy.github.io/psychopy-photoresearch",
+    docsRef="/coder/PR655"
+):
     pass

psychopy/hardware/qmix.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
 # Distributed under the terms of the GNU General Public License (GPL).
 
 """Interfaces for Cetoni neMESYS syringe pump systems.
@@ -12,30 +12,21 @@ These are optional components that can be obtained by installing the
 
 """
 
-import psychopy.logging as logging
-
-try:
-    from psychopy_qmix import (
-        Pump,
-        _init_all_pumps,
-        _init_bus,
-        _checkSyringeTypes,
-        _PumpWrapperForBuilderComponent,
-        volumeUnits,  # don't use module level constants in plugins
-        flowRateUnits,
-        configName,
-        bus,
-        pumps,
-        syringeTypes)
-except (ModuleNotFoundError, ImportError):
-    logging.error(
-        "Support for the Cetoni neMESYS syringe pump system is not available "
-        "this session. Please install `psychopy-qmix` and restart the session "
-        "to enable support.")
-except Exception as e:
-    logging.error(
-        "Error encountered while loading `psychopy-qmix`. Check logs for more "
-        "information.")
-
-if __name__ == "__main__":
+
+from psychopy.plugins import PluginStub
+
+
+class Pump(
+    PluginStub,
+    plugin="psychopy-labjack",
+    docsHome="http://github.com/psychopy/psychopy-qmix",
+):
     pass
+
+
+volumeUnits: list
+flowRateUnits: list
+configName: dict
+bus: object
+pumps: list
+syringeTypes: list

psychopy/hardware/serialdevice.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Part of the PsychoPy library
-# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
 # Distributed under the terms of the GNU General Public License (GPL).
 
 """Base class for serial devices. Includes some convenience methods to open
@@ -14,6 +14,9 @@ import time
 
 from psychopy import logging
 import serial
+
+from psychopy.localization import _translate
+from .exceptions import DeviceNotConnectedError
 from psychopy.tools import systemtools as st
 from psychopy.tools.attributetools import AttributeGetSetMixin
 from .base import BaseDevice
@@ -174,6 +177,14 @@ class SerialDevice(BaseDevice, AttributeGetSetMixin):
             # store device in ports dict
             global ports
             ports[port] = self
+        else:
+            raise DeviceNotConnectedError(
+                _translate(
+                    "Failed to connect to device on {port}, this device is likely to have "
+                    "been disconnected, or the port is in use by another application."
+                ).format(port=port), 
+                deviceClass=SerialDevice
+            )
         # we aren't in a time-critical period so flush messages
         logging.flush()
 
@@ -190,7 +201,16 @@ class SerialDevice(BaseDevice, AttributeGetSetMixin):
         time.sleep(self.pauseDuration)
 
     def sendMessage(self, message, autoLog=True):
-        """Send a command to the device (does not wait for a reply or sleep())
+        """
+        Send a command to the device (does not wait for a reply or sleep())
+
+        Parameters
+        ----------
+        message : str or bytes
+            Message to send to the device - if given as a string, SerialDevice will encode it 
+            into bytes for you
+        autoLog : bool
+            If True, then the message sent will be logged at level DEBUG
         """
         if self.com.inWaiting():
             inStr = self.com.read(self.com.inWaiting())
@@ -202,22 +222,29 @@ class SerialDevice(BaseDevice, AttributeGetSetMixin):
             message += self.eol  # append a newline if necess
         self.com.write(message)
         self.com.flush()
+        # log
         if autoLog:
-            msg = b'Sent %s message:' % (self.name)
-            logging.debug(msg + message.replace(self.eol, b''))  # complete msg
-            # we aren't in a time-critical period so flush msg
+            logging.debug(
+                f"Sent {self.name} message: " + repr(message)
+            )
+            # sending isn't as time-critical as receiving, so we can flush now
             logging.flush()
 
-    def getResponse(self, length=1, timeout=0.1):
-        """Read the latest response from the serial port
-
-        Parameters:
+    def getResponse(self, length=1, timeout=0.1, autoLog=True):
+        """
+        Read the latest response from the serial port
 
-        `length` determines whether we expect:
+        Parameters
+        ----------
+        length : int
+           One of:
            - 1: a single-line reply (use readline())
            - 2: a multiline reply (use readlines() which *requires* timeout)
-           - -1: may not be any EOL character; just read whatever chars are
-                there
+           - -1: may not be any EOL character; just read whatever chars are there
+        timeout : float
+            How long to wait for a response before giving up
+        autoLog : bool
+            If True, then the message sent will be logged at level DEBUG
         """
         # get reply (within timeout limit)
         self.com.timeout = timeout
@@ -230,6 +257,10 @@ class SerialDevice(BaseDevice, AttributeGetSetMixin):
             retVal = self.com.read(self.com.inWaiting())
         if type(retVal) is bytes:
             retVal = retVal.decode('utf-8')
+        # log
+        if retVal and autoLog:
+            logging.debug(f"Received {self.name} message: " + repr(retVal))
+        
         return retVal
 
     def awaitResponse(self, multiline=False, timeout=None):