pcdsdevices.valve.VCN_VAT590_Status

class pcdsdevices.valve.VCN_VAT590_Status(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)

See VCN_VAT590

Corresponds to just ST_VAT590_STATUS in the lcls-twincat-vacuum library.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
ctrl_mode	PytmcSignal	CTRL_MODE	Valve control mode readback	normal
fatal_err	PytmcSignal	FATAL_ERR	Valve fatal error status readback	normal
ecat_data_valid	PytmcSignal	GEN_STATUS:ECAT_DATA_VALID		omitted
zero_executed	PytmcSignal	GEN_STATUS:ZERO_EXECUTED		omitted
ecat_rxbit	PytmcSignal	GEN_STATUS:ECAT_RxBIT		omitted
pres_sim	PytmcSignal	GEN_STATUS:PRES_SIM		omitted
pres_sp_reached	PytmcSignal	GEN_STATUS:PRES_SP_REACHED		omitted
warn_status	PytmcSignal	GEN_STATUS:WARN_STATUS		omitted
rem_ctrl	PytmcSignal	GEN_STATUS:REM_CTRL		omitted
service_req	PytmcSignal	GEN_WARN:SERVICE_REQ		omitted
power_fail_bait	PytmcSignal	GEN_WARN:POWER_FAIL_BATT		omitted
adc_unit_status	PytmcSignal	GEN_WARN:ADC_UNIT_STATUS		omitted
rem_not_possible	PytmcSignal	EXT_WARN:REM_NOT_POSSIBLE		omitted
ctrl_sp_not_allowed	PytmcSignal	EXT_WARN:CTRL_SP_NOT_ALLOWED		omitted
zero_status	PytmcSignal	EXT_WARN:ZERO_STATUS		omitted
pfo_status	PytmcSignal	EXT_WARN:PFO_STATUS		omitted
pres_sp_oor	PytmcSignal	EXT_WARN:PRES_SP_OOR		omitted
pos_sp_oor	PytmcSignal	EXT_WARN:POS_SP_OOR		omitted
ctrl_sp_oor	PytmcSignal	EXT_WARN:CTRL_SP_OOR		omitted
genctrl_sp_oor	PytmcSignal	EXT_WARN:GENCTRL_SP_OOR		omitted
proc_data_not_valid	PytmcSignal	EXT_WARN:PROC_DATA_NOT_VALID		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.

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.

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