Instrument.update

Update instrument fields (name, visa_address, mode, etc.).

Signature

update(**kwargs: Any) -> None

Parameters

Name	Type	Required	Default
**kwargs	Any	no	-

HTTP parameters

Name	In	Type	Required	Default
instrument_id	path	string	yes	-

Fields

Schema: InstrumentUpdateIn

Field	Type	Required
instrument_model_id	string	no
mode	string	no
name	string	no
serial_number	string	no
visa_address	string	no

Return shape

HTTP 200 — OK

Schema: InstrumentOut

Field	Type	Required
connection_type	string	yes
id	string	yes
instrument_model	InstrumentModelSchema	yes
last_successful_connection	string	no
mode	string	yes
name	string	yes
serial_number	string	yes
visa_address	string	yes

Permission

Required permission: Team membership required

HTTP

PATCH /api/instruments/{id}/ (updateInstrument)

Usage

scope.update(name="Lab Scope #2", mode="simulated")