pcdsdevices.undpoint.UndPointAbs2D

class pcdsdevices.undpoint.UndPointAbs2D(prefix: str, *, name: str, done_pvname: str = 'SIOC:SYS0:ML07:AO216', x_abs_pvname: str = 'BPMS:UNDH:4690:XOFF.D', y_abs_pvname: str = 'BPMS:UNDH:4690:YOFF.D', **kwargs)

Undulator pointing variant: absolute move by (x, y)

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
xpos	UnitConversionDerivedSignal	x_raw_rbv		hinted
ypos	UnitConversionDerivedSignal	y_raw_rbv		hinted
x_raw_rbv (FCpt)	EpicsSignalRO	{x_abs_pvname}		omitted
y_raw_rbv (FCpt)	EpicsSignalRO	{y_abs_pvname}		omitted
delta_xy (FCpt)	UndPointDelta2D	{prefix}		normal

Methods

camonitor()

Shows a live-updating motor position in the terminal.

This will be the value that is returned by the position attribute.

This method ends cleanly at a ctrl+c or after a call to end_monitor_thread(), which may be useful when this is called in a background thread.

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.

end_monitor_thread()

Stop a camonitor() or wm_update() that is running in another thread.

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.

get_delta_from_abs(position: tuple[float, float]) → tuple[float, float]

Convert the absolute position request to a delta move.

This is needed because our raw moves are deltas and we need absolute positions for the optimizer.

move(position: tuple[float, float] | float, y_abs: float | None = None, wait: bool = True, timeout: float | None = None, moved_cb: Callable | None = None)

Do an absolute move of the undulator.

Parameters:

• position (tuple[float, float] or float) – If a tuple, this is the x, y position to move to. If a float, this is the x position to move to, and y_abs should be given as the second argument.

• y_abs (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.

mv(position, timeout=None, wait=False, log=True)

Absolute move to a position.

Parameters:

• position – Desired end position.

• timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.

• wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.

• log (bool, optional) – If True, logs the move at INFO level.

post_elog_status()

Post device status to the primary elog, if possible.

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.

screen()

Open a screen for controlling the device.

Default behavior is the typhos screen, but this method can be overridden for more specialized screens.

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.

status() → str

Returns a str with the current pv values for the device.

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.

wait(timeout=None)

wm()

Get the mover’s current positon (where motor).

wm_update()

Shows a live-updating motor position in the terminal.

This will be the value that is returned by the position attribute.

This method ends cleanly at a ctrl+c or after a call to end_monitor_thread(), which may be useful when this is called in a background thread.

Attributes

configuration_attrs

connected

connection_timeout

egu

The engineering units (EGU) for positions

high_limit

hints

kind

limits

low_limit

moving

Whether or not the motor is moving

Returns:

moving (bool)

position

settle_time

Amount of time to wait after moves to report status completion

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