dodal.devices.i19.blueapi_device.OpticsBlueAPIDevice

class dodal.devices.i19.blueapi_device.OpticsBlueAPIDevice

General device that a REST call to the blueapi instance controlling the optics hutch running on the I19 cluster, which will evaluate the current hutch in use vs the hutch sending the request and decide if the plan will be run or not.

For details see the architecture described in DiamondLightSource/i19-bluesky#30.

Parameters:

name (str, default: '')

Methods

set(value)

On set send a POST request to the optics blueapi with the name and parameters, gets the generated task_id and then sends a PUT request that runs the plan.

Attributes

set(value: D)

On set send a POST request to the optics blueapi with the name and parameters, gets the generated task_id and then sends a PUT request that runs the plan.

Parameters:

value (dict) –

The value passed here should be the parameters for the POST request, taking the form: {

”name”: “plan_name”, “params”: {

”experiment_hutch”: f”{hutch_name}”, “access_device”: “access_control”, “other_params”: “…”, …

}

}