pcdsdevices.digitizers.Wave8V2

class pcdsdevices.digitizers.Wave8V2(*args, **kwargs)

Complete top-level class for the LCLS-II Wave8. Put _all_ the things in.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
run_start	EpicsSignal	:SeqStartRun.PROC		normal	Inherited from Wave8V2Simple
run_stop	EpicsSignal	:SeqStopRun.PROC		normal	Inherited from Wave8V2Simple
ch0	EpicsSignalRO	:CH0:ArrayData		normal	Inherited from Wave8V2Simple
ch1	EpicsSignalRO	:CH1:ArrayData		normal	Inherited from Wave8V2Simple
ch2	EpicsSignalRO	:CH2:ArrayData		normal	Inherited from Wave8V2Simple
ch3	EpicsSignalRO	:CH3:ArrayData		normal	Inherited from Wave8V2Simple
ch4	EpicsSignalRO	:CH4:ArrayData		normal	Inherited from Wave8V2Simple
ch5	EpicsSignalRO	:CH5:ArrayData		normal	Inherited from Wave8V2Simple
ch6	EpicsSignalRO	:CH6:ArrayData		normal	Inherited from Wave8V2Simple
ch7	EpicsSignalRO	:CH7:ArrayData		normal	Inherited from Wave8V2Simple
sys_regs	Wave8V2SystemRegs	:SystemRegs		normal
raw_buffers	Wave8V2RawBuffers	:RawBuffers		normal
sfp0	Wave8V2Sfp	:Sfp0		normal
sfp1	Wave8V2Sfp	:Sfp1		normal
sfp2	Wave8V2Sfp	:Sfp2		normal
sfp3	Wave8V2Sfp	:Sfp3		normal
adc_config0	Wave8V2ADCRegs	:AdcConfig0		normal
adc_config1	Wave8V2ADCRegs	:AdcConfig1		normal
adc_config2	Wave8V2ADCRegs	:AdcConfig2		normal
adc_config3	Wave8V2ADCRegs	:AdcConfig3		normal
adc_sample_readout0	Wave8V2ADCSampleReadout	:AdcReadout0		normal
adc_sample_readout1	Wave8V2ADCSampleReadout	:AdcReadout1		normal
adc_sample_readout2	Wave8V2ADCSampleReadout	:AdcReadout2		normal
adc_sample_readout3	Wave8V2ADCSampleReadout	:AdcReadout3		normal
axi_version	Wave8V2AxiVersion	:AxiVersion		normal
event_builder	Wave8V2EventBuilder	:EventBuilder		normal
evr_v2	Wave8V2EvrV2	:EvrV2		normal
integrators	Wave8V2Integrators	:Integrators		normal
pgp_mon0	Wave8V2PgpMon	:PgpMon0		normal
pgp_mon1	Wave8V2PgpMon	:PgpMon1		normal
timing	Wave8V2Timing	:Timing		normal
trigger_event_manager	Wave8V2TriggerEventManager	:TrEvent		normal
xpm_mini	Wave8V2XpmMini	:XpmMini		normal
xpm_msg	Wave8V2XpmMsg	:TrEvent		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.

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

hints

kind

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