nomad_camels_driver_trinamic_tmcm_1110 package

Submodules

nomad_camels_driver_trinamic_tmcm_1110.trinamic_tmcm_1110 module

class nomad_camels_driver_trinamic_tmcm_1110.trinamic_tmcm_1110.subclass(**kwargs): Bases: Device

class nomad_camels_driver_trinamic_tmcm_1110.trinamic_tmcm_1110.subclass_config(parent=None, data='', settings_dict=None, config_dict=None, additional_info=None)

Bases: Simple_Config

Automatically creates a GUI for the configuration values given here. This is perfect for simple devices with just a few settings.

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

nomad_camels_driver_trinamic_tmcm_1110.trinamic_tmcm_1110_ophyd module

class nomad_camels_driver_trinamic_tmcm_1110.trinamic_tmcm_1110_ophyd.TMCM_1110(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, connection_port='', search_reference_on_start=True, motor_number=0, **kwargs)

Bases: Device

component_names = ('set_position', 'get_position', 'ref_search_mode', 'right_lim_switch_disable', 'left_lim_switch_disable', 'ref_search_speed', 'ref_switch_speed', 'max_acceleration', 'max_velocity', 'power_down_delay', 'standby_current', 'max_current', 'freewheeling_delay', 'pulse_divisor', 'ramp_divisor', 'soft_stop_flag', 'microstep_resolution')

configure(d)

Configure the device for something during a run

This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

Parameters:

d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

Returns:

(old, new) tuple of dictionaries
Where old and new are pre- and post-configure configuration states.

finalize_steps()

find_reference()

freewheeling_delay

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__

get_position

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__

left_lim_switch_disable

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__

max_acceleration

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__

max_current

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__

max_velocity

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__

microstep_resolution

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__

move_position(value)

power_down_delay

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__

pulse_divisor

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__

ramp_divisor

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__

ref_search_mode

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__

ref_search_speed

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__

ref_switch_speed

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__

right_lim_switch_disable

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__

set_parameter(value, name)

set_position

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__

soft_stop_flag

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__

standby_current

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'})

Module contents