Skip to content

Instrument APIs

Patrick Irvin edited this page Oct 27, 2023 · 3 revisions

Instrument Framework Abstract Methods

The parameters below are written in the following format: Name (Units) [datatype]

Cryostat

Angle/Rotate

Get Angle.vi:

  • Return: Angle (°) [dbl] and Status [str]
  • Params: Axis [uint enum {Axis 1, Axis 2}]

Set Angle.vi:

  • Return: Angle (°) [dbl]
  • Params: Angle (°) [dbl], Rate (°/min) [dbl], Axis [uint enum {Z, X, Y}]

image

Chamber

Get Chamber.vi:

  • Return: status [str]

Set Chamber.vi

  • Params: action [str]

image

Heater

Get Heater.vi

  • Return: Current (A) [dbl], Status [str]
  • Params Channel [int]

Set Heater.vi

  • Params Current (A) [dbl], Channel [int]

image

Magnet

Get Magnet.vi

  • Return: Field (T) [dbl], Status [Str], Finished? [bool]
  • Params: Axis (uint enum {Z, X, Y})

Set Magnet.vi

  • Params: Field (T) [dbl], Rate (T/min) [dbl], Axis [uint enum {Z, X, Y}], Mode [uint enum {Persistent, Driven}]

image

Wait for Magnet Setpoint.vi

  • Params: Setpoint (T) [dbl], Tolerance (T) [dbl], Axis [uint enum {Z, X, Y}]

Cryogen Level

Get Nitrogen Level.vi

  • Return: LN2 Level (%) [dbl]

Get Helium Level.vi

  • Return: LHe Level (%) [dbl]

Pressure

Get Pressure.vi

  • Return: Pressure (mbar) [dbl]
  • Params: Channel (int)

Temperature

Get Temperature.vi

  • Return: Temperature (K) [dbl], Status [str], Finished [bool]
  • Params: Channel [int]

Set Temperature

  • Params: Temperature (K) [dbl], Rate (T/min) [dbl], Channel [int]

image

Wait for Temperature Setpoint.vi

  • Params: Setpoint (K) [dbl], Tolerance (K) [dbl], Channel [int], Type [enum {In Range, Less, Greater}]

Capacitance Bridge

Get Capacitance.vi

  • Return: Capacitance (pF) [dbl]
  • Params: Channel [int]

Delay Line

Get Delay.vi

  • Return: Delay (ps) [dbl], Finished? [bool]

Set Delay.vi

  • Params: Delay (ps) [dbl], Rate (ps/s) [dbl]

Lockin

Strain

Get Strain.vi

  • Return: Strain (V) [dbl]
  • Params: Channel [int]

Set Strain.vi

  • Params: Strain (V) [dbl], Slew (V/s) [dbl], Channel [int]

VNA

Get Data.vi

Set Average.vi

Set Format.vi

Set Measurement.vi

Set Power.vi

Set Sweep.vi

VSource

Get Bias Voltage.vi

  • Return: Bias Voltage (V) [dbl]

Set Bias Voltage.vi

  • Params: Bias Voltage (V) [dbl], Channel [int]

Clone this wiki locally