pcdsdevices.attenuator.SXRGasAtt

class pcdsdevices.attenuator.SXRGasAtt(*args, **kwargs)

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
transmission	EpicsSignal	:TRANS_RBV	Transmission	hinted
arb_req	EpicsSignalRO	:TRANS_REQ_RBV	Requested transmission	hinted
pressure	EpicsSignal	:GCM:82:PRESS_RBV	Pressure	hinted
pressure_setpoint_rbv	EpicsSignalRO	:CNTRL:SP_RBV	Pressure setpoint	omitted
mode	EpicsSignal	:MODE_RBV	PMPS mode	hinted
control_enable	EpicsSignal	:CNTRL:ON_RBV		hinted
pressure_control_enable	EpicsSignal	:MODE:PressureControl_RBV	Pressure control mode	hinted
gas_type	EpicsSignalRO	:GAS_TYPE_RBV	Selected gas	hinted
at_target	EpicsSignalRO	:AtTarget_RBV	At target	hinted
moving	EpicsSignalRO	:Moving_RBV	Moving	hinted
gas_att_ok	EpicsSignalRO	:OK_RBV	Ok	hinted
transmission_setpoint_rbv	EpicsSignalRO	:TRANS_SP_RBV	Transmission setpoint	omitted
pressure_control_valve	EpicsSignalRO	:VCN:70:POS_REQ_RBV	Requested position	omitted
valve_n2	VVC	:VVC:72	Valve n2	hinted
valve_ar	VVC	:VVC:71	Valve ar	hinted
valve_pressure_control	VCN	:VCN:70	Pressure control valve	omitted

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.

setup_mode(mode, control_type='transmission', gas_type=None)

Setup gas attenuator to work in “PMPS” or “Local” mode, with either “transmission control” or “pressure control”

Parameters:

• mode (str, either "PMPS" or "Local")

• attenuator. (Mode for)

• control_type (str, optional) – Set control type in “Local” mode, either “transmission” or “pressure” control. The default is ‘transmission’.

• gas_type (str, optional) – Change gas type to “N2” or “Ar”. The default is None.If None is passed the attenuator uses the current gas.

stage_group_instances() → Iterator[OphydObject]

Yields an iterator of subdevices that should be staged.

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

needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

stage_group: list[Component] = None

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