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

get_signal_values

Read the values of SignalRW's, to be used alongside walk_rw_signals.

load_from_yaml

Returns a list of dicts with saved signal values from a yaml file

save_to_yaml

Serialises and saves a phase or a set of phases of a device's SignalRW's to a yaml file.

set_signal_values

Loads a phase or a set of phases from a yaml file and puts value to an Ophyd device

walk_rw_signals

Get all the SignalRWs from a device and store them with their dotted attribute paths in a dictionary.

Classes

SignalBackend

A read/write/monitor backend for a Signals

SimSignalBackend

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

DetectorControl

DetectorTrigger

An enumeration.

DetectorWriter

StandardDetector

Detector with useful default behaviour.

Device

Common base class for all Ophyd Async Devices.

DeviceCollector

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

DeviceVector

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

Convert asyncio awaitable to bluesky Status interface

DirectoryInfo

DirectoryProvider

NameProvider

ShapeProvider

StaticDirectoryProvider

StandardReadable

Device that owns its children and provides useful default behavior.

TriggerInfo

DetectorGroupLogic

SameTriggerDetectorGroupLogic

TriggerLogic

HardwareTriggeredFlyable

Exceptions

NotConnected

Exception to be raised if a Device.connect is cancelled