pcdsdevices.tpr.TprTrigger

class pcdsdevices.tpr.TprTrigger(prefix, *, channel, name, timing_mode=TimingMode.LCLS2, **kwargs)

Class for an individual TprTrigger.

Parameters:

• timing_mode (int, str, or Enum) – The timing mode the TPR is configured for. Can be an enum (tpr.TimingMode.LCLS1 tpr.TimingMode.LCLS1) a str (“LCLS1” or “LCLS2”) or an int (1 or 2).

• channel (int) – The integer channel to be used (0 through 11).

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
ratemode (FCpt)	EpicsSignal	{self.prefix}{self.ch}RATEMODE	Channel rate mode selector	config
group (FCpt)	EpicsSignal	{self.prefix}{self.ch}GROUP	Channel group Bit	config
seqcode (FCpt)	EpicsSignal	{self.prefix}{self.ch}SEQCODE	Channel sequence code	config
fixedrate (FCpt)	EpicsSignal	{self.prefix}{self.ch}FIXEDRATE	Channel Fxed rate selector	config
count (FCpt)	EpicsSignal	{self.prefix}{self.ch}CNT	Channel counter	omitted
destmask (FCpt)	EpicsSignal	{self.prefix}{self.ch}DESTMASK	Channel destination mask	config
destmode (FCpt)	EpicsSignal	{self.prefix}{self.ch}DESTMODE	Channel destination mode selector	config
src (FCpt)	EpicsSignal	{self.prefix}{self.trg}SOURCE	Trigger source	config
eventcode (FCpt)	EpicsSignal	{self.prefix}{self.ch}EVCODE	Channel LCLS1 event code	config
eventrate (FCpt)	EpicsSignalRO	{self.prefix}{self.ch}RATE	Channel event rates	normal
label (FCpt)	EpicsSignal	{self.prefix}{self.ch}{self.sys}TCTL.DESC	Channel description	normal
delay_ticks (FCpt)	EpicsSignal	{self.prefix}{self.trg}TDESTICKS	Trigger delay in clock ticks	omitted
delay_taps (FCpt)	EpicsSignal	{self.prefix}{self.trg}TDESTAPS	Trigger delay in delay taps	omitted
delay_setpoint (FCpt)	EpicsSignal	{self.prefix}{self.trg}{self.sys}TDES	Trigger delay setpoint in nsec	config
ns_delay	MultiDerivedSignal		Get/set trigger delay in ns	normal
ns_delay_scan (FCpt)	TprMotor	{self.prefix}{self.trg}	Motor-like tpr interface	omitted
polarity (FCpt)	EpicsSignal	{self.prefix}{self.trg}TPOL	Trigger description	config
width_setpoint (FCpt)	EpicsSignal	{self.prefix}{self.trg}{self.sys}TWID	Trigger width in ns	config
width_ticks (FCpt)	EpicsSignalRO	{self.prefix}{self.trg}TWIDTICKS	Trigger width in clock ticks	omitted
width	MultiDerivedSignal		Get/set trigger width in nsec	normal
enable_ch_cmd (FCpt)	EpicsSignal	{self.prefix}{self.ch}{self.sys}TCTL	Channel enable/disable	config
enable_trg_cmd (FCpt)	EpicsSignal	{self.prefix}{self.trg}{self.sys}TCTL	Trigger enable/disable	config
operation (FCpt)	EpicsSignal	{self.prefix}{self.trg}TCMPL	Trigger complementary logic	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.

disable()

Disable the channel and trigger.

disable_ch()

Disable the channel.

disable_trg()

Disable the trigger.

enable()

Enable the channel and trigger.

enable_ch()

Enable the channel.

enable_trg()

Enable the trigger.

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