pcdsdevices.valve.VCN_VAT590

class pcdsdevices.valve.VCN_VAT590(*args, **kwargs)

VCN_VAT590 = Variable Controlled Needle Valve using the VAT590

VAT590 = series 590 valve from the company, VAT VAT = company that manufactures vacuum valves, among other things

This has different PVs than the normal VCN class.

This corresponds to the ST_VCN_VAT590 and ST_VAT590_STATUS data types in the lcls-twincat-vacuum library.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
pos_raw	PytmcSignal	POS_RAW	Position readback	hinted
pres_torr	PytmcSignal	PRES_TORR	Pressure readback in torr units	hinted
pres_raw	PytmcSignal	PRES_RAW	Pressure readback	normal
pos_sp	PytmcSignal	POS_SP	Position setpoint readback	normal
pres_sp	PytmcSignal	PRES_SP	Pressure setpoint readback	normal
ilk_ok	PytmcSignal	ILK_OK	Interlock bit status	normal
pos_req	PytmcSignal	POS_REQ	Requested position (0.0-100%)	config
pres_req	PytmcSignal	PRES_REQ	Requested pressure in torr units	config
state	PytmcSignal	STATE	Valve control mode	config
pos_limit	PytmcSignal	POS_LIMIT	Percentage upper limit on valve open	config
pres_set_limit	PytmcSignal	PRES_SET_LIMIT	Upper limit for pressure control	config
pres_rdbk_limit	PytmcSignal	PRES_RDBK_LIMIT	Upper limit for pressure reading before valve close	config
pres_sens	PytmcSignal	PRES_SENS	Select pressure sensor	config
rem_ctrl	PytmcSignal	REM_CTRL	Select remote control mode	config
zero	PytmcSignal	ZERO	Activate zero function bit	config
status	VCN_VAT590_Status			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.

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

hints

kind

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