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

class ophyd_async.core.SignalR(backend: SignalBackend[T] | None = None, timeout: float | None = 10.0, name: str = '')[source]#

Signal that can be read from and monitored

Methods

`children`
`clear_sub`	Remove a subscription.
`connect`
`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_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

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

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

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

async get_value(cached: bool | None = None) → T[source]#: The current value

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

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

clear_sub(function: Callable[[T], None]) → None[source]#: Remove a subscription.

async connect(mock=False, timeout=10.0, force_reconnect: bool = False, backend: SignalBackend[T] | None = None)#

set_name(name: str)#

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

property source: str#

//PV_PREFIX:SIGNAL, or “” if not set