bluesky.plan_stubs.subscribe

bluesky.plan_stubs.subscribe(name: str, func: Callable[[str, Mapping[str, Any]], None]) → Generator[Msg, Any, int]

Subscribe the stream of emitted documents.

Parameters:

name{‘all’, ‘start’, ‘descriptor’, ‘event’, ‘stop’}

funccallable

Expected signature: f(name, doc) where name is one of the strings above (‘all, ‘start’, …) and doc is a dict

Returns:

token

Unique identifier for a subscription

Yields:

msgMsg

Msg(‘subscribe’, None, func, name)

See also

bluesky.plan_stubs.unsubscribe()