pcdsdevices.gauge.GaugeSerialGCC

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

Class for Cold Cathode Gauges controlled via serial.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
gastype	EpicsSignal	:GASTYPE		omitted	Inherited from GaugeSerial
gastypedes	EpicsSignal	:GASTYPEDES		omitted	Inherited from GaugeSerial
hystsprbck_1	EpicsSignalRO	:HYSTSPRBCK_1_RBV		omitted	Inherited from GaugeSerial
hystsprbck_2	EpicsSignalRO	:HYSTSPRBCK_2_RBV		omitted	Inherited from GaugeSerial
p	EpicsSignal	:P		omitted	Inherited from GaugeSerial
padel	EpicsSignal	:PADEL		omitted	Inherited from GaugeSerial
plog	EpicsSignal	:PLOG		omitted	Inherited from GaugeSerial
pmon	EpicsSignal	:PMON		omitted	Inherited from GaugeSerial
pmonraw	EpicsSignal	:PMONRAW		omitted	Inherited from GaugeSerial
pstat_1	EpicsSignal	:PSTAT_1		omitted	Inherited from GaugeSerial
pstat_2	EpicsSignal	:PSTAT_2		omitted	Inherited from GaugeSerial
pstat_calc	EpicsSignal	:PSTAT_CALC		omitted	Inherited from GaugeSerial
pstat_sum	EpicsSignal	:PSTAT_SUM		omitted	Inherited from GaugeSerial
pstatdirdes_1	EpicsSignal	:PSTATDIRDES_1		omitted	Inherited from GaugeSerial
pstatdirdes_2	EpicsSignal	:PSTATDIRDES_2		omitted	Inherited from GaugeSerial
pstatenable_1	EpicsSignal	:PSTATENABLE_1		omitted	Inherited from GaugeSerial
pstatenable_2	EpicsSignal	:PSTATENABLE_2		omitted	Inherited from GaugeSerial
pstatenades_1	EpicsSignal	:PSTATENADES_1		omitted	Inherited from GaugeSerial
pstatenades_2	EpicsSignal	:PSTATENADES_2		omitted	Inherited from GaugeSerial
pstatspdes_1	EpicsSignal	:PSTATSPDES_1		omitted	Inherited from GaugeSerial
pstatspdes_2	EpicsSignal	:PSTATSPDES_2		omitted	Inherited from GaugeSerial
pstatspdir_1	EpicsSignal	:PSTATSPDIR_1		omitted	Inherited from GaugeSerial
pstatspdir_2	EpicsSignal	:PSTATSPDIR_2		omitted	Inherited from GaugeSerial
pstatsprbck_1	EpicsSignalRO	:PSTATSPRBCK_1_RBV		omitted	Inherited from GaugeSerial
pstatsprbck_2	EpicsSignalRO	:PSTATSPRBCK_2_RBV		omitted	Inherited from GaugeSerial
state	EpicsSignal	:STATE		omitted	Inherited from GaugeSerial
statedes	EpicsSignal	:STATEDES		omitted	Inherited from GaugeSerial
staterbck	EpicsSignalRO	:STATERBCK_RBV		omitted	Inherited from GaugeSerial
status_rs	EpicsSignal	:STATUS_RS		omitted	Inherited from GaugeSerial
status_rs_calc1	EpicsSignal	:STATUS_RS_CALC1		omitted	Inherited from GaugeSerial
status_rs_calc2	EpicsSignal	:STATUS_RS_CALC2		omitted	Inherited from GaugeSerial
status_rscalc	EpicsSignal	:STATUS_RSCALC		omitted	Inherited from GaugeSerial
status_rscalc2	EpicsSignal	:STATUS_RSCALC2		omitted	Inherited from GaugeSerial
status_rsmon	EpicsSignal	:STATUS_RSMON		omitted	Inherited from GaugeSerial
status_rsout	EpicsSignal	:STATUS_RSOUT		omitted	Inherited from GaugeSerial
pctrl_ch_des	EpicsSignal	:PCTRL_CH_DES		omitted
pctrl_ch_rbck	EpicsSignalRO	:PCTRL_CH_RBCK_RBV		omitted
pctrldes	EpicsSignal	:PCTRLDES		omitted
pctrlen	EpicsSignal	:PCTRLEN		omitted
pctrlencalc	EpicsSignal	:PCTRLENCALC		omitted
pctrlenrbck	EpicsSignalRO	:PCTRLENRBCK_RBV		omitted
pctrlrbck	EpicsSignalRO	:PCTRLRBCK_RBV		omitted
pctrlspdes	EpicsSignal	:PCTRLSPDES		omitted
pctrlsprbck	EpicsSignalRO	:PCTRLSPRBCK_RBV		omitted
pprotencalc	EpicsSignal	:PPROTENCALC		omitted
pprotenrbck	EpicsSignalRO	:PPROTENRBCK_RBV		omitted
pprotspdes	EpicsSignal	:PPROTSPDES		omitted
pprotsprbck	EpicsSignalRO	:PPROTSPRBCK_RBV		omitted
pstat_3	EpicsSignal	:PSTAT_3		omitted
pstat_4	EpicsSignal	:PSTAT_4		omitted
pstatdirdes_3	EpicsSignal	:PSTATDIRDES_3		omitted
pstatdirdes_4	EpicsSignal	:PSTATDIRDES_4		omitted
pstatenable_3	EpicsSignal	:PSTATENABLE_3		omitted
pstatenable_4	EpicsSignal	:PSTATENABLE_4		omitted
pstatenades_3	EpicsSignal	:PSTATENADES_3		omitted
pstatenades_4	EpicsSignal	:PSTATENADES_4		omitted
pstatspdes_3	EpicsSignal	:PSTATSPDES_3		omitted
pstatspdes_4	EpicsSignal	:PSTATSPDES_4		omitted
pstatspdes_fs	EpicsSignal	:PSTATSPDES_FS		omitted
pstatspdir_3	EpicsSignal	:PSTATSPDIR_3		omitted
pstatspdir_4	EpicsSignal	:PSTATSPDIR_4		omitted
pstatsprbck_3	EpicsSignal	:PSTATSPRBCK_3		omitted
pstatsprbck_4	EpicsSignal	:PSTATSPRBCK_4		omitted
pstatsprbck_fs	EpicsSignal	:PSTATSPRBCK_FS		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'})