set_instrument

Deploy an instrument into a Multi-Instrument Mode slot

set_instrument is a client-side function available in the Python and MATLAB APIs. In cURL, there is no equivalent call, after deploying Multi-Instrument Mode via platform, instrument functions can be called directly using either the instrument URL /api/<instrument>/<function> or the explicit slot URL /api/slot<n>/<instrument>/<function>.

Deploying an instrument into a slot will automatically upload the required bitstream to the device if it is not already present. Any slots not assigned an instrument will be filled with an empty placeholder bitstream.

Parameters

slot integer required

Target slot number. The number of available slots depends on the platform ID configured.

allowed values:

Moku:Lab	1 to 3
Moku:Go	1 to 3
Moku:Pro	1 to 4
Moku:Delta	1 to 8

instrument class required

Instrument class to deploy into the slot (e.g. WaveformGenerator, Oscilloscope, LockInAmp)

bitstream string

Path to the Custom Instrument bitstream package (.tar file). Only required when deploying a CustomInstrument or CustomInstrument+.

default: None

Examples