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

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_sim_callback

Monitor the value of a signal that is in sim mode

set_sim_put_proceeds

Allow or block a put with wait=True from proceeding

set_sim_value

Set the value of a signal that is in sim 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 NotConnected exceptions

Classes

SignalBackend

A read/write/monitor backend for a Signals

SimSignalBackend

An simulated backend to a Signal, created with Signal.connect(sim=True)

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

Device

Common base class for all Ophyd Async Devices.

DeviceCollector

Collector of top level Device instances to be used as a context manager

DeviceVector

StandardReadable

Device that owns its children and provides useful default behavior.

AsyncStatus

Convert asyncio awaitable to bluesky Status interface

Exceptions

NotConnected

Exception to be raised if a Device.connect is cancelled