Instrument Settings¶

Instrument settings adjust the specific settings of an instrument. These are generic and unrelated to specific roles.

AnyInstrument¶

Describes the settings used for an arbitrary instrument

Possible voltmeter settings.

type	object
properties
v_range
nplc	Number of power line cycles
	type	number
num_readings	Number of readings to take for each poll
	type	integer
timer	How long to wait between concurrent readings. Only applicable to HP34420A
	type	number
timeout	How long to wait before throwing an error while waiting for data to come back.
	type	number

Possible RF source instrument settings.

type	object
properties
f_GHz	Frequency to set in GHz.
	type	number
AM	Whether or not to use amplitude modulation.
	type	boolean
AM_ext_port	External port number to use for amplitude modulation.
	type	integer
AM_ext_sensitivity_percent_per_volt	Linear sensitivity (percent per volt) of the modulated signal to the DC input.
	type	number

Possible settings for a voltage source.

Possible settings to use for a commercial power meter.

type	object
properties
read_units	Read units, restricted to Watts for compatibility.
	type	string
	enum	W
integration_time	How long to integrate symbol in seconds.
	type	number
	maximum	0.3
	minimum	0
zero_once	Forces a zeroing measurement to calibrate instrument, freezes the runner while it happens.
	type	boolean
timeout	how long to wait (in seconds) for data to be available before throwing an error.
	type	number
average_state	Activates continuous averaging of the sensor readings.
	type	str
	enum	ON, OFF

Possible settings for a Source Measure Unit (SMU).

type	object
properties
wiring	What kind of wiring to use.
	type	string
	enum	4W, 2W
source_measure	What to source and measure (V or I)
	type	string
	enum	SVMI, SVMV, SIMV, SIMI
panel	What to panel to use on the SMU
	type	string
	enum	front, rear
measure_for_duration_or_count	Sets the K2450 to always measure for count. K2450 only.
	type	string
	enum	count
source_level	Sets the source value in units of Volts or Amps (depending on source_measure setting).
	type	number
source_on	Sets the source output to on or off.
	type	string
	enum	on, off
source_range	‘auto’ or number, sets the source range.
	type	string / number
source_readback	Sets the source to measure its output and report that value.
	type	boolean
measure_autozero	Autozero the measurement values.
	type	boolean
source_delay	‘auto’ or a number. Sets the delay between source adjustment and measurement read back.
	type	string / number
count_per_level	Sets the number of readings per trigger. Typically 1.
	type	number
nplc	Integration time in power line cycles.
	type	number