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.StandardReadable

class ophyd_async.core.StandardReadable(name: str = '')

Bases: Device, Readable, Configurable, Stageable

Device that owns its children and provides useful default behavior.

• When its name is set it renames child Devices

• Signals can be registered for read() and read_configuration()

• These signals will be subscribed for read() between stage() and unstage()

Methods

children
connect	Connect self and all child Devices.
describe
describe_configuration
read
read_configuration
set_name	Set self.name=name and each self.child.name=name+"-child".
set_readable_signals	param read: Signals to make up read()
stage
unstage

Attributes

name	Return the name of the Device
parent	The parent Device if it exists

set_readable_signals(read: Sequence[SignalR] = (), config: Sequence[SignalR] = (), read_uncached: Sequence[SignalR] = ())

Parameters:

• read – Signals to make up read()

• conf – Signals to make up read_configuration()

• read_uncached – Signals to make up read() that won’t be cached

async connect(sim: bool = False, timeout: float = 10.0)

Connect self and all child Devices.

Contains a timeout that gets propagated to child.connect methods.

Parameters:

• sim – If True then connect in simulation mode.

• timeout – Time to wait before failing with a TimeoutError.

property name: str

Return the name of the Device

set_name(name: str)

Set self.name=name and each self.child.name=name+"-child".

Parameters:

name – New name to set