:orphan:

.. _device-PL (and more) Series Channel:

PL (and more) Series Channel
============================

**From:** `AimTTI <https://www.aimtti.com/product-category/dc-power-supplies/aim-plseries>`_
**Class:** :py:class:`herosdevices.hardware.aimtti.pl_series.PLSeriesChannel`

**Driver Quality Index:** beta

A single channel of a PL Series power supply.

This class provides an :py:class:`herosdevices.interfaces.atomiq.VoltageSource` compatible interface to control a
single channel of a PL Series power supply.

.. note::

   This class does not directly connect to the hardware but to another object given by the host_device argument
   which can also be a HERO running on another machine. It can be used to provide a universal interface which does
   not require setting a channel for every operation.


.. tab-set:: 

    .. tab-item:: Arguments

        Bold arguments are mandatory. For more information on the listed arguments refer to the class             documentation: :py:class:`herosdevices.hardware.aimtti.pl_series.PLSeriesChannel` If parameters appear in this             list but not in the class definition, please recursively check the linked base classes for the             definition of the parameter.

        .. list-table:: 
           :widths: 50 50 50 100
           :header-rows: 1

           * - Argument
             - Type
             - Default Value
             - Description
           * - **voltage_limits**
             - **tuple[float, float]**
             - 
             - Voltage limits of the channel. Can be used to set artificial guard rails.
           * - **current_limits**
             - **tuple[float, float]**
             - 
             - Current limits of the channel. Can be used to set artificial guard rails.
           * - **host_device**
             - **<class 'herosdevices.hardware.aimtti.pl_series.GenericPSU'>**
             - 
             - The host :py:class:`GenericPSU` device.
           * - channel
             - <class 'int'>
             - 1
             - The channel to control (1, 2, or 3)

    .. tab-item:: Example JSON for BOSS

        The following JSON strings can be used to start a HERO device representation of             :py:class:`PLSeriesChannel <herosdevices.hardware.aimtti.pl_series.PLSeriesChannel>` using             `BOSS <https://boss-eb4966.gitlab.io/>`_.

        .. code-block:: json

            {
                "_id": "AimTTI_test_ch1",
                "classname": "herosdevices.hardware.aimtti.PLSeriesChannel",
                "arguments": {
                    "host_device": "$AimTTI_test",
                    "channel": 1,
                    "voltage_limits": [
                        0,
                        250
                    ],
                    "current_limits": [
                        0,
                        0.375
                    ]
                }
            }

        :sup:`from examples/aimtti/pl_series.json`

        .. code-block:: json

            {
                "_id": "my_PLSeriesChannel",
                "classname": "herosdevices.hardware.aimtti.pl_series.PLSeriesChannel",
                "arguments": {
                    "voltage_limits": "tuple[float, float]",
                    "current_limits": "tuple[float, float]",
                    "host_device": "<class 'herosdevices.hardware.aimtti.pl_series.GenericPSU'>",
                    "channel": 1
                }
            }

        :sup:`generated from signature`

    .. tab-item:: Inheritance

        .. inheritance-diagram:: herosdevices.hardware.aimtti.pl_series.PLSeriesChannel