Merge pull request #12 from TEParsons/main-driver-check

ENH: Detect when FTDI driver is missing and raise an informative error

psychopy_bbtk/tpad.py

@@ -7,6 +7,16 @@
 import sys
 import time
 
+
+# check whether FTDI driver is installed
+hasDriver = False
+try:
+    import ftd2xx
+    hasDriver = True
+except FileNotFoundError:
+    pass
+
+
 # possible values for self.channel
 channelCodes = {
     'A': "Buttons",
@@ -311,6 +321,13 @@ def __init__(
             maxAttempts=1, pauseDuration=1/1000,
             checkAwake=True
     ):
+        # error if there's no ftdi driver
+        if not hasDriver:
+            raise ModuleNotFoundError(
+                "Could not connect to BBTK device as your computer is missing a necessary "
+                "hardware driver. You should be able to find the correct driver for your operating "
+                "system here: https://ftdichip.com/drivers/vcp-drivers/"
+            )
         # get port if not given
         if port is None:
             port = self._detectComPort()[0]

pyproject.toml

@@ -28,6 +28,9 @@ urls.homepage = "https://github.com/psychopy/psychopy-bbtk"
 urls.changelog = "https://github.com/psychopy/psychopy-bbtk/blob/main/CHANGELOG.txt"
 urls.documentation = "https://pages.github.com/psychopy/psychopy-bbtk"
 urls.repository = "https://github.com/psychopy/psychopy-bbtk"
+dependencies = [
+  "ftd2xx"
+]
 
 [tool.setuptools.packages.find]
 where = ["",]