bluesky.suspenders.SuspendBoolHigh

class bluesky.suspenders.SuspendBoolHigh(signal, *, sleep=0, pre_plan=None, post_plan=None, tripped_message='')

Suspend when a boolean signal goes high; resume when it goes low.

Parameters:
  • signal (ophyd.Signal) – The signal to watch for changes to determine if the scan should be suspended
  • sleep (float, optional) – How long to wait in seconds after the resume condition is met before marking the event as done. Defaults to 0
  • pre_plan (iterable or iterator, optional) – a generator, list, or similar containing Msg objects
  • post_plan (iterable or iterator, optional) – a generator, list, or similar containing Msg objects
__init__(signal, *, sleep=0, pre_plan=None, post_plan=None, tripped_message='')

Methods

__init__(signal, *[, sleep, pre_plan, ...])
get_futures() Return a list of futures to wait on.
install(RE, *[, event_type]) Install callback on signal
remove() Disable the suspender

Attributes

tripped