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

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

Bases: Signal[T], Readable, Stageable, Subscribable

Signal that can be read from and monitored

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_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 read(cached: bool | None = None) → Dict[str, Reading]

Return a single item dict with the reading in it

async describe() → Dict[str, Descriptor]

Return a single item dict with the descriptor in it

async get_value(cached: bool | None = None) → T

The current value

subscribe_value(function: Callable[[T], None])

Subscribe to updates in value of a device

subscribe(function: Callable[[Dict[str, Reading]], None]) → None

Subscribe to updates in the reading

clear_sub(function: Callable[[T], None]) → None

Remove a subscription.

stage() → None

Start caching this signal

unstage() → None

Stop caching this signal

async connect(sim=False)

Connect self and all child Devices.

Parameters:

sim:

If True then connect in simulation mode.

property name: str

Return the name of the Device

parent: Device | None = None

The parent Device if it exists

set_name(name: str = '')

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

Parameters:

name:

New name to set

property source: str

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