NUPyLab Instrument

class nupylab.utilities.nupylab_instrument.NupylabInstrument(data_label: str | Sequence[str], name: str, *args, **kwargs)

Bases: object

Generic NUPyLab instrument for instruments to subclass.

Ensures that subclasses have implemented all necessary methods and attributes.

data_label

labels for DataTuples.

name

name of instrument.

lock

thread lock for preventing simultaneous calls to instrument.

Instantiate generic NUPyLab instrument.

Parameters:
  • data_label – one or more labels for DataTuples, should match entries in DATA_COLUMNS of calling procedure class.

  • name – name of instrument.

connect() None

Connect to instrument.

property connected: bool

Get whether instrument is connected.

property finished: bool

Get whether measurement is finished. Default True unless overwritten.

get_data() DataTuple | Sequence[DataTuple]

Get data from instrument.

Returns:

one or more DataTuples.

set_parameters(*args, **kwargs) None

Set instrument measurement parameters.

shutdown() None

Shutdown instrument and close connection.

start() None

Start instrument.

stop_measurement() None

Stop instrument measurement.