PL (and more) Series Channel

From: AimTTI Class: herosdevices.hardware.aimtti.pl_series.PLSeriesChannel

Driver Quality Index: beta

A single channel of a PL Series power supply.

This class provides an 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.

Bold arguments are mandatory. For more information on the listed arguments refer to the class documentation: 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.

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 GenericPSU device.

channel

<class ‘int’>

1

The channel to control (1, 2, or 3)

The following JSON strings can be used to start a HERO device representation of PLSeriesChannel using BOSS.

{
    "_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
        ]
    }
}

from examples/aimtti/pl_series.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
    }
}

generated from signature

Inheritance diagram of herosdevices.hardware.aimtti.pl_series.PLSeriesChannel