pcdsdevices.lasers.btps.BtpsState

class pcdsdevices.lasers.btps.BtpsState(*args, **kwargs)

Beam Transport Protection System (BTPS) State.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
config	GlobalConfig	LTLHN:BTPS:Config:	Global BTPS configuration	normal
ls1	BtpsSourceStatus	LTLHN:LS1:	Source status for LS1 (Bay 1)	normal
ls3	BtpsSourceStatus	LTLHN:LS3:	Source status for LS3 (Bay 2 1um)	normal
ls4	BtpsSourceStatus	LTLHN:LS4:	Source status for LS3 (Bay 2 800m)	normal
ls5	BtpsSourceStatus	LTLHN:LS5:	Source status for LS5 (Bay 3 800nm)	normal
ls6	BtpsSourceStatus	LTLHN:LS6:	Source status for LS3 (Bay 3 1um)	normal
ls8	BtpsSourceStatus	LTLHN:LS8:	Source status for LS8 (Bay 4)	normal
ld1	DestinationConfig	LTLHN:LD1:	Destination LD1	normal
ld2	DestinationConfig	LTLHN:LD2:	Destination LD2	normal
ld4	DestinationConfig	LTLHN:LD4:	Destination LD4	normal
ld6	DestinationConfig	LTLHN:LD6:	Destination LD6	normal
ld8	DestinationConfig	LTLHN:LD8:	Destination LD8	normal
ld9	DestinationConfig	LTLHN:LD9:	Destination LD9	normal
ld10	DestinationConfig	LTLHN:LD10:	Destination LD10	normal
ld14	DestinationConfig	LTLHN:LD14:	Destination LD14	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.

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.

set_source_to_destination(source: SourcePosition, dest: DestinationPosition) → AndStatus

Move source to the target destination dest and return a combined status object.

set_source_to_destination_with_movestatus(source: SourcePosition, dest: DestinationPosition) → tuple[MoveStatus, MoveStatus, MoveStatus]

Move source to the target destination dest and return statuses for each motion.

status() → str

Returns a str with the current pv values for the device.

stop(*, success=False)

Stop the Device and all (instantiated) subdevices

summary()

to_btms_state() → BtmsState

Determine the state for BTMS, indicating active source/destination pairs.

Returns:

BtmsState

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

sources: dict[SourcePosition, BtpsSourceStatus]

destinations: dict[btms.DestinationPosition, DestinationConfig]