bluesky.plan_stubs.rel_set#
- bluesky.plan_stubs.rel_set(obj: Movable, *args: Any, group: Hashable | None = None, wait: bool = False, **kwargs) Generator[Msg, Any, Status][source]#
Set a value relative to current value. Optionally, wait before continuing.
- Parameters:
- objDevice
- args
passed to obj.set()
- groupstring (or any hashable object), optional
identifier used by ‘wait’; None by default
- waitboolean, optional
If True, wait for completion before processing any more messages. False by default.
- kwargs
passed to obj.set()
- Returns:
- status
Status that completes when the value is set. If wait is True, this will always be complete by the time it is returned.
- Yields:
- msgMsg