nomad_camels_driver_ni_daq package

Submodules

nomad_camels_driver_ni_daq.daq_signal module

class nomad_camels_driver_ni_daq.daq_signal.DAQ_Signal_Input(name, value=0.0, timestamp=None, parent=None, labels=None, kind='hinted', tolerance=None, rtolerance=None, metadata=None, cl=None, attr_name='', line_name='', digital=False, minV=-10, maxV=10, terminal_config='default')

Bases: SignalRO

destroy()

Disconnect the Signal from the underlying control layer; destroy it

Clears all subscriptions on this Signal. Once destroyed, the signal may no longer be used.

get()

The readback value

setup_line(line_name, digital=None, terminal_config=None, minV=None, maxV=None)

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'meta', 'value'})

class nomad_camels_driver_ni_daq.daq_signal.DAQ_Signal_Output(name, value=0.0, timestamp=None, parent=None, labels=None, kind='hinted', tolerance=None, rtolerance=None, metadata=None, cl=None, attr_name='', line_name='', digital=False, minV=-10, maxV=10, terminal_config='default', wait_time=0)

Bases: Signal

close_task()

put(value, *, timestamp=None, force=False, metadata=None, **kwargs)

Low-level method for writing to a Signal.

The value is optionally checked first, depending on the value of force. In addition, VALUE subscriptions are run.

Extra kwargs are ignored (for API compatibility with EpicsSignal kwargs pass through).

Parameters:

• value (any) – Value to set

• timestamp (float, optional) – The timestamp associated with the value, defaults to time.time()

• metadata (dict, optional) – Further associated metadata with the value (such as alarm status, severity, etc.)

• force (bool, optional) – Check the value prior to setting it, defaults to False

setup_line(line_name, digital=None, terminal_config=None, minV=None, maxV=None)

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'meta', 'value'})

nomad_camels_driver_ni_daq.daq_signal.close_tasks()

nomad_camels_driver_ni_daq.daq_signal.get_an_config(terminal_config='default')

nomad_camels_driver_ni_daq.daq_signal.get_dig_config(terminal_config='default')

nomad_camels_driver_ni_daq.ni_daq module

class nomad_camels_driver_ni_daq.ni_daq.Channel_Widget(parent=None, is_input=True, settings=None)

Bases: QWidget

change_use()

get_settings()

staticMetaObject = PySide6.QtCore.QMetaObject("Channel_Widget" inherits "QWidget": )

class nomad_camels_driver_ni_daq.ni_daq.subclass(**kwargs)

Bases: Device

get_channels()

returns self.channels, should be overwritten for special purposes (e.g. leaving out some keys of the dictionary)

Returns:

self.channels – dictionary containing the device’s channels

Return type:

dict

get_finalize_steps()

Returns the string used in the ‘finally’ part of the protocol’s main function to e.g. close the instrument communication.

Returns:

step_str

Return type:

str

get_settings()

returns self.settings, should be overwritten for special purposes (e.g. leaving out some keys of the dictionary)

Returns:

self.settings

Return type:

dict

class nomad_camels_driver_ni_daq.ni_daq.subclass_config(parent=None, data='', settings_dict=None, config_dict=None, additional_info=None)

Bases: Device_Config

get_settings()

Updates the settings_dict with the current settings. Overwrite this function for each device to specify the settings. It is recommended to still call the super() method for the connection-settings.

staticMetaObject = PySide6.QtCore.QMetaObject("subclass_config" inherits "Device_Config": )

nomad_camels_driver_ni_daq.ni_daq_ophyd module

class nomad_camels_driver_ni_daq.ni_daq_ophyd.Custom_DAQ_Device(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, component_setups=None, **kwargs)

Bases: Device

component_names = ('in1', 'in2', 'in3', 'in4', 'in5', 'in6', 'in7', 'in8', 'out1', 'out2', 'out3', 'out4', 'out5', 'out6', 'out7', 'out8')

finalize_steps()

in1

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

in2

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

in3

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

in4

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

in5

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

in6

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

in7

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

in8

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

out1

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

out2

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

out3

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

out4

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

out5

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

out6

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

out7

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

out8

A descriptor representing a device component (or signal)

Unrecognized keyword arguments will be passed directly to the component class initializer.

Parameters:

• cls (class) –

  Class of signal to create. The required signature of cls.__init__ is (if suffix is given):

  def __init__(self, pv_name, parent=None, **kwargs):
  

  or (if suffix is None)

  def __init__(self, parent=None, **kwargs):
  

  The class may have a wait_for_connection() which is called during the component instance creation.

• suffix (str, optional) – The PV suffix, which gets appended onto parent.prefix to generate the final PV that the instance component will bind to. Also see add_prefix

• lazy (bool, optional) – Lazily instantiate the signal. If False, the signal will be instantiated upon component instantiation. Defaults to component.lazy_default.

• trigger_value (any, optional) – Mark as a signal to be set on trigger. The value is sent to the signal at trigger time.

• add_prefix (sequence, optional) – Keys in the kwargs to prefix with the Device PV prefix during creation of the component instance. Defaults to ('suffix', 'write_pv', )

• doc (str, optional) – string to attach to component DvcClass.component.__doc__

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

wait_conn_sub(all_signals=False, timeout=2.0)

Wait for signals to connect

Parameters:

• all_signals (bool, optional) – Wait for all signals to connect (including lazy ones)

• timeout (float or None) – Overall timeout

wait_for_connection(all_signals=False, timeout=2.0)

Wait for signals to connect

Parameters:

• all_signals (bool, optional) – Wait for all signals to connect (including lazy ones)

• timeout (float or None) – Overall timeout

Module contents