Note

Ophyd async is included on a provisional basis until the v1.0 release and may change API on minor release numbers before then

ophyd_async.core#

Functions

`all_at_once`	Sort all the values into a single phase so they are set all at once
`get_signal_values`	Get signal values in bulk.
`load_device`	Plan which loads PVs from a yaml file into a device.
`load_from_yaml`	Plan that returns a list of dicts with saved signal values from a yaml file.
`save_device`	Plan that saves the state of all PV's on a device using a sorter.
`save_to_yaml`	Plan which serialises a phase or set of phases of SignalRWs to a yaml file.
`set_signal_values`	Maps signals from a yaml file into device signals.
`walk_rw_signals`	Retrieve all SignalRWs from a device.
`config_ophyd_async_logging`	Set a new handler on the `logging.getLogger('ophyd_async')` logger.
`callback_on_mock_put`	For setting a callback when a backend is put to.
`get_mock_put`	Get the mock associated with the put call on the signal.
`mock_puts_blocked`
`reset_mock_put_calls`
`set_mock_put_proceeds`	Allow or block a put with wait=True from proceeding
`set_mock_value`	Set the value of a signal that is in mock mode.
`set_mock_values`	Iterator to set a signal to a sequence of values, optionally repeating the sequence.
`assert_configuration`	Assert readings from Configurable.
`assert_emitted`	Assert emitted document generated by running a Bluesky plan
`assert_reading`	Assert readings from readable.
`assert_value`	Assert a signal's value and compare it an expected signal.
`observe_value`	Subscribe to the value of a signal so it can be iterated from.
`set_and_wait_for_value`	Set a signal and monitor it until it has that value.
`soft_signal_r_and_setter`	Returns a tuple of a read-only Signal and a callable through which the signal can be internally modified within the device.
`soft_signal_rw`	Creates a read-writable Signal with a SoftSignalBackend.
`wait_for_value`	Wait for a signal to have a matching value.
`get_dtype`	Get the runtime dtype from a numpy ndarray type annotation
`get_unique`	If all values are the same, return that value, otherwise return TypeError
`in_micros`	Converts between a positive number of seconds and an equivalent number of microseconds.
`wait_for_connection`	Call many underlying signals, accumulating exceptions and returning them

Classes

`DetectorControl`	Classes implementing this interface should hold the logic for arming and disarming a detector
`DetectorTrigger`	Type of mechanism for triggering a detector to take frames
`DetectorWriter`	Logic for making a detector write data to somewhere persistent (e.g. an HDF5 file).
`StandardDetector`	Useful detector base class for step and fly scanning detectors.
`Device`	Common base class for all Ophyd Async Devices.
`DeviceCollector`	Collector of top level Device instances to be used as a context manager
`DeviceVector`	Defines device components with indices.
`StandardFlyer`
`TriggerLogic`
`HDFDataset`
`HDFFile`	param full_file_name: Absolute path to the file to be written
`MockSignalBackend`
`AsyncConfigurable`
`AsyncReadable`
`AsyncStageable`
`AutoIncrementFilenameProvider`
`AutoIncrementingPathProvider`
`FilenameProvider`
`NameProvider`
`PathInfo`	Information about where and how to write a file.
`PathProvider`
`ShapeProvider`
`StaticFilenameProvider`
`StaticPathProvider`
`UUIDFilenameProvider`
`YMDPathProvider`
`ConfigSignal`
`HintedSignal`
`StandardReadable`	Device that owns its children and provides useful default behavior.
`Signal`	A Device with the concept of a value, with R, RW, W and X flavours
`SignalR`	Signal that can be read from and monitored
`SignalRW`	Signal that can be both read and set
`SignalW`	Signal that can be set
`SignalX`	Signal that puts the default value
`RuntimeSubsetEnum`
`SignalBackend`	A read/write/monitor backend for a Signals
`SubsetEnum`	alias of `RuntimeSubsetEnum`
`SignalMetadata`
`SoftSignalBackend`	An backend to a soft Signal, for test signals see `MockSignalBackend`.
`AsyncStatus`
`WatchableAsyncStatus`	Convert AsyncIterator of WatcherUpdates to bluesky Status interface.
`CalculateTimeout`	Sentinel class used to implement `myfunc(timeout=CalculateTimeout)`
`WatcherUpdate`	A dataclass such that, when expanded, it provides the kwargs for a watcher

Exceptions

NotConnected

Exception to be raised if a Device.connect is cancelled