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(*args, **kwargs)#
-
Signal that can be both read and set
Methods
Remove a subscription.
Connect self and all child Devices.
Return a single item dict with the descriptor in it
The current value
Return a single item dict with the reading in it
Set the value and return a status saying when it's done
Set
self.name=name
and eachself.child.name=name+"-child"
.Start caching this signal
Subscribe to updates in the reading
Subscribe to updates in value of a device
Stop caching this signal
Attributes
Return the name of the Device
The parent Device if it exists
Like ca://PV_PREFIX:SIGNAL, or "" if not set
- abstract async connect(prefix: str = '', sim=False)#
Connect self and all child Devices.
- Parameters:
- prefix:
Device specific prefix that can be used to nest Devices one within another. For example a PV prefix.
- sim:
If True then connect in simulation mode.
- abstract async describe() Dict[str, Descriptor] #
Return a single item dict with the descriptor in it
- abstract async read(cached: Optional[bool] = None) Dict[str, Reading] #
Return a single item dict with the reading in it
- abstract set(value: T, wait=True) AsyncStatus #
Set the value and return a status saying when it’s done
- set_name(name: str = '')#
Set
self.name=name
and eachself.child.name=name+"-child"
.- Parameters:
- name:
New name to set, do nothing if blank or name is all set