Note

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

ophyd.v2.core#

Core Ophyd.v2 functionality like Device and Signal

Module attributes

ReadingValueCallback

A function that will be called with the Reading and value when the monitor updates

Functions

connect_children

Call child.connect(sim) on all child devices in parallel.

get_device_children

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.

monitor_sim_value

Monitor the value of a signal that is in sim mode

name_children

Call child.set_name(child_name) on all child devices in series.

observe_value

Subscribe to the value of a signal so it can be iterated from.

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_connection

Call many underlying signals, accumulating NotConnected exceptions

wait_for_value

Wait for a signal to have a matching value.

Classes

AsyncReadable

Readable narrowed to only be async

AsyncStatus

Convert asyncio awaitable to bluesky Status interface

Device

Common base class for all Ophyd.v2 Devices.

DeviceCollector

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

DeviceVector

Monitor

The kind of handle we expect camonitor/pvmonitor to return

Signal

A Device with the concept of a value, with R, RW, W and X flavours

SignalBackend

A read/write/monitor backend for a Signals

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

SimMonitor

Handle that is returned when monitoring a Signal in sim mode

SimSignalBackend

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

StandardReadable

Device that owns its children and provides useful default behavior.

Exceptions

NotConnected

Exception to be raised if a Device.connect is cancelled