Instrument.control

Beta: This API may change shape in 0.1.x. It is not a frozen 1.0 contract.

Invoke a driver control method via WebSocket.

Sends instrument_control to the orb and waits for instrument_control_response. Extra kwargs besides target_orb_id are placed in the WS args object.

Signature

control(method: str, timeout: float=15.0, **args: Any) -> dict[str, Any]

Parameters

Name	Type	Required	Default
method	str	yes	-
timeout	float	no	15.0
**args	Any	no	-

Fields

Field
method
timeout
**args

Return shape

dict[str, Any]

Permission

This is a local SDK helper. It does not call the CloudSprite HTTP API.

Usage

result = scope.control("set_timebase", scale=1e-6)
if result["success"]:
    print(result.get("result"))