pcdsdevices.he_lodcm.HE_LODCM

class pcdsdevices.he_lodcm.HE_LODCM(prefix, *args, **kwargs)

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
energy	HE_LODCMEnergy			hinted
t1ty	BeckhoffAxis	:MMS:T1Ty	Tower 1 translation Y	normal
t1tx	BeckhoffAxisEPS	:MMS:T1Tx	Tower 1 translation X	normal
t1ry	BeckhoffAxisEPS	:MMS:T1Ry	Tower 1 rotation Y	normal
t1tp	BeckhoffAxisEPS	:MMS:T1Tp	Tower 1 TP	normal
t1rp	BeckhoffAxisEPS	:MMS:T1Rp	Tower 1 RP	normal
t2ty1	BeckhoffAxis	:MMS:T2Ty	Tower 2 translation Y 1	normal
t2ty2	BeckhoffAxis	:MMS:T2Ty2	Tower 2 translation Y 2	normal
t2tz	BeckhoffAxisEPS	:MMS:T2Tz	Tower 2 translation Z	normal
t2ry	BeckhoffAxisEPS	:MMS:T2Ry	Tower 2 rotation Y	normal
t2tn	BeckhoffAxisEPS	:MMS:T2Tn	Tower 2 translation TN	normal
t2tp	BeckhoffAxisEPS	:MMS:T2Tp	Tower 2 translation TP	normal
t2rp	BeckhoffAxisEPS	:MMS:T2Rp	Tower 2 translation RP	normal
d1ry	BeckhoffAxisEPS	:MMS:D1Ry	Diagnostic 1 rotation Y	normal
d1ty	BeckhoffAxisEPS	:MMS:D1Ty	Diagnostic 1 translation Y	normal
d2tx	BeckhoffAxisEPS	:MMS:D2Tx	Diagnostic 2 translation X	normal
d2ty	BeckhoffAxisEPS	:MMS:D2Ty	Diagnostic 2 translation Y	normal
tct1	Lakeshore336	:TCT:01	Crystal 1 temperature controller	normal
tct2	Lakeshore336	:TCT:02	Crystal 2 temperature controller	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.

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