Adding a new device driver¶

This guide will walk through the steps needed to add a new device driver.

drivers\<device_type>[\<device_series>]\<device_driver>.py

Steps to follow¶

1. If the new device is a brand-new device type, add a new device type subpackage

2. Create the new device driver python file and class that inherits the appropriate device type/series base class

   1. If the new device is part of a series (also referred to as a family), add a new series subpackage for them (e.g. power_supplies/psu2200/)

   2. Create the device driver python file, create a class that inherits from the abstracted device type (or series) base class, see example. After creating the first driver that inherits from the abstracted type base class, the rest should look like the example below.

      Note

      For documentation to render for the new driver properly, an __init__() method must be defined.

3. Update the SupportedModels enum exposed in tm_devices/helpers/__init__.py

4. Update the ___SUPPORTED_MODEL_REGEX_STRING regex constant inside tm_devices/helpers/functions.py to include a mapping of the new driver name (model series) to a regex string matching the appropriate model strings

5. Update the _DEVICE_DRIVER_MODEL_STR_MAPPING lookup inside tm_devices/drivers/_device_driver_mapping.py

6. Update the __all__ variable inside tm_devices/drivers/__init__.py to include the new device driver

7. If the device supports VISA USBTMC communication, update the USB_MODEL_ID_LOOKUP lookup exposed in tm_devices/helpers/__init__.py

8. Update the Supported Devices section in README.rst to include the new model

9. Update unit tests (and simulated device files)

   1. Add a new simulated device driver in the correct folder within tests/sim_devices
   2. Update tests/sim_devices/devices.yaml with a new resource for the new driver (Make sure the device name is correct in the devices.yaml and in the corresponding simulated device file)
   3. Update tests/test_all_device_drivers.py with the new simulated resource

10. Run the tests/verify_physical_device_support.py script targeting a physical device that will use the newly created driver to verify it is working properly.

Example of adding a new device series parent driver class¶

A device series driver parent should inherit the abstracted type base class and defines abstract functions that all device drivers must implement.

### drivers/power_supplies/new_series_psu/fancy_power_supply.py
"""Fancy PSU Base device driver for the new series/family of fancy power supplies."""

from abc import ABC
from tm_devices.drivers.power_supplies.power_supply import PowerSupplyUnit
from tm_devices.drivers.device import family_base_class


@family_base_class  # Mark the base class for the new family of devices
class BaseFancyPSU(PowerSupplyUnit, ABC):
    """Base Fancy PSU device driver."""

    # Abstracted functions for specific driver implementation goes here.

### drivers/ower_supplies/new_series_psu/fancy_psu_123.py
"""BaseFancyPSU device driver."""

from tm_devices.drivers.power_supplies.new_series_psu.fancy_power_supply import (
    BaseFancyPSU,
)


class FancyPSU123(BaseFancyPSU):
    """Fancy PSU 123 device driver."""

    # Specific driver implementation goes here.

A final note here, if there was no need for a “fancy” psu family series subpackage, then the driver class can inherit directly from the device type parent, in this example the PowerSupplyUnit class.

Example of adding a new device driver within an existing device type¶

To add a new device driver within the PowerSupply device type and PSU2200 series:

"""NewPSU device driver."""

from tm_devices.drivers.power_supplies.psu22xx.psu2200 import PSU2200


class NewPSU(PSU2200):
    """NewPSU device driver."""

    # Specific driver implementation goes here.