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

`get_mock_put`	Get the mock associated with the put call on the signal.
`callback_on_mock_put`	For setting a callback when a backend is put to.
`mock_puts_blocked`
`set_mock_values`	Iterator to set a signal to a sequence of values, optionally repeating the sequence.
`reset_mock_put_calls`
`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.
`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.
`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.
`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
`merge_gathered_dicts`	Merge dictionaries produced by a sequence of coroutines.
`wait_for_connection`	Call many underlying signals, accumulating exceptions and returning them
`get_signal_values`	Get signal values in bulk.
`load_from_yaml`	Plan that returns a list of dicts with saved signal values from a yaml file.
`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.
`load_device`	Plan which loads PVs from a yaml file into a device.
`save_device`	Plan that saves the state of all PV's on a device using a sorter.
`assert_reading`	Assert readings from readable.
`assert_value`	Assert a signal's value and compare it an expected signal.
`assert_configuration`	Assert readings from Configurable.
`assert_emitted`	Assert emitted document generated by running a Bluesky plan

Classes

`SignalBackend`	A read/write/monitor backend for a Signals
`SoftSignalBackend`	An backend to a soft Signal, for test signals see `MockSignalBackend`.
`DetectorControl`	Classes implementing this interface should hold the logic for arming and disarming a detector
`MockSignalBackend`
`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.
`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
`SignalW`	Signal that can be set
`SignalRW`	Signal that can be both read and set
`SignalX`	Signal that puts the default value
`AsyncStatus`
`WatchableAsyncStatus`	Convert AsyncIterator of WatcherUpdates to bluesky Status interface.
`DirectoryInfo`	Information about where and how to write a file.
`DirectoryProvider`
`NameProvider`
`ShapeProvider`
`StaticDirectoryProvider`
`StandardReadable`	Device that owns its children and provides useful default behavior.
`ConfigSignal`
`HintedSignal`
`TriggerInfo`	Minimal set of information required to setup triggering on a detector
`TriggerLogic`
`HardwareTriggeredFlyable`
`CalculateTimeout`	Sentinel class used to implement `myfunc(timeout=CalculateTimeout)`

Exceptions

NotConnected

Exception to be raised if a Device.connect is cancelled