pcdsdevices.dream_motion.DREAM_SL3K4

class pcdsdevices.dream_motion.DREAM_SL3K4(prefix, cam, data_source, *, name, **kwargs)

DREAM Motion Class This class controls DREAM SL3K4 SmarAct based scatter slit

Parameters:

• prefix (str) – DREAM:

• name (str, keyword-only) – Alias for the device

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
top	SmarActEtherCAT	:MMT:TOP		normal
bottom	SmarActEtherCAT	:MMT:BOT		normal
north	SmarActEtherCAT	:MMT:NORTH		normal
south	SmarActEtherCAT	:MMT:SOUTH		normal
top_bypass	PytmcSignal	:bEpsTopBypass	EPS Bypass	hinted
bottom_bypass	PytmcSignal	:bEpsBotBypass	EPS Bypass	hinted
north_bypass	PytmcSignal	:bEpsNorthBypass	EPS Bypass	hinted
south_bypass	PytmcSignal	:bEpsSouthBypass	EPS Bypass	hinted
drift_tol	PytmcSignal	:fDriftTol	Blades drifting tolerance	hinted
blades_drift	PytmcSignal	:aBladesfDrift	Array of blade drifts in order [X1, X2, Y1, Y2]	hinted
blades_drifted	PytmcSignal	:aBladesfDrifted	Blades drift status in order [X1, X2, Y1, Y2]	hinted
drift_status	PytmcSignal	:bDrift	SL3K4 drift status	hinted
reset	PytmcSignal	:RESET	Global reset	hinted
status_msg	PytmcSignal	:sStatusMsg	Status message	hinted
state_set	PytmcSignal	:STATE:SET	SL3K4 state setter	hinted
state_get	PytmcSignal	:STATE:GET	SL3K4 state getter	hinted
arb_enable	PytmcSignal	:STATE:PMPS:ARB:ENABLE	Enables PMPS pre-emptive protections. This can be disabled to fall back on fast-fault-only protections. Disabling this will also clear arbiter requests.	config
maint_mode	PytmcSignal	:STATE:PMPS:MAINT	If this is on, we trip a fast fault and then can move the motor freely. Useful for debugging motion issues.	config
ref_refresh	PytmcSignal	:REFRENCING:REFRESH	Must-reference re-home interval in seconds	hinted
must_home	PytmcSignal	:MUSTHOME:ACTIVE	Re-home mandatory, move blocked	hinted
all_homed	PytmcSignal	:ALLHOMED	TRUE when all blades report homed	hinted

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.

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.

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.

stage_group_instances() → Iterator[OphydObject]

Yields an iterator of subdevices that should be staged.

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

connection_timeout

hints

kind

needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

stage_group: list[Component] = None

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})