pcdsdevices.slits.ExitSlits
- class pcdsdevices.slits.ExitSlits(*args, **kwargs)
Attribute
Class
Suffix
Docs
Kind
Notes
lightpath_summary
omitted
Inherited from
LightpathInOutCptMixin
target
:YAG:STATE
Control of the YAG stack via saved positions.
hinted
yag_motor
:MMS:YAG
Direct control of the Yag Stack motor.
normal
gap_motor
:MMS:GAP
Direct control of the slits gap motor.
normal
upper_crystal_pitch_motor
:MMZ:PITCH:TOP
Direct control of the upper slits assembly piezo pitch motor.
normal
lower_crystal_pitch_motor
:MMZ:PITCH:BOTTOM
Direct control of the lower slits assembly piezo pitch motor.
normal
pitch_motor
:MMS:PITCH
Direct control of the slits assembly pitch motor.
normal
vert_motor
:MMS:VERT
Direct control of the slits assembly vertical motor.
normal
roll_motor
:MMS:ROLL
Direct control of the slits assembly roll motor.
normal
detector
:CAM:
Area detector settings and readbacks.
normal
cam_power
:CAM:PWR
Camera power supply controls.
config
fan_power
:FAN:PWR
Fan power supply controls.
config
led_power
:LED:PWR
LED power supply controls.
config
led
:CAM:CIL:PCT
Percent of light from the dimmable illuminatior.
config
yag_thermocouple
:RTD:YAG
Thermocouple on the YAG holder.
normal
upper_crystal_thermocouple
:RTD:CRYSTAL_TOP
Thermocouple on the TOP CRYSTAL.
normal
lower_crystal_thermocouple
:RTD:CRYSTAL_BOTTOM
Thermocouple on the BOTTOM CRYSTAL.
normal
heatsync_thermocouple
:RTD:HeatSync
Thermocouple on the Heat Sync.
normal
Methods
- calc_lightpath_state(**lightpath_kwargs)
Create and return a LightpathState object containing information needed for lightpath, given a set of signal values
kwargs should be the same as the signal names provided in
lightpath_cpts
Device logic goes here.
- Returns:
LightpathState – a dataclass containing the Lightpath state
- 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 theOrderedDict
return byread()
.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.
- get_lightpath_state(use_cache: bool = True) LightpathState
Return the current LightpathState
- Returns:
LightpathState – a dataclass containing the Lightpath state
- 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 theOrderedDict
returned bydescribe()
.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.
- stage_group_instances() Iterator[OphydObject]
Yields an iterator of subdevices that should be staged.
- 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 theStatusBase
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
- lightpath_cpts = ['target']
- md
- 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'>]
- y_states
Alias old name. Will deprecate.