nomad_camels_driver_iBeam_smart package
Submodules
nomad_camels_driver_iBeam_smart.iBeam_smart module
- nomad_camels_driver_iBeam_smart.iBeam_smart.get_configs_from_ophyd(ophyd_instance)
- class nomad_camels_driver_iBeam_smart.iBeam_smart.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
- update_driver()
- class nomad_camels_driver_iBeam_smart.iBeam_smart.subclass_config(parent=None, data='', settings_dict=None, config_dict=None, additional_info=None)
Bases:
Simple_Config
- get_iBeam_channels()
- get_settings()
- staticMetaObject = PySide6.QtCore.QMetaObject("subclass_config" inherits "Simple_Config": )
nomad_camels_driver_iBeam_smart.iBeam_smart_ophyd module
- class nomad_camels_driver_iBeam_smart.iBeam_smart_ophyd.Ibeam_Smart(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, resource_name='', baudrate=115200, channels=None, Com_port='', **kwargs)
Bases:
Sequential_Device
- component_names = ('laser_data', 'laser_info', 'read_laser_temp', 'use_FINE', 'use_SKILL', 'use_FINE_type', 'use_SKILL_type', 'enable_output', 'disable_output', 'enable_digitial_modulation', 'disable_digitial_modulation')
- disable_channel(channel_number)
- disable_digitial_modulation
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- disable_digitial_modulation_function(value)
- disable_output
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- disable_output_function(value)
- enable_channel(channel_number)
- enable_digitial_modulation
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- enable_digitial_modulation_function(value)
- enable_output
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- enable_output_function(value)
- finalize_steps()
- laser_data
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- laser_info
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- read_laser_data_read_function()
- read_laser_info_read_function()
- read_laser_temp
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- read_laser_temp_read_function()
- read_power_channel(channel_number)
- set_FINE_function(value)
- set_SKILL_function(value)
- set_power_channel(channel_number, value)
- subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})
- use_FINE
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- use_FINE_type
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- use_SKILL
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- use_SKILL_type
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 seeadd_prefix
lazy (bool, optional) – Lazily instantiate the signal. If
False
, the signal will be instantiated upon component instantiation. Defaults tocomponent.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__
- nomad_camels_driver_iBeam_smart.iBeam_smart_ophyd.make_ophyd_class(channels)
- nomad_camels_driver_iBeam_smart.iBeam_smart_ophyd.make_ophyd_instance(prefix='', *args, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, resource_name='', write_termination='\r\n', read_termination='\r\n', baud_rate=115200, channels=None, Com_port='', **kwargs)