pcdsdevices.undpoint.UndPointDelta2D

class pcdsdevices.undpoint.UndPointDelta2D(prefix: str, *, done_pvname: str = 'SIOC:SYS0:ML07:AO216', name: str, **kwargs)

Undulator pointing variant: delta move by (x, y).

This is the raw interface provided by ACR. All other variants re-use these definitions.

Ophyd Device Components
Attribute	Class	Suffix	Kind
setpoint	`MultiDerivedSignal`		normal
delta_x	`EpicsSignal`	`:DELTA_X`	normal
delta_y	`EpicsSignal`	`:DELTA_Y`	normal
actuate	`EpicsSignal`	`:GO`	normal
done (FCpt)	`EpicsSignalRO`	`{done_pvname}`	normal

Methods

configure(d: Dict[str, Any]) → Tuple[Dict[str, Any], Dict[str, Any]]

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.

describe() → OrderedDictType[str, Dict[str, Any]]

Provide schema and meta-data for read().

This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

This provides schema related information, (ex shape, dtype), the source (ex PV name), and if available, units, limits, precision etc.

Returns:: data_keys (OrderedDict) – The keys must be strings and the values must be dict-like with the event_model.event_descriptor.data_key schema.

get(**kwargs)

Get the value of all components in the device

Keyword arguments are passed onto each signal.get(). Components beginning with an underscore will not be included.

move(position: tuple[float, float] | float, y_delta: float | None = None, wait: bool = True, timeout: float | None = None, moved_cb: Callable | None = None) → MoveStatus

Do a relative move of the undulator.

Parameters:

position (tuple[float, float] or float) – If a tuple, this is the x, y delta to move by. If a float, this is the x delta to move by, and y_delta should be given as the second argument.
y_delta (float, optional) – If position is given as as float x value, this is the accompanying y value.
wait (bool, optional) – Whether to wait for the move to complete, or not. Defaults to True.
timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.
moved_cb (callable) – Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

read() → OrderedDictType[str, Dict[str, Any]]

Read data from the device.

This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in trigger().

The OrderedDict returned by this method must have identical keys (in the same order) as the OrderedDict returned by describe().

By convention, the first key in the return is the ‘primary’ key and maybe used by heuristics in bluesky.

The values in the ordered dictionary must be dict (-likes) with the keys {'value', 'timestamp'}. The 'value' may have any type, the timestamp must be a float UNIX epoch timestamp in UTC.

Returns:: data (OrderedDict) – The keys must be strings and the values must be dict-like with the keys {'value', 'timestamp'}

read_configuration() → OrderedDictType[str, Dict[str, Any]]

Dictionary mapping names to value dicts with keys: value, timestamp

To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

set(new_position: Any, *, timeout: float = None, moved_cb: Callable = None, wait: bool = False) → StatusBase

Set a value and return a Status object

Parameters:

new_position (object) – The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples
timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.
moved_cb (callable, optional) –
Deprecated

Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.
wait (bool, optional) –
Deprecated

If the method should block until the Status object reports it is done.

Defaults to False

Returns:

status (StatusBase) – Status object to indicate when the motion / set is done.

classmethod set_defaults(*, connection_timeout=10.0)

Set class-wide defaults for device communications

This may be called only before any instances of Device are made.

This setting applies to the class it is called on and all its subclasses. For example,

>>> Device.set_defaults(...)

will apply to any Device subclass.

Parameters:: connection_timeout (float, optional) – Time (seconds) allocated for establishing a connection with the IOC.
Raises:: RuntimeError – If called after EpicsSignalBase has been instantiated for the first time.

stop(*, success=False): Stop the Device and all (instantiated) subdevices

summary()

trigger() → StatusBase

Trigger the device and return status object.

This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

If there is an appreciable time between triggering the device and it being able to be read (via the read() method) then this method is also responsible for arranging that the StatusBase object returned by this method is notified when the device is ready to be read.

If there is no delay between triggering and being readable, then this method must return a StatusBase object which is already completed.

Returns:: status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

Attributes

actuate_value = 1

configuration_attrs

connected

connection_timeout

done_value = 0

egu: The engineering units (EGU) for a position

high_limit

hints

kind

limits

low_limit

moving

Whether or not the motor is moving

If a done PV is specified, it will be read directly to get the motion status. If not, it determined from the internal state of PVPositioner.

Returns:: bool

position

The current position of the motor in its engineering units

Returns:: position (any)

put_complete

readback = None

settle_time: Amount of time to wait after moves to report status completion

stop_signal = None

stop_value = 1

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'_req_done', 'acq_done', 'done_moving', 'readback', 'start_moving'})

timeout: Amount of time to wait before to considering a motion as failed