id3c.plans.ad_plugins

Support for area detector file plugins (HDF5, TIFF, …).

read_ad_plugin_components(plugin)	Print a table of plugin components (access, name, current value).
set_ad_plugin_components(plugin, /, **kwargs)	Set plugin components by keyword.

The set of components visible to either helper is determined by each component’s kind (hinted, normal, or config). To expose or hide a component, adjust its kind attribute (for example eiger2.hdf1.num_capture.kind = "config").

The set helper is intended for plugin configuration before acquisition – an alternative to ophyd’s staging process. Actionable signals (capture, acquire, …) are normally driven by staging and should not be set through this helper. Order of the bps.mv calls inside the set helper is undefined; if ordering matters, make separate calls.

Attributes

REPORTABLE_KINDS

Functions

read_ad_plugin_components(plugin)	Print a table of plugin components (access, name, current value).
set_ad_plugin_components(plugin, /, **kwargs)	Set plugin components by keyword.

Module Contents

id3c.plans.ad_plugins.REPORTABLE_KINDS

id3c.plans.ad_plugins.read_ad_plugin_components(plugin)

Print a table of plugin components (access, name, current value).

Diagnostic only. Use this interactively to discover which keys can be passed to set_ad_plugin_components(). Components whose .read() returns no value field are skipped.

id3c.plans.ad_plugins.set_ad_plugin_components(plugin, /, **kwargs)

Set plugin components by keyword.

Each keyword names a component on plugin; the value is the new setpoint. All writes are issued through a single bps.mv(...) and complete in parallel; order is undefined.

Raises:

• TypeError – any kwarg names a component that is not writable.

• KeyError – any kwarg names a component the helper does not see (unknown name, or its kind is omitted).