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
Sort all the values into a single phase so they are set all at once |
|
Get signal values in bulk. |
|
Plan which loads PVs from a yaml file into a device. |
|
Plan that returns a list of dicts with saved signal values from a yaml file. |
|
Plan that saves the state of all PV's on a device using a sorter. |
|
Plan which serialises a phase or set of phases of SignalRWs to a yaml file. |
|
Maps signals from a yaml file into device signals. |
|
Retrieve all SignalRWs from a device. |
|
Set a new handler on the |
|
For setting a callback when a backend is put to. |
|
Get the mock associated with the put call on the signal. |
|
Allow or block a put with wait=True from proceeding |
|
Set the value of a signal that is in mock mode. |
|
Iterator to set a signal to a sequence of values, optionally repeating the sequence. |
|
Assert readings from Configurable. |
|
Assert emitted document generated by running a Bluesky plan |
|
Assert readings from readable. |
|
Assert a signal's value and compare it an expected signal. |
|
Subscribe to the value of a signal so it can be iterated from. |
|
Set a signal and monitor it until it has that value. |
|
Set a signal and monitor another signal until it has the specified value. |
|
Returns a tuple of a read-only Signal and a callable through which the signal can be internally modified within the device. |
|
Creates a read-writable Signal with a SoftSignalBackend. |
|
Wait for a signal to have a matching value. |
|
Get the runtime dtype from a numpy ndarray type annotation |
|
If all values are the same, return that value, otherwise return TypeError |
|
Converts between a positive number of seconds and an equivalent number of microseconds. |
|
Call many underlying signals, accumulating exceptions and returning them |
|
Classes
Classes implementing this interface should hold the logic for arming and disarming a detector |
|
Type of mechanism for triggering a detector to take frames |
|
Logic for making a detector write data to somewhere persistent (e.g. an HDF5 file). |
|
Useful detector base class for step and fly scanning detectors. |
|
Common base class for all Ophyd Async Devices. |
|
Collector of top level Device instances to be used as a context manager |
|
Defines device components with indices. |
|
|
|
Information about where and how to write a file. |
|
Device that owns its children and provides useful default behavior. |
|
A Device with the concept of a value, with R, RW, W and X flavours |
|
Signal that can be read from and monitored |
|
Signal that can be both read and set |
|
Signal that can be set |
|
Signal that puts the default value |
|
A read/write/monitor backend for a Signals |
|
alias of |
|
An backend to a soft Signal, for test signals see |
|
Convert AsyncIterator of WatcherUpdates to bluesky Status interface. |
|
Sentinel class used to implement |
|
A dataclass such that, when expanded, it provides the kwargs for a watcher |
Exceptions
Exception to be raised if a |