bluesky_queueserver_api.zmq.REManagerAPI.re_halt

REManagerAPI.re_halt(*, lock_key=None)

Request Run Engine to halt paused plan. See documentation for re_pause API for more detailed information.

Parameters:

lock_key: str or None (optional)

The lock key enables access to the API when RE Manager environment is locked. If the parameter is not None, the key overrides the current lock key set by REManagerAPI.lock_key. See documentation on REMangerAPI.lock() for more information. Default: None.

Returns:

dict

Dictionary keys:

• success: boolean - success of the request.

• msg: str - error message in case the request is rejected by RE Manager.

Raises:

RequestTimeoutError, RequestFailedError, HTTPRequestError, HTTPClientError, HTTPServerError

All exceptions raised by send_request API.