devctrl.devices.switch.base.Switch

class Switch

Bases: Device

Methods

add_device	Manually add a specific device.
allow_only_dummy_devices
connect
connect_device	This function should be overridden by device implementations only, and is not intended to be used directly.
connect_dummy	Connect an instance of the device's dummy implementation
get_base_classes	Return a flat dictionary of all base classes below this class :param recurse: If True, recursively search for base classes :return: dict of {class name: class}
get_device_name
get_device_type_name
get_status	Query the status of the device and return a string describing errors.
is_connected	Query whether the device is (still) connected
is_on
list_devices	Get a list of all devices for this type.
off
on

_CLASS_TYPE = 'base'

__abstractmethods__ = frozenset({'__repr__', 'connect_device', 'is_connected', 'is_on', 'off', 'on'})

__annotations__ = {'_manual_devices': list[str]}

__dict__ = mappingproxy({'__module__': 'devctrl.devices.switch.base', '__firstlineno__': 4, '_CLASS_TYPE': 'base', 'is_on': <function Switch.is_on>, 'on': <function Switch.on>, 'off': <function Switch.off>, 'get_device_type_name': <classmethod(<function Switch.get_device_type_name>)>, '__static_attributes__': (), '__doc__': None, '__abstractmethods__': frozenset({'is_connected', 'on', 'off', '__repr__', 'connect_device', 'is_on'}), '_abc_impl': <_abc._abc_data object>, '_children': {'DummySwitch': <class 'devctrl.devices.switch.impl.dummy.DummySwitch'>, 'ClewareSwitch': <class 'devctrl.devices.switch.impl.cleware_switch.ClewareSwitch'>, 'NIDAQ': <class 'devctrl.devices.switch.impl.ni_daq.NIDAQ'>}, '_manual_devices': []})

__firstlineno__ = 4

__module__ = 'devctrl.devices.switch.base'

abstractmethod __repr__() → str

Returns:

The name of the device. If applicable, this should include serial port, GPIB address, etc.

__slots__ = ()

__static_attributes__ = ()

__weakref__

list of weak references to the object

_abc_impl = <_abc._abc_data object>

_children = {'ClewareSwitch': <class 'devctrl.devices.switch.impl.cleware_switch.ClewareSwitch'>, 'DummySwitch': <class 'devctrl.devices.switch.impl.dummy.DummySwitch'>, 'NIDAQ': <class 'devctrl.devices.switch.impl.ni_daq.NIDAQ'>}

_dummies_only = False

classmethod _enumerate_devices() → list[str]

This function should be overridden by device implementations only, and is not intended to be used directly. Instead, use list_devices() to get a list of devices. Use enumerate_devices only directly when you only want to list devices of one specific implementation, i.e., only SR830 Lock-In: SR830._enumerate_devices() :param class_name: The name of the device class

_manual_devices: list[str] = []

classmethod add_device(connect_info)

Manually add a specific device. The device will show up when list_devices() is called for the device type. Call this from the device class implementation, e.g. use ModelXYZ9000.add_device(‘GPIB:1234:5678’) to add a specific device with a fixed GPIB address. This is useful when automatic discovery is undesired/impossible, either because it is not implemented or it disturbs other devices which can’t handle a identification request. :param cls: The device implementation class :param connect_info: A string argument that is passed to the connect() method of the device implementation, when the device is being connected.

static allow_only_dummy_devices()

classmethod connect(device_type_name: str, device_name: str | None, **kwargs) → Device

Parameters:

• device_type_name – The name of the device class

• device_name – The name of the device class

abstractmethod classmethod connect_device(device_name: str) → Device

This function should be overridden by device implementations only, and is not intended to be used directly. Instead, use list_devices() to get a list of devices, and pass the selected device type and name to connect() :param device_name: The name of the device class

classmethod connect_dummy(**kwargs) → Device

Connect an instance of the device’s dummy implementation

classmethod get_base_classes(recurse=True) → dict[str, type[Device]]

Return a flat dictionary of all base classes below this class :param recurse: If True, recursively search for base classes :return: dict of {class name: class}

classmethod get_device_name() → str

Returns:

The specific type name of the device, e.g., SR830 or Keithly2600

classmethod get_device_type_name() → str

Returns:

The general type name of the device, e.g., Lock-In Amplifier or Voltmeter

get_status() → str

Query the status of the device and return a string describing errors. If everything is ok, empty string must be returned :return: String of device status

abstractmethod is_connected() → bool

Query whether the device is (still) connected

abstractmethod is_on() → bool

classmethod list_devices() → list[tuple[str, str]]

Get a list of all devices for this type. The list made up of: - Manually added devices - Available devices (those returned by _enumerate_devices) - A dummy device (if a dummy implementation exists) - List of all devices of child classes

Returns:

list of available devices

abstractmethod off()

abstractmethod on()