pcdsdevices.spectrometer.Mono

class pcdsdevices.spectrometer.Mono(*args, **kwargs)

L2S-I NEH 2.X Monochromator

Axilon mechatronic desig with LCLS-II Beckhoff motion architecture.

preifxstr

Base PV for the monochromator

namestr

Alias for the device

Ophyd Device Components

Attribute

Class

Suffix

Docs

Kind

Notes

m_pi

BeckhoffAxisNoOffset

:MMS:M_PI

mirror pitch [urad]

normal

g_pi

BeckhoffAxisNoOffset

:MMS:G_PI

grating pitch [urad]

normal

m_h

BeckhoffAxisNoOffset

:MMS:M_H

mirror horizontal [um]

normal

g_h

BeckhoffAxisNoOffset

:MMS:G_H

grating horizontal [um]

normal

sd_v

BeckhoffAxisNoOffset

:MMS:SD_V

screwdriver vertical (in/out) [um]

normal

sd_rot

BeckhoffAxisNoOffset

:MMS:SD_ROT

screwdriver rotation [urad]

normal

m_pi_up_enc

PytmcSignal

:ENC:M_PI:02

mirror pitch upstream encoder [urad]

normal

g_pi_up_enc

PytmcSignal

:ENC:G_PI:02

grating pitch upstream encoder [urad]

normal

led_power_1

PytmcSignal

:LED:01:PWR

LED power supply controls.

config

led_power_2

PytmcSignal

:LED:02:PWR

LED power supply controls.

config

led_power_3

PytmcSignal

:LED:03:PWR

LED power supply controls.

config

flow_1

PytmcSignal

:FSW:01

flow switch 1

normal

flow_2

PytmcSignal

:FSW:02

flow switch 2

normal

pres_1

PytmcSignal

:P1

pressure sensor 1

normal

rtd_1

PytmcSignal

:RTD:01:TEMP

RTD 1 [deg C]

normal

rtd_2

PytmcSignal

:RTD:02:TEMP

RTD 2 [deg C]

normal

rtd_3

PytmcSignal

:RTD:03:TEMP

RTD 3 [deg C]

normal

rtd_4

PytmcSignal

:RTD:04:TEMP

RTD 4 [deg C]

normal

rtd_5

PytmcSignal

:RTD:05:TEMP

RTD 5 [deg C]

normal

rtd_6

PytmcSignal

:RTD:06:TEMP

RTD 6 [deg C]

normal

rtd_7

PytmcSignal

:RTD:07:TEMP

RTD 7 [deg C]

normal

rtd_8

PytmcSignal

:RTD:08:TEMP

RTD 8 [deg C]

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() ophyd.device.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() ophyd.device.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() ophyd.device.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.

stage_group_instances() collections.abc.Iterator[ophyd.ophydobj.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() ophyd.status.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
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'>]
stage_group: list[Component] = None
transmission = 1