pcdsdevices.beam_stats.FakeBeamEnergyRequest

class pcdsdevices.beam_stats.FakeBeamEnergyRequest(*args, acr_status_suffix: Optional[str] = None, **kwargs)

Required setup for fake classes to work properly with __new__ splitting

Ophyd Device Components

Attribute

Class

Suffix

Docs

Kind

Notes

setpoint (FCpt)

FakeEpicsSignal

{prefix}:USER:MCC:EPHOT{line_text}:SET{bunch}

The setpoint PV that acr listens on to update the vernier or undulator PVs as appropriate.

hinted

Inherited from FakeBeamEnergyRequest

ref (FCpt)

FakeEpicsSignal

{prefix}:USER:MCC:EPHOT{line_text}:REF{bunch}

A reference PV for the photon energy at the nominal position of the vernier or undulator.

normal

Inherited from FakeBeamEnergyRequest

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, moved_cb=None, timeout=None)

Move to a specified position, optionally waiting for motion to complete.

Parameters

  • position – Position to move to

  • 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. It should also accept a positional argument ‘status’, the Status object.

    Changed in version 1.5.0: The expected signature changed from moved_cb(*, obj) to moved_cb(status, *, obj). The old signature is still supported, but a warning will be issued.

  • timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

Returns

status (MoveStatus)

Raises
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: Optional[float] = None, moved_cb: Optional[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.

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.

Attributes

configuration_attrs
connected
egu

The engineering units (EGU) for positions

high_limit
hints
k_hutch = 'RIX'
kind
l_hutch = 'MEC'
limits
line_text_dict = {'CXI': '', 'K': 'K', 'L': '', 'MEC': '', 'MFX': '', 'RIX': 'K', 'TMO': 'K', 'XCS': '', 'XPP': '', 'k': 'K', 'l': ''}
low_limit
moving

Whether or not the motor is moving

Returns

moving (bool)

position

The current position of the motor in its engineering units

Returns

position (any)

settle_time

Amount of time to wait after moves to report status completion

timeout

Amount of time to wait before to considering a motion as failed