Add FTDI 232h driver

.pre-commit-config.yaml

@@ -4,6 +4,6 @@ repos:
     hooks:
       - id: check-yaml
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 25.12.0
     hooks:
       - id: black

docs/conf.py

@@ -55,7 +55,7 @@
 # All aren't necessary for the docs themselves
 autodoc_mock_imports = [
     # import a DLL/shared lib and is platform-dependent
-    "fixate.drivers._ftdi",
+    "fixate.drivers.ftdi._ftdi",
     "PyDAQmx",
     # pulls in platform-dependent libraries
     "pynput",

docs/release-notes.rst

@@ -13,6 +13,7 @@ Major Changes
 
 New Features
 ############
+- FTDI MPSSE I2C functionality that replaces pyftdi with libmpsse.
 
 Improvements
 ############

examples/function_generator.py

@@ -1,6 +1,7 @@
 """
 Examples on how to use the function generator driver
 """
+
 import time
 
 from fixate.core.common import TestClass, TestList

examples/jig_driver.py

@@ -2,6 +2,7 @@
 This file is just a test playground that shows how the update jig classes will
 fit together.
 """
+
 from __future__ import annotations
 from dataclasses import dataclass, field
 from fixate import (

examples/programmable_power_supply.py

@@ -1,6 +1,7 @@
 """
 Examples on how to use the programmable power supply driver works
 """
+
 import time
 
 from fixate.core.common import TestClass, TestList

examples/test_script.py

@@ -1,6 +1,7 @@
 """
 This is a test script that shows basic use case for the fixate library
 """
+
 from fixate.core.common import TestClass, TestList
 from fixate.core.checks import *
 from fixate.core.ui import *

mypy.ini

@@ -67,8 +67,14 @@ exclude = (?x)
                     __init__.py
                     |helper.py
                 )
+                |ftdi/
+                (
+                    __init__.py
+                    |_ftdi_mpsse.py
+                    |_ftdi_py.py
+                    |_libmpsse.py
+                )
                 |__init__.py
-                |ftdi.py
             )
         )
     )

setup.cfg

@@ -39,7 +39,11 @@ install_requires =
 
 [options.packages.find]
 where = src
+include_package_data = True
 
+[options.package_data]
+# this is only for windows. We can look to add support for other platforms in the future if necessary.
+fixate.drivers.ftdi.libs = libmpsse.dll
 
 [options.extras_require]
 gui =

src/fixate/__init__.py

@@ -32,4 +32,4 @@
 
 from fixate.main import run_main_program as run
 
-__version__ = "0.6.4"
+__version__ = "0.6.5"

src/fixate/config/__init__.py

@@ -4,6 +4,7 @@
 Drivers are hard coded into the config to prevent issues arising from auto discovery
 Must ensure driver imports are infallible to prevent program crash on start
 """
+
 from fixate.config.helper import (
     load_dict_config,
     load_yaml_config,

src/fixate/core/checks.py

@@ -2,6 +2,7 @@
 This module is used to allow for tests to test values against criteria.
 It should implement necessary logging functions and report success or failure.
 """
+
 from dataclasses import dataclass, field
 from typing import Any, Callable, Iterable, Optional
 import logging

src/fixate/core/ui.py

@@ -1,6 +1,7 @@
 """
 This module details user input api
 """
+
 import time
 from queue import Queue, Empty
 from pubsub import pub

src/fixate/drivers/daq/daqmx.py

@@ -15,6 +15,7 @@
 C:\Program Files\National Instruments\NI-DAQ\DAQmx ANSI C Dev\include\NIDAQmx.h
 
 """
+
 from collections import namedtuple
 from fixate.core.common import ExcThread
 from queue import Queue, Empty

src/fixate/drivers/dmm/__init__.py

@@ -10,6 +10,7 @@
     dmm.measure(*mode, **mode_params)
     dmm.reset()
 """
+
 import pyvisa
 
 import fixate.drivers

src/fixate/drivers/ftdi.py → src/fixate/drivers/ftdi/__init__.py

@@ -8,7 +8,7 @@
 from fixate.core.common import bits
 from fixate.core.exceptions import FixateError, InstrumentNotConnected
 
-from fixate.drivers._ftdi import ftdI2xx
+from fixate.drivers.ftdi._ftdi import ftdI2xx
 
 # Definitions
 UCHAR = ctypes.c_ubyte
@@ -448,3 +448,13 @@ def open(ftdi_description="") -> FTDI2xx:
     raise InstrumentNotConnected(
         f"No valid ftdi found by description '{ftdi_description}'"
     )
+
+
+from fixate.drivers.ftdi._ftdi_mpsse import (  # noqa: I001 - we don't want these imports to be split up
+    I2CTransferOptions as I2CTransferOptions,
+    I2CClockRate as I2CClockRate,
+    I2CChannelConfig as I2CChannelConfig,
+    MpsseI2C as MpsseI2C,
+    MpsseI2CSimpleInterface as MpsseI2CSimpleInterface,
+    open as open_mpsse,  # explicitly named to avoid conflict with open() at ftdi level.  # noqa: F401
+)

src/fixate/drivers/_ftdi.py → src/fixate/drivers/ftdi/_ftdi.py

@@ -1,4 +1,4 @@
-""" Private wrapper for ftdi driver. DLL on Windows, .so shared library on *nix.
+"""Private wrapper for ftdi driver. DLL on Windows, .so shared library on *nix.
 This is wrapped privately so it can be ommitted from the documentation build.
 """