The oxford_valve module

Controller for an oxford valve.

Classes

OxfordValve

class src.instruments.noauto.oxford_valve.OxfordValve(name='Valve', protocol='ISOBUS', isobusAddress='0', visaAddress='GPIB0::23', serialConfig=None, present=True, normallyClosed=True, channel='1')

This is a class to perform actions common to most Oxford Instruments devices, including the ITC503, the PS120, and the IPS120.

Parameters :

name : str

A name to identify the instrument

protocol : {‘ISOBUS’, ‘GPIB’, ‘Serial’, ‘Gateway Master’, ‘Gateway Slave’}

The protocol for communication between the computer and the power supply.

isobusAddress : str

An integer string representing the ISOBUS address, if relevant. An integer will be accepted and converted.

visaAddress : str

A full VISA resource address (including the bus) to locate the instrument (e.g. “GPIB0::27”).

serialConfig : dict

A dictionary to indicate how to configure a serial port, which is used with both the ‘ISOBUS’ and ‘Serial’ protocols.

normallyClosed : bool

Whether the valve is normally closed. False means the valve is normally open.

Methods

closeValve()

Close the valve.

getOpen()

Return whether the valve is open.

Returns :

bool :

True if the valve is open, or False if it is closed.

openValve()

Open the valve.