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.SignalRW#

class ophyd.v2.core.SignalRW(backend: SignalBackend[T], timeout: float | None = 10.0)#

Bases: SignalR[T], SignalW[T]

Signal that can be both read and set

Methods

`clear_sub`	Remove a subscription.
`connect`	Connect self and all child Devices.
`describe`	Return a single item dict with the descriptor in it
`get_value`	The current value
`read`	Return a single item dict with the reading in it
`set`	Set the value and return a status saying when it's done
`set_name`	Set `self.name=name` and each `self.child.name=name+"-child"`.
`stage`	Start caching this signal
`subscribe`	Subscribe to updates in the reading
`subscribe_value`	Subscribe to updates in value of a device
`unstage`	Stop caching this signal

Attributes

`name`	Return the name of the Device
`parent`	The parent Device if it exists
`source`	Like ca://PV_PREFIX:SIGNAL, or "" if not set

async connect(sim=False)#

Connect self and all child Devices.

Parameters:

async describe() → Dict[str, Descriptor]#: Return a single item dict with the descriptor in it

async read(cached: bool | None = None) → Dict[str, Reading]#: Return a single item dict with the reading in it

set(value: T, wait=True, timeout=None) → AsyncStatus#: Set the value and return a status saying when it’s done

set_name(name: str = '')#

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

Parameters:

subscribe(function: Callable[[Dict[str, Reading]], None]) → None#: Subscribe to updates in the reading

subscribe_value(function: Callable[[T], None])#: Subscribe to updates in value of a device