pcdsdevices.sample_delivery.FlowIntegrator

class pcdsdevices.sample_delivery.FlowIntegrator(*, name, **kwargs)

A Flow Integrator for the sample delivery system.

Parameters:

  • name (str) – A name for the device.

  • integrator_source_prefix (str)

  • flow_source_prefix (str)

  • names_prefix (str)

  • flow1_start_prefix (str) – Starting volume of flow 1.

  • flow1_used_prefix (str) – Flow rate of flow 1.

  • flow1_time_prefix (str) – Estimated depletion time of flow 1.

  • flow2_start_prefix (str) – Starting volume of flow 2.

  • flow2_used_prefix (str) – Flow rate of flow 2.

  • flow2_time_prefix (str) – Estimated depletion time of flow 2.

  • flow3_start_prefix (str) – Starting volume of flow 3.

  • flow3_used_prefix (str) – Flow rate of flow 3.

  • flow3_time_prefix (str) – Estimated depletion time of flow 3.

  • flow4_start_prefix (str) – Starting volume of flow 4.

  • flow4_used_prefix (str) – Flow rate of flow 4.

  • flow4_time_prefix (str) – Estimated depletion time of flow 4.

  • flow5_start_prefix (str) – Starting volume of flow 5.

  • flow5_used_prefix (str) – Flow rate of flow 5.

  • flow5_time_prefix (str) – Estimated depletion time of flow 5.

  • flow6_start_prefix (str) – Starting volume of flow 6.

  • flow6_used_prefix (str) – Flow rate of flow 6.

  • flow6_time_prefix (str) – Estimated depletion time of flow 6.

  • flow7_start_prefix (str) – Starting volume of flow 7.

  • flow7_used_prefix (str) – Flow rate of flow 7.

  • flow7_time_prefix (str) – Estimated depletion time of flow 7.

  • flow8_start_prefix (str) – Starting volume of flow 8.

  • flow8_used_prefix (str) – Flow rate of flow 8.

  • flow8_time_prefix (str) – Estimated depletion time of flow 8.

  • flow9_start_prefix (str) – Starting volume of flow 9.

  • flow9_used_prefix (str) – Flow rate of flow 9.

  • flow9_time_prefix (str) – Estimated depletion time of flow 9.

  • flow10_start_prefix (str) – Starting volume of flow 10.

  • flow10_used_prefix (str) – Flow rate of flow 10.

  • flow10_time_prefix (str) – Estimated depletion time of flow 10.

Ophyd Device Components

Attribute

Class

Suffix

Docs

Kind

Notes

integrator_source (UnrelatedComponent)

EpicsSignal

normal

flow_source (UnrelatedComponent)

EpicsSignal

normal

names (UnrelatedComponent)

EpicsSignal

normal

flow1 (UnrelatedComponent)

IntegratedFlow

normal

flow2 (UnrelatedComponent)

IntegratedFlow

normal

flow3 (UnrelatedComponent)

IntegratedFlow

normal

flow4 (UnrelatedComponent)

IntegratedFlow

normal

flow5 (UnrelatedComponent)

IntegratedFlow

normal

flow6 (UnrelatedComponent)

IntegratedFlow

normal

flow7 (UnrelatedComponent)

IntegratedFlow

normal

flow8 (UnrelatedComponent)

IntegratedFlow

normal

flow9 (UnrelatedComponent)

IntegratedFlow

normal

flow10 (UnrelatedComponent)

IntegratedFlow

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.

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