pcdsdevices.transfocate.XPPTFI

class pcdsdevices.transfocate.XPPTFI(*args, **kwargs)

A development screen for the XPP Transfocator Interlock.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
bypass_mode	PytmcSignal	:BYP:SW	Bypass mode switch	normal
test_mode	PytmcSignal	:TST:SW	Test mode switch	normal
error_type	PytmcSignal	:SYS:ERROR:TYPE	System error type indicator	normal
error_msg	PytmcSignal	:SYS:ERROR:MSG	System error message	normal
error_summary	PytmcSignal	:ERROR:SUMMARY	true means theres an error somehwere in the system	normal
master_reset	PytmcSignal	:MASTER:RESET	Master reset command	normal
mono_bb_temp	PytmcSignal	:MONO:BB:EPS:ILOCK:TC_TEMP	Mono beamblock motor temperature	normal
reset_mono_latch	PytmcSignal	:MONO:RST:LATCH	Reset monochromator latch	normal
safe_to_retract_mono_bb	PytmcSignal	:MONO:BB:EPS:SAFE:TO:RETRACT	Safe to retract monochromator beamblock	normal
curr_mode	PytmcSignal	:CURR:MODE	Current mode	normal
mono_bb_state	PytmcSignal	:MONO:BB:State	Monochromator beamblock state	normal
st1l0_state	PytmcSignal	:ST1L0:STATE	state is either IN or Unknown	normal
st1l2_state	PytmcSignal	:ST1L2:STATE	state is either IN or Unknown	normal
protected	PytmcSignal	:PROTECTED	Protected by stopper or beamblock	normal
in_disallowed_region	PytmcSignal	:DISSALL:IN:REGION	Indicator if in disallowed region	normal
disallowed_low	PytmcSignal	:DISSALL:RAD:LOW	Low bound of disallowed region	normal
disallowed_high	PytmcSignal	:DISSALL:RAD:HIGH	High bound of disallowed region	normal
effective_rad_vert	PytmcSignal	:EFF:VERT:RADIUS	Vertical effective radius	normal
effective_rad_horz	PytmcSignal	:EFF:HORZ:RADIUS	Horizontal effective radius	normal
pmps_photon_energy	PytmcSignal	:ENRG:IN:PMPS:PHOTON:ENERGY	Photon energy from PMPS	normal
epics_photon_energy	PytmcSignal	:ENRG:IN:EPICS:PHOTON:ENERGY	Photon energy from EPICS	normal
one_horz_state	PytmcSignal	:1DH:State	1D horizontal lens state	normal
one_vert_state	PytmcSignal	:1DV:State	1D vertical lens state	normal
twod_lens1_state	PytmcSignal	:2D1:State	2D lens 1 state	normal
twod_lens2_state	PytmcSignal	:2D2:State	2D lens 2 state	normal
twod_lens3_state	PytmcSignal	:2D3:State	2D lens 3 state	normal
twod_lens4_state	PytmcSignal	:2D4:State	2D lens 4 state	normal
twod_lens5_state	PytmcSignal	:2D5:State	2D lens 5 state	normal
twod_lens6_state	PytmcSignal	:2D6:State	2D lens 6 state	normal
twod_lens7_state	PytmcSignal	:2D7:State	2D lens 7 state	normal
twod_lens8_state	PytmcSignal	:2D8:State	2D lens 8 state	normal
two_insert_lens1	PytmcSignal	:2D:INSERT:LENS:1:INSERT	Command to insert 2D lens 1	normal
two_insert_lens2	PytmcSignal	:2D:INSERT:LENS:2:INSERT	Command to insert 2D lens 2	normal
two_insert_lens3	PytmcSignal	:2D:INSERT:LENS:3:INSERT	Command to insert 2D lens 3	normal
two_insert_lens4	PytmcSignal	:2D:INSERT:LENS:4:INSERT	Command to insert 2D lens 4	normal
two_insert_lens5	PytmcSignal	:2D:INSERT:LENS:5:INSERT	Command to insert 2D lens 5	normal
two_insert_lens6	PytmcSignal	:2D:INSERT:LENS:6:INSERT	Command to insert 2D lens 6	normal
two_insert_lens7	PytmcSignal	:2D:INSERT:LENS:7:INSERT	Command to insert 2D lens 7	normal
two_insert_lens8	PytmcSignal	:2D:INSERT:LENS:8:INSERT	Command to insert 2D lens 8	normal
two_remove_lens1	PytmcSignal	:2D:REMOVE:LENS:1:REMOVE	Command to remove 2D lens 1	normal
two_remove_lens2	PytmcSignal	:2D:REMOVE:LENS:2:REMOVE	Command to remove 2D lens 2	normal
two_remove_lens3	PytmcSignal	:2D:REMOVE:LENS:3:REMOVE	Command to remove 2D lens 3	normal
two_remove_lens4	PytmcSignal	:2D:REMOVE:LENS:4:REMOVE	Command to remove 2D lens 4	normal
two_remove_lens5	PytmcSignal	:2D:REMOVE:LENS:5:REMOVE	Command to remove 2D lens 5	normal
two_remove_lens6	PytmcSignal	:2D:REMOVE:LENS:6:REMOVE	Command to remove 2D lens 6	normal
two_remove_lens7	PytmcSignal	:2D:REMOVE:LENS:7:REMOVE	Command to remove 2D lens 7	normal
two_remove_lens8	PytmcSignal	:2D:REMOVE:LENS:8:REMOVE	Command to remove 2D lens 8	normal
one_horz_lens1	PytmcSignal	:1D:HORZ:MOVE:LENS:1:INSERT	Command to insert 1D horizontal lens 1	normal
one_horz_lens2	PytmcSignal	:1D:HORZ:MOVE:LENS:2:INSERT	Command to insert 1D horizontal lens 2	normal
one_horz_lens3	PytmcSignal	:1D:HORZ:MOVE:LENS:3:INSERT	Command to insert 1D horizontal lens 3	normal
one_horz_lens4	PytmcSignal	:1D:HORZ:MOVE:LENS:4:INSERT	Command to insert 1D horizontal lens 4	normal
one_horz_out	PytmcSignal	:1D:HORZ:MOVE:OUT	Command to move 1D horizontal lens out	normal
one_vert_lens1	PytmcSignal	:1D:VERT:MOVE:LENS:1:INSERT	Command to insert 1D vertical lens 1	normal
one_vert_lens2	PytmcSignal	:1D:VERT:MOVE:LENS:2:INSERT	Command to insert 1D vertical lens 2	normal
one_vert_lens3	PytmcSignal	:1D:VERT:MOVE:LENS:3:INSERT	Command to insert 1D vertical lens 3	normal
one_vert_lens4	PytmcSignal	:1D:VERT:MOVE:LENS:4:INSERT	Command to insert 1D vertical lens 4	normal
one_vert_out	PytmcSignal	:1D:VERT:MOVE:OUT	Command to move 1D vertical lens out	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.

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