pcdsdevices.digitizers.Wave8V2EventBuilder

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

Class for controlling the LCLS-II Wave8 event builder registers.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
cnt_rst	EpicsSignal	:CntRst		config
hard_rst	EpicsSignal	:HardRst		config
soft_rst	EpicsSignal	:SoftRst		config
timer_rst	EpicsSignal	:TimerRst		config
blowoff_ext	EpicsSignalRO	:BlowoffExt		config
blowoff	EpicsSignal	:Blowoff_RBV		config
bypass	EpicsSignal	:Bypass_RBV		config
datacnt0	EpicsSignalRO	:DataCnt0		config
datacnt10	EpicsSignalRO	:DataCnt10		config
nullcnt0	EpicsSignalRO	:NullCnt0		config
nullcnt10	EpicsSignalRO	:NullCnt10		config
timeout_dropcnt0	EpicsSignalRO	:NullCnt0		config
timeout_dropcnt10	EpicsSignalRO	:NullCnt10		config
timeout	EpicsSignal	:Timeout_RBV		config
num_slaves_g	EpicsSignalRO	:NUM_SLAVES_G		config
trans_tdest_g	EpicsSignalRO	:TRANS_TDEST_G		config
state	EpicsSignalRO	:State		config
transaction_cnt	EpicsSignalRO	:TransactionCnt		config

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'})