Miscellaneous devices

CompactRIO

NI-9215

sophys.common.devices.crio.CRIO_9215(prefix, ...)

An Ophyd device for the NI-9215 CompactRIO device, with 4 analog inputs.

class sophys.common.devices.crio.CRIO_9215(prefix: str, **kwargs)

An Ophyd device for the NI-9215 CompactRIO device, with 4 analog inputs.

Attributes

ai0	BaseAnalogInput --- Suffix = ai0 | Kind.hinted
ai0_offset	EpicsSignal --- Suffix = ai0_Offset | Kind.config
ai0_scale_factor	EpicsSignal --- Suffix = ai0_SF | Kind.config
ai1	BaseAnalogInput --- Suffix = ai1 | Kind.hinted
ai1_offset	EpicsSignal --- Suffix = ai1_Offset | Kind.config
ai1_scale_factor	EpicsSignal --- Suffix = ai1_SF | Kind.config
ai2	BaseAnalogInput --- Suffix = ai2 | Kind.hinted
ai2_offset	EpicsSignal --- Suffix = ai2_Offset | Kind.config
ai2_scale_factor	EpicsSignal --- Suffix = ai2_SF | Kind.config
ai3	BaseAnalogInput --- Suffix = ai3 | Kind.hinted
ai3_offset	EpicsSignal --- Suffix = ai3_Offset | Kind.config
ai3_scale_factor	EpicsSignal --- Suffix = ai3_SF | Kind.config
disable_file_close	EpicsSignal --- Suffix = {global_prefix}DisableFileClose | Kind.omitted
file_averaging_time	EpicsSignal --- Suffix = {global_prefix}FileAvgTime | Kind.config
pv_averaging_time	EpicsSignal --- Suffix = {global_prefix}PvAvgTime | Kind.config
saving_to_file	EpicsSignalRO --- Suffix = {global_prefix}AnalogSaving2File | Kind.omitted

NI-9220

sophys.common.devices.crio.CRIO_9220(prefix, ...)

An Ophyd device for the NI-9220 CompactRIO device, with 16 analog inputs.

class sophys.common.devices.crio.CRIO_9220(prefix: str, **kwargs)

An Ophyd device for the NI-9220 CompactRIO device, with 16 analog inputs.

Attributes

ai0	BaseAnalogInput --- Suffix = ai0 | Kind.hinted
ai0_offset	EpicsSignal --- Suffix = ai0_Offset | Kind.config
ai0_scale_factor	EpicsSignal --- Suffix = ai0_SF | Kind.config
ai1	BaseAnalogInput --- Suffix = ai1 | Kind.hinted
ai1_offset	EpicsSignal --- Suffix = ai1_Offset | Kind.config
ai1_scale_factor	EpicsSignal --- Suffix = ai1_SF | Kind.config
ai2	BaseAnalogInput --- Suffix = ai2 | Kind.hinted
ai2_offset	EpicsSignal --- Suffix = ai2_Offset | Kind.config
ai2_scale_factor	EpicsSignal --- Suffix = ai2_SF | Kind.config
ai3	BaseAnalogInput --- Suffix = ai3 | Kind.hinted
ai3_offset	EpicsSignal --- Suffix = ai3_Offset | Kind.config
ai3_scale_factor	EpicsSignal --- Suffix = ai3_SF | Kind.config
ai4	BaseAnalogInput --- Suffix = ai4 | Kind.hinted
ai4_offset	EpicsSignal --- Suffix = ai4_Offset | Kind.config
ai4_scale_factor	EpicsSignal --- Suffix = ai4_SF | Kind.config
ai5	BaseAnalogInput --- Suffix = ai5 | Kind.hinted
ai5_offset	EpicsSignal --- Suffix = ai5_Offset | Kind.config
ai5_scale_factor	EpicsSignal --- Suffix = ai5_SF | Kind.config
ai6	BaseAnalogInput --- Suffix = ai6 | Kind.hinted
ai6_offset	EpicsSignal --- Suffix = ai6_Offset | Kind.config
ai6_scale_factor	EpicsSignal --- Suffix = ai6_SF | Kind.config
ai7	BaseAnalogInput --- Suffix = ai7 | Kind.hinted
ai7_offset	EpicsSignal --- Suffix = ai7_Offset | Kind.config
ai7_scale_factor	EpicsSignal --- Suffix = ai7_SF | Kind.config
ai8	BaseAnalogInput --- Suffix = ai8 | Kind.hinted
ai8_offset	EpicsSignal --- Suffix = ai8_Offset | Kind.config
ai8_scale_factor	EpicsSignal --- Suffix = ai8_SF | Kind.config
ai9	BaseAnalogInput --- Suffix = ai9 | Kind.hinted
ai9_offset	EpicsSignal --- Suffix = ai9_Offset | Kind.config
ai9_scale_factor	EpicsSignal --- Suffix = ai9_SF | Kind.config
ai10	BaseAnalogInput --- Suffix = ai10 | Kind.hinted
ai10_offset	EpicsSignal --- Suffix = ai10_Offset | Kind.config
ai10_scale_factor	EpicsSignal --- Suffix = ai10_SF | Kind.config
ai11	BaseAnalogInput --- Suffix = ai11 | Kind.hinted
ai11_offset	EpicsSignal --- Suffix = ai11_Offset | Kind.config
ai11_scale_factor	EpicsSignal --- Suffix = ai11_SF | Kind.config
ai12	BaseAnalogInput --- Suffix = ai12 | Kind.hinted
ai12_offset	EpicsSignal --- Suffix = ai12_Offset | Kind.config
ai12_scale_factor	EpicsSignal --- Suffix = ai12_SF | Kind.config
ai13	BaseAnalogInput --- Suffix = ai13 | Kind.hinted
ai13_offset	EpicsSignal --- Suffix = ai13_Offset | Kind.config
ai13_scale_factor	EpicsSignal --- Suffix = ai13_SF | Kind.config
ai14	BaseAnalogInput --- Suffix = ai14 | Kind.hinted
ai14_offset	EpicsSignal --- Suffix = ai14_Offset | Kind.config
ai14_scale_factor	EpicsSignal --- Suffix = ai14_SF | Kind.config
ai15	BaseAnalogInput --- Suffix = ai15 | Kind.hinted
ai15_offset	EpicsSignal --- Suffix = ai15_Offset | Kind.config
ai15_scale_factor	EpicsSignal --- Suffix = ai15_SF | Kind.config
disable_file_close	EpicsSignal --- Suffix = {global_prefix}DisableFileClose | Kind.omitted
file_averaging_time	EpicsSignal --- Suffix = {global_prefix}FileAvgTime | Kind.config
pv_averaging_time	EpicsSignal --- Suffix = {global_prefix}PvAvgTime | Kind.config
saving_to_file	EpicsSignalRO --- Suffix = {global_prefix}AnalogSaving2File | Kind.omitted

NI-9223

sophys.common.devices.crio.CRIO_9223(prefix, ...)

An Ophyd device for the NI-9223 CompactRIO device, with 4 analog inputs.

class sophys.common.devices.crio.CRIO_9223(prefix: str, **kwargs)

An Ophyd device for the NI-9223 CompactRIO device, with 4 analog inputs.

Attributes

ai0	BaseAnalogInput --- Suffix = ai0 | Kind.hinted
ai0_offset	EpicsSignal --- Suffix = ai0_Offset | Kind.config
ai0_scale_factor	EpicsSignal --- Suffix = ai0_SF | Kind.config
ai1	BaseAnalogInput --- Suffix = ai1 | Kind.hinted
ai1_offset	EpicsSignal --- Suffix = ai1_Offset | Kind.config
ai1_scale_factor	EpicsSignal --- Suffix = ai1_SF | Kind.config
ai2	BaseAnalogInput --- Suffix = ai2 | Kind.hinted
ai2_offset	EpicsSignal --- Suffix = ai2_Offset | Kind.config
ai2_scale_factor	EpicsSignal --- Suffix = ai2_SF | Kind.config
ai3	BaseAnalogInput --- Suffix = ai3 | Kind.hinted
ai3_offset	EpicsSignal --- Suffix = ai3_Offset | Kind.config
ai3_scale_factor	EpicsSignal --- Suffix = ai3_SF | Kind.config
disable_file_close	EpicsSignal --- Suffix = {global_prefix}DisableFileClose | Kind.omitted
file_averaging_time	EpicsSignal --- Suffix = {global_prefix}FileAvgTime | Kind.config
pv_averaging_time	EpicsSignal --- Suffix = {global_prefix}PvAvgTime | Kind.config
saving_to_file	EpicsSignalRO --- Suffix = {global_prefix}AnalogSaving2File | Kind.omitted

NI-9403

sophys.common.devices.crio.CRIO_9403(prefix, ...)

An Ophyd device for the NI-9403 CompactRIO device.

class sophys.common.devices.crio.CRIO_9403(prefix: str, **kwargs)

An Ophyd device for the NI-9403 CompactRIO device.

Commonly used as a TATU - Timing and Trigger Unit, this device contains low-level debug signals for such usages.

Attributes

bi0	EpicsSignalRO --- Suffix = bi0 | Kind.normal
bi1	EpicsSignalRO --- Suffix = bi1 | Kind.normal
bi2	EpicsSignalRO --- Suffix = bi2 | Kind.normal
bi3	EpicsSignalRO --- Suffix = bi3 | Kind.normal
bi8	EpicsSignalRO --- Suffix = bi8 | Kind.normal
bi9	EpicsSignalRO --- Suffix = bi9 | Kind.normal
bi10	EpicsSignalRO --- Suffix = bi10 | Kind.normal
bi11	EpicsSignalRO --- Suffix = bi11 | Kind.normal
bi16	EpicsSignalRO --- Suffix = bi16 | Kind.normal
bi17	EpicsSignalRO --- Suffix = bi17 | Kind.normal
bi18	EpicsSignalRO --- Suffix = bi18 | Kind.normal
bi19	EpicsSignalRO --- Suffix = bi19 | Kind.normal
bo4	EpicsSignalWithRBV --- Suffix = bo4 | Kind.normal
bo5	EpicsSignalWithRBV --- Suffix = bo5 | Kind.normal
bo6	EpicsSignalWithRBV --- Suffix = bo6 | Kind.normal
bo7	EpicsSignalWithRBV --- Suffix = bo7 | Kind.normal
bo12	EpicsSignalWithRBV --- Suffix = bo12 | Kind.normal
bo13	EpicsSignalWithRBV --- Suffix = bo13 | Kind.normal
bo14	EpicsSignalWithRBV --- Suffix = bo14 | Kind.normal
bo15	EpicsSignalWithRBV --- Suffix = bo15 | Kind.normal
bo20	EpicsSignalWithRBV --- Suffix = bo20 | Kind.normal
bo21	EpicsSignalWithRBV --- Suffix = bo21 | Kind.normal
bo22	EpicsSignalWithRBV --- Suffix = bo22 | Kind.normal
bo23	EpicsSignalWithRBV --- Suffix = bo23 | Kind.normal
disable_file_close	EpicsSignal --- Suffix = {global_prefix}DisableFileClose | Kind.omitted
file_averaging_time	EpicsSignal --- Suffix = {global_prefix}FileAvgTime | Kind.config
pv_averaging_time	EpicsSignal --- Suffix = {global_prefix}PvAvgTime | Kind.config
saving_to_file	EpicsSignalRO --- Suffix = {global_prefix}AnalogSaving2File | Kind.omitted

Storage Ring

sophys.common.devices.storage_ring.StorageRing(*, ...)

Useful signals from the Storage Ring.

class sophys.common.devices.storage_ring.StorageRing(*, name, **kwargs)

Useful signals from the Storage Ring.

Attributes

ring_current

EpicsSignalWithRetryRO --- Suffix = SI-GlobAP-CurrInfoCurrent-Mon | Kind.hinted

DCM Lite

sophys.common.devices.dcm_lite.DcmLite([...])	Device for controlling the DCM Lite monochromator.
sophys.common.devices.dcm_lite.Goniometer(...)	Device for controlling one Goniometer of the DCM Lite.
sophys.common.devices.dcm_lite.ShortStroke([...])	Device for controlling all the axis of the Short Stroke of the DCM Lite.

DcmLite

class sophys.common.devices.dcm_lite.DcmLite(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, child_name_separator='_', connection_timeout=<object object>, **kwargs)

Device for controlling the DCM Lite monochromator.

Attributes

energy	DcmEnergy --- Suffix = DCM01Energy | Kind.normal
gonio1	Goniometer --- Suffix = DCM01 | Kind.normal
gonio2	Goniometer --- Suffix = DCM01 | Kind.normal
granite	DcmGranite --- Suffix = PB01 | Kind.normal
scan	DcmScan --- Suffix = DCM01Scan_ | Kind.normal
short_stroke	ShortStroke --- Suffix = DCM01 | Kind.normal

Goniometer

Type: Motor

class sophys.common.devices.dcm_lite.Goniometer(prefix, device_number, **kwargs)

Device for controlling one Goniometer of the DCM Lite.

Attributes

actuate	EpicsSignal --- Suffix = GonRxUpdate_SP | Kind.omitted
done	InternalSignal --- Suffix = None | Kind.normal
high_limit	EpicsSignalRO --- Suffix = {prefix}GonRx{device_number}_PlusLimit_RBV | Kind.omitted
low_limit	EpicsSignalRO --- Suffix = {prefix}GonRx{device_number}_MinusLimit_RBV | Kind.omitted
readback	EpicsSignal --- Suffix = {prefix}GonRx{device_number}_SP_RBV | Kind.hinted
setpoint	EpicsSignalRO --- Suffix = {prefix}GonRx{device_number}_SP | Kind.config
stopped	EpicsSignalRO --- Suffix = {prefix}GonRx{device_number}_DesVelZero_RBV | Kind.omitted

ShortStroke

Type: Motor

class sophys.common.devices.dcm_lite.ShortStroke(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, child_name_separator='_', connection_timeout=<object object>, **kwargs)

Device for controlling all the axis of the Short Stroke of the DCM Lite.

Attributes

gap_uncoupled	UncoupledShortStroke --- Suffix = None | Kind.normal
pitch_uncoupled	UncoupledShortStroke --- Suffix = None | Kind.normal
roll_uncoupled	UncoupledShortStroke --- Suffix = None | Kind.normal

HVPS

High Voltage Power Supply (HVPS)

sophys.common.devices.hvps.HVPS(*args, **kwargs)

A High-Voltage Power Supply (HVPS) device, since the HVPS has no done PV, the implementation uses a PositionerIsClose with a configurable absolute tolerance (default is 2V).

class sophys.common.devices.hvps.HVPS(*args, **kwargs)

A High-Voltage Power Supply (HVPS) device, since the HVPS has no done PV, the implementation uses a PositionerIsClose with a configurable absolute tolerance (default is 2V). The absolute tolerance does not work well for low voltages (e.g. < 50V), but this is not a common use case for HVPS.

Attributes

actuate	EpicsSignalCmd --- Suffix = VoltageSetpoint | Kind.omitted
current_limit	EpicsSignalWithRBSP --- Suffix = CurrentLimit | Kind.config
current_trip	EpicsSignalWithRBSP --- Suffix = CurrentTrip | Kind.config
disable	EpicsSignalCmd --- Suffix = OutputDisable | Kind.config
done	InternalSignal --- Suffix = None | Kind.normal
enable	EpicsSignalCmd --- Suffix = OutputEnable | Kind.config
operation_status	EpicsSignalMon --- Suffix = OperationStatus | Kind.config
readback	EpicsSignalMon --- Suffix = Voltage | Kind.hinted
setpoint	EpicsSignalWithRBSP --- Suffix = VoltageSetpoint | Kind.config

PMT

Photomultiplier

sophys.common.devices.pmt.Photomultiplier([...])

Photomultiplier device developed by the group GIE.

class sophys.common.devices.pmt.Photomultiplier(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, child_name_separator='_', connection_timeout=<object object>, **kwargs)

Photomultiplier device developed by the group GIE.

Attributes

current	EpicsSignalWithGetSet --- Suffix = None | Kind.normal
status	EpicsSignalRO --- Suffix = Status | Kind.normal
stop_pmt	EpicsSignalRO --- Suffix = Stop | Kind.normal
voltage	EpicsSignalWithGetSet --- Suffix = None | Kind.normal
voltage_ramp	EpicsSignalWithGetSet --- Suffix = None | Kind.normal

Simulated devices

We have also implemented a factory function to create some simulated devices, mainly for testing and development usage. It is the instantiate_sim_devices() function, importable from sophys.common.devices.

It is inspired by the ophyd.sim module, but with some trimming down and fixes for our specific requirements.

Example usage:

from sophys.common.devices import instantiate_sim_devices

hw = instantiate_sim_devices()

from bluesky import RunEngine
from bluesky.plans import scan

RE = RunEngine()
RE(scan([hw.det, hw.rand], hw.motor, -2, 2, 25))