pcdsdevices.qadc.Qadc134Lcls2

class pcdsdevices.qadc.Qadc134Lcls2(*args, **kwargs)

Class for LCLS-2 FMC134 digitizers. Implements LCLS-2 timing interface.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
trig_rate_mode	EpicsSignal	:TRIG_RATEMODE	LCLS-II trigger mode	config	Inherited from QadcLcls2Timing
trig_fixed_rate	EpicsSignal	:TRIG_FIXEDRATE	Rate to use for fixed trigger mode	config	Inherited from QadcLcls2Timing
trig_ac_rate	EpicsSignal	:TRIG_ACRATE	Rate to use for AC trigger mode	config	Inherited from QadcLcls2Timing
trig_ts_mask	EpicsSignal	:TRIG_TSMASK	Trigger mask	config	Inherited from QadcLcls2Timing
trig_seq_num	EpicsSignal	:TRIG_SEQNUM	Trigger sequence number	config	Inherited from QadcLcls2Timing
trig_seq_bit	EpicsSignal	:TRIG_SEQBIT	Trigger sequence bit	config	Inherited from QadcLcls2Timing
trig_partition	EpicsSignal	:TRIG_PARTITION	Trigger partition number	config	Inherited from QadcLcls2Timing
ch0	EpicsSignal	:CH0	Input 0 of the ADC	normal	Inherited from Qadc134Common
ch1	EpicsSignal	:CH1	Input 1 of the ADC	normal	Inherited from Qadc134Common
ch2	EpicsSignal	:CH2	Input 2 of the ADC	normal	Inherited from Qadc134Common
ch3	EpicsSignal	:CH3	Input 3 of the ADC	normal	Inherited from Qadc134Common
config	EpicsSignal	:CONFIG	Write the current config to the QADC	config	Inherited from Qadc134Common
start	EpicsSignal	:START	Start/stop acquisition	normal	Inherited from Qadc134Common
trig_delay	EpicsSignal	:TRIG_DELAY_RBV	Trigger delay in EVR/TPR ticks	config	Inherited from Qadc134Common
full_en	EpicsSignal	:FULL_EN_RBV	Enable full stream	config	Inherited from Qadc134Common
hi_thresh	EpicsSignal	:HI_THRESH_RBV	High threshold, in Volts	config	Inherited from Qadc134Common
hi_thresh_raw	EpicsSignal	:HI_THRESH_RAW_RBV	High threshold, raw	config	Inherited from Qadc134Common
ichan	EpicsSignal	:ICHAN_RBV	Channel to interleave on	config	Inherited from Qadc134Common
interleave	EpicsSignal	:INTERLEAVE_RBV	Interleave enabled?	config	Inherited from Qadc134Common
length	EpicsSignal	:LENGTH_RBV	Waveform length	config	Inherited from Qadc134Common
lo_thresh	EpicsSignal	:LO_THRESH_RBV	Low threshold, in Volts	config	Inherited from Qadc134Common
lo_thresh_raw	EpicsSignal	:LO_THRESH_RAW_RBV	Low threshold, raw	config	Inherited from Qadc134Common
prescale	EpicsSignal	:PRESCALE_RBV	Trigger prescale divider	config	Inherited from Qadc134Common
rows_after	EpicsSignal	:ROWS_AFTER_RBV		config	Inherited from Qadc134Common
rows_before	EpicsSignal	:ROWS_BEFORE_RBV		config	Inherited from Qadc134Common
sparse_en	EpicsSignal	:SPARSE_EN_RBV	Enable sparsified mode	config	Inherited from Qadc134Common
clear_config	EpicsSignal	:CLEAR_CONFIG	Clear the current configuration	config	Inherited from Qadc134Common
out0	EpicsSignal	:OUT0	Full output zero	normal	Inherited from Qadc134Common
out1	EpicsSignal	:OUT1	Full output one	normal	Inherited from Qadc134Common
rawdata0	EpicsSignal	:RAWDATA0	Raw output zero	normal	Inherited from Qadc134Common
rawdata1	EpicsSignal	:RAWDATA1	Raw output one	normal	Inherited from Qadc134Common
sparse0	EpicsSignal	:SPARSE0	Sparsified output zero	normal	Inherited from Qadc134Common
sparse1	EpicsSignal	:SPARSE1	Sparsified output one	normal	Inherited from Qadc134Common

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.

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

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