class IntMock(MockInstrument):
int_property = int_property('MOCK', readonly=True)
class IntMock(MockInstrument):
int_property = int_property('MOCK', valid_set=set([1, 2]))
class IntMock(MockInstrument):
int_property = int_property('MOCK')
class TC200(Instrument):
"""
The TC200 is is a controller for the voltage across a heating element.
It can also read in the temperature off of a thermistor and implements
a PID control to keep the temperature at a set value.
The user manual can be found here:
http://www.thorlabs.com/thorcat/12500/TC200-Manual.pdf
"""
def __init__(self, filelike):
super(TC200, self).__init__(filelike)
self.terminator = "\r"
self.prompt = "> "
def _ack_expected(self, msg=""):
return msg
# ENUMS #
class Mode(IntEnum):
"""
Enum containing valid output modes of the TC200.
"""
normal = 0
cycle = 1
class Sensor(Enum):
"""
Enum containing valid temperature sensor types for the TC200.
"""
ptc100 = "ptc100"
ptc1000 = "ptc1000"
th10k = "th10k"
ntc10k = "ntc10k"
# PROPERTIES #
def name(self):
"""
Gets the name and version number of the device
:return: the name string of the device
:rtype: str
"""
response = self.query("*idn?")
return response
@property
def mode(self):
"""
Gets/sets the output mode of the TC200
:type: `TC200.Mode`
"""
response = self.status
response_code = (int(response) >> 1) % 2
return TC200.Mode(response_code)
@mode.setter
def mode(self, newval):
if not isinstance(newval, TC200.Mode):
raise TypeError("Mode setting must be a `TC200.Mode` value, "
"got {} instead.".format(type(newval)))
out_query = "mode={}".format(newval.name)
# there is an issue with the TC200; it responds with a spurious
# Command Error on mode=normal. Thus, the sendcmd() method cannot
# be used.
if newval == TC200.Mode.normal:
self.prompt = "Command error CMD_ARG_RANGE_ERR\n\r> "
self.sendcmd(out_query)
self.prompt = "> "
else:
self.sendcmd(out_query)
@property
def enable(self):
"""
Gets/sets the heater enable status.
If output enable is on (`True`), there is a voltage on the output.
:type: `bool`
"""
response = self.status
return True if int(response) % 2 is 1 else False
@enable.setter
def enable(self, newval):
if not isinstance(newval, bool):
raise TypeError("TC200 enable property must be specified with a "
"boolean.")
# the "ens" command is a toggle, we need to track two different cases,
# when it should be on and it is off, and when it is off and
# should be on
# if no sensor is attached, the unit will respond with an error.
# There is no current error handling in the way that thorlabs
# responds with errors
if newval and not self.enable:
response1 = self._file.query("ens")
while response1 != ">":
response1 = self._file.read(1)
self._file.read(1)
elif not newval and self.enable:
response1 = self._file.query("ens")
while response1 != ">":
response1 = self._file.read(1)
self._file.read(1)
@property
def status(self):
"""
Gets the the status code of the TC200
:rtype: `int`
"""
_ = self._file.query(str("stat?"))
response = self.read(5)
return int(response.split(" ")[0])
temperature = unitful_property(
"tact",
units=pq.degC,
readonly=True,
input_decoration=lambda x: x.replace(" C", "").replace(
" F", "").replace(" K", ""),
doc="""
Gets the actual temperature of the sensor
:units: As specified (if a `~quantities.quantity.Quantity`) or assumed
to be of units degrees C.
:type: `~quantities.quantity.Quantity` or `int`
:return: the temperature (in degrees C)
:rtype: `~quantities.quantity.Quantity`
""")
max_temperature = unitful_property("tmax",
units=pq.degC,
format_code="{:.1f}",
set_fmt="{}={}",
valid_range=(20 * pq.degC,
205 * pq.degC),
doc="""
Gets/sets the maximum temperature
:return: the maximum temperature (in deg C)
:units: As specified or assumed to be degree Celsius. Returns with
units degC.
:rtype: `~quantities.quantity.Quantity`
""")
@property
def temperature_set(self):
"""
Gets/sets the actual temperature of the sensor
:units: As specified (if a `~quantities.quantity.Quantity`) or assumed
to be of units degrees C.
:type: `~quantities.quantity.Quantity` or `int`
:return: the temperature (in degrees C)
:rtype: `~quantities.quantity.Quantity`
"""
response = self.query("tset?").replace(" C", "").replace(" F",
"").replace(
" K", "")
return float(response) * pq.degC
@temperature_set.setter
def temperature_set(self, newval):
# the set temperature is always in celsius
newval = convert_temperature(newval, pq.degC).magnitude
if newval < 20.0 or newval > self.max_temperature:
raise ValueError("Temperature set is out of range.")
out_query = "tset={}".format(newval)
self.sendcmd(out_query)
@property
def p(self):
"""
Gets/sets the p-gain. Valid numbers are [1,250].
:return: the p-gain (in nnn)
:rtype: `int`
"""
return self.pid[0]
@p.setter
def p(self, newval):
if newval not in range(1, 251):
raise ValueError("P-value not in [1, 250]")
self.sendcmd("pgain={}".format(newval))
@property
def i(self):
"""
Gets/sets the i-gain. Valid numbers are [1,250]
:return: the i-gain (in nnn)
:rtype: `int`
"""
return self.pid[1]
@i.setter
def i(self, newval):
if newval not in range(0, 251):
raise ValueError("I-value not in [0, 250]")
self.sendcmd("igain={}".format(newval))
@property
def d(self):
"""
Gets/sets the d-gain. Valid numbers are [0, 250]
:return: the d-gain (in nnn)
:type: `int`
"""
return self.pid[2]
@d.setter
def d(self, newval):
if newval not in range(0, 251):
raise ValueError("D-value not in [0, 250]")
self.sendcmd("dgain={}".format(newval))
@property
def pid(self):
"""
Gets/sets all three PID values at the same time. See `TC200.p`,
`TC200.i`, and `TC200.d` for individual restrictions.
If `None` is specified then the corresponding PID value is not changed.
:return: List of integers of PID values. In order [P, I, D].
:type: `list` or `tuple`
:rtype: `list`
"""
return list(map(int, self.query("pid?").split()))
@pid.setter
def pid(self, newval):
if not isinstance(newval, (list, tuple)):
raise TypeError("Setting PID must be specified as a list or tuple")
if newval[0] is not None:
self.p = newval[0]
if newval[1] is not None:
self.i = newval[1]
if newval[2] is not None:
self.d = newval[2]
@property
def degrees(self):
"""
Gets/sets the units of the temperature measurement.
:return: The temperature units (degC/F/K) the TC200 is measuring in
:type: `~quantities.unitquantity.UnitTemperature`
"""
response = self.status
if (response >> 4) % 2 and (response >> 5) % 2:
return pq.degC
elif (response >> 5) % 2:
return pq.degK
else:
return pq.degF
@degrees.setter
def degrees(self, newval):
if newval is pq.degC:
self.sendcmd("unit=c")
elif newval is pq.degF:
self.sendcmd("unit=f")
elif newval is pq.degK:
self.sendcmd("unit=k")
else:
raise TypeError("Invalid temperature type")
sensor = enum_property("sns",
Sensor,
input_decoration=lambda x: x.split(",")[0].split(
"=")[1].strip().lower(),
set_fmt="{}={}",
doc="""
Gets/sets the current thermistor type. Used for converting resistances
to temperatures.
:return: The thermistor type
:type: `TC200.Sensor`
""")
beta = int_property("beta",
valid_set=range(2000, 6001),
set_fmt="{}={}",
doc="""
Gets/sets the beta value of the thermistor curve.
Value within [2000, 6000]
:return: the gain (in nnn)
:type: `int`
""")
max_power = unitful_property("pmax",
units=pq.W,
format_code="{:.1f}",
set_fmt="{}={}",
valid_range=(0.1 * pq.W, 18.0 * pq.W),
doc="""
Gets/sets the maximum power
:return: The maximum power
:units: Watts (linear units)
:type: `~quantities.quantity.Quantity`
""")
class IntMock(MockInstrument):
int_property = int_property('MOCK', set_cmd='FOOBAR')
class Wavetek39A(SCPIInstrument, FunctionGenerator):
"""
The Wavetek 39A is a 40MS/s function generator. Arbitraty waveforms can have up to 65536 horizontal points,
vertical range is -2048 to +2047 (12 bit), maximum peak-to-peak is 20V. Up to 100 waveforms, 256 KB NVRAM.
Channel memory is 64 KB.
Example usage:
>>> import instruments as ik
>>> import instruments.units as u
>>> fg = ik.wavetek.Wavetek39A.open_gpib('/dev/ttyUSB0', 1)
>>> fg.frequency = 1 * u.MHz
>>> print(fg.offset)
>>> fg.function = fg.Function.triangle
"""
def __init__(self, filelike):
super(Wavetek39A, self).__init__(filelike)
self.terminator = ""
# CONSTANTS #
_UNIT_MNEMONICS = {
FunctionGenerator.VoltageMode.peak_to_peak: "VPP",
FunctionGenerator.VoltageMode.rms: "VRMS",
FunctionGenerator.VoltageMode.dBm: "DBM",
}
_MNEMONIC_UNITS = dict(
(mnem, unit) for unit, mnem in _UNIT_MNEMONICS.items())
# FunctionGenerator CONTRACT #
def _get_amplitude_(self):
return (
0.0, # amplitude is writeonly (FIXME: trigger exception instead?)
self._MNEMONIC_UNITS["VPP"])
def _set_amplitude_(self, magnitude, units):
self.sendcmd("AMPUNIT {}".format(self._UNIT_MNEMONICS[units]))
self.sendcmd("AMPL {}".format(magnitude))
# ENUMS ##
class Function(Enum):
"""
Enum containing valid output function modes for the Wavetek 39A
"""
#: sinusoidal
sinusoid = "SINE"
#: square
square = "SQUARE"
#: triangular
triangle = "TRIANG"
#: constant voltage
dc = "DC"
#: positive ramp
positive_ramp = "POSRMP"
#: negative ramp
negative_ramp = "NEGRMP"
#: cosine
cosine = "COSINE"
#: haversine, sin^2(x/2)=(1-cos x)/2
haversine = "HAVSIN"
#: havercosine, (1+cos x)/2
havercosine = "HAVCOS"
#: sinc(x)=sin(x)/x
sinc = "SINC"
#: pulse
pulse = "PULSE"
#: pulse train
pulse_train = "PULSTRN"
#: arbitrary waveform
arbitrary = "ARB"
#: sequence of up to 16 waveforms
sequence = "SEQ"
class ZLoad(Enum):
"""
Enum containing the output load settings
"""
#: 50 Ohm termination
Z50 = "50"
#: 600 Ohm termination
Z600 = "600"
#: Z=ininity, open circuit
OPEN = "OPEN"
class OutputMode(Enum):
"""
Enum containing the output mode settings
"""
#: normal (non-inverted) output
normal = "NORMAL"
#: inverted output (around the same offset if offset is non-zero!)
invert = "INVERT"
class Mode(Enum):
"""
Enum containing the mode settings
"""
#: continuous operation
cont = "CONT"
continuous = "CONT"
#: gated
gate = "GATE"
gated = "GATE"
#: triggered burst mode (each active edge of the trigger signal produces one
#: burst of the waveform)
trig = "TRIG"
triggered = "TRIG"
#: sweep
sweep = "SWEEP"
#: tone mode
tone = "TONE"
class SweepType(Enum):
"""
Enum containing the sweep type
"""
#: continuous operation
cont = "CONT"
continuous = "CONT"
#: triggered sweep (front TRIG IN socket, remote command, manually with MAN TRIG key)
#: Sweep is initiated on the rising edge of the trigger signal.
trig = "TRIG"
triggered = "TRIG"
#: triggered, hold and reset
triggered_hold_reset = "THLDRST"
#: manual sweeping (using rotary control or cursor keys)
manual = "MANUAL"
class SweepDirection(Enum):
"""
Enum containing the sweep direction
"""
#: up
up = "UP"
#: down
down = "DOWN"
#: up/down
updn = "UPDN"
updown = "UPDN"
#: down/up
dnup = "DNUP"
downup = "DNUP"
class SweepSpacing(Enum):
"""
Enum containing the sweep spacing
"""
#: linear
lin = "LIN"
linear = "LIN"
#: logarithmic
log = "LOG"
logarithmic = "LOG"
class SweepManual(Enum):
"""
Enum containing the sweep manual parameters [???]
"""
#: up
up = "UP"
#: down
down = "DOWN"
class SweepManualSpeed(Enum):
"""
Enum containing the manual sweep step size.
"""
#: fast
fast = "FAST"
#: slow
slow = "SLOW"
class SweepManualWrap(Enum):
"""
Enum containing the manual sweep wrapping.
"""
#: wrap on
wrapon = "WRAPON"
#: wrap off
wrapoff = "WRAPOFF"
class SyncOutMode(Enum):
"""
Enum containing sync output settings
"""
#: automatic
auto = "AUTO"
#: waveform sync (sync marker, for standward waveform raising edge at 0 deg point,
#: for arbitrary waveform coincident with the first point)
waveform_sync = "WFMSYNC"
#: position marker for arbitrary waveform, for standard waveforms short pulse at the start of cycle
position_marker = "POSNMKR"
#: burst sequence done (low while the waveform is active)
burst_done = "BSTDONE"
#: sync signal low during the last cycle of the last waveform in a sequence, high at all other times
sequence_sync = "SEQSYNC"
#: positive going version of the trigger signal
trigger = "TRIGGER"
#: goes high at the start of the sweep, goes low at the end of the sweep
sweep = "SWPTRG"
#: positive edge coincident with the start of the current waveform
phase_lock = "PHASLOC"
class TriggerInput(Enum):
"""
Enum containing trigger input settings
"""
internal = "INT"
external = "EXT"
manual = "MAN"
class TriggerInputEdge(Enum):
"""
Enum containing external trigger input edge
"""
positive = "POS"
negative = "NEG"
class HoldMode(Enum):
"""
Enum containing the hold mode
"""
#: on/off are the same as pressing the MAN HOLD key
on = "ON"
off = "OFF"
#: enable/disable enable or disable the action of the MAN HOLD key
enable = "ENAB"
disable = "DISAB"
class Filter(Enum):
"""
Enum containing the output filter types
"""
#: automatic (most appropriate for the current waveform)
auto = "AUTO"
#: 10MHz elliptic
elliptic10 = "EL10"
#: 16MHz elliptic (sine, cosine, haversine, havercosine above 10Mhz)
elliptic16 = "EL16"
#: 10MHz Bessel (positive and negative ramps, arbitrary and sequence)
Bessel = "BESS"
#: no output filtering (square wave, pulse, pulse trains)
none = "NONE"
class BeepMode(Enum):
"""
Enum containing beep modes
"""
on = "ON"
off = "OFF"
warnings = "WARN"
errors = "ERROR"
# PROPERTIES ##
frequency = unitful_property(command="WAVFREQ",
units=u.Hz,
writeonly=True,
doc="""
Sets the output frequency.
:units: As specified, or assumed to be :math:`\\text{Hz}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
period = unitful_property(command="WAVPER",
units=u.s,
writeonly=True,
doc="""
Sets the output period.
:units: As specified, or assumed to be :math:`\\text{s}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
clock_frequency = unitful_property(command="CLKFREQ",
units=u.Hz,
writeonly=True,
doc="""
Sets the arbitrary sample clock frequency. Range 0.1Hz to 40MHz.
:units: As specified, or assumed to be :math:`\\text{Hz}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
clock_period = unitful_property(command="CLKPER",
units=u.s,
writeonly=True,
doc="""
Sets the arbitrary sample clock period.
:units: As specified, or assumed to be :math:`\\text{s}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
zload = enum_property(command="ZLOAD",
enum=ZLoad,
writeonly=True,
doc="""
Sets the output load.
:type: `~Wavetek39A.ZLoad`
""")
offset = unitful_property(command="DCOFFS",
units=u.volt,
writeonly=True,
doc="""
Sets the offset voltage for the output waveform.
:units: As specified, or assumed to be :math:`\\text{V}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
function = enum_property(command="WAVE",
enum=Function,
writeonly=True,
doc="""
Sets the output function of the function generator.
:type: `~Wavetek39A.Function`
""")
pulse_period = unitful_property(command="PULSPER",
units=u.s,
writeonly=True,
doc="""
Sets the pulse period.
:units: As specified, or assumed to be :math:`\\text{s}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
pulse_width = unitful_property(command="PULSWID",
units=u.s,
writeonly=True,
doc="""
Sets the pulse width.
:units: As specified, or assumed to be :math:`\\text{s}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
pulse_delay = unitful_property(command="PULSDLY",
units=u.s,
writeonly=True,
doc="""
Sets the pulse delay.
:units: As specified, or assumed to be :math:`\\text{s}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
pulse_train_length = int_property(command="PULSTRNLEN",
writeonly=True,
doc="""
Sets the number of pulses in the pulse-train.
:units: Number.
:type: `int`
""")
pulse_train_period = unitful_property(command="PULSTRNPER",
units=u.s,
writeonly=True,
doc="""
Sets the pulse-train period.
:units: As specified, or assumed to be :math:`\\text{s}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
pulse_train_base_line = unitful_property(command="PULSTRNBASE",
units=u.V,
writeonly=True,
doc="""
Sets the pulse-train base line voltage.
:units: As specified, or assumed to be :math:`\\text{V}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
# pulse_train_level = unitful_property( ## has two parameters!
arbitrary = string_property(command="ARB",
writeonly=True,
bookmark_symbol='',
doc="""
Select an arbitray waveform for output.
:type: `str`
""")
arbitrary_list_ch = string_property(command="ARBLISTCH",
readonly=True,
bookmark_symbol='',
doc="""
List of all arbitrary waveforms in the channel's memory.
:type: `str`
""")
arbitrary_list = string_property(command="ARBLIST",
readonly=True,
bookmark_symbol='',
doc="""
List of all arbitrary waveforms in the backup memory.
:type: `str`
""")
def arbitrary_delete(self, cpd):
"""
Delete an arbitrary wavefrom from backup memory.
A waveform used by a non-active sequence can be deleted but the sequence will not subsequently
run properly and should be modified to exclude the deleted waveform.
:type: `str`
"""
check_arb_name(cpd)
self.sendcmd("ARBDELETE {}".format(cpd))
def arbitrary_clear(self, cpd):
"""
Delete an arbitrary wavefrom from channel memory.
A waveform cannot be deleted from a channel’s memory if it is running on that channel.
If an arb waveform sequence is running no waveforms can be deleted from that channel,
whether they are used in the sequence or not.
Waveforms must be deleted from the channel’s memory before they can be deleted from the back-up memory.
(i.e. call arbitrary_clear before arbitrary_delete)
:type: `str`
"""
check_arb_name(cpd)
self.sendcmd("ARBCLR {}".format(cpd))
def arbitrary_create(self, cpd, nrf):
"""
Create a new blank arbitrary waveform.
:type cpd: `str`
:type nrf: `int`
"""
check_arb_name(cpd)
self.sendcmd("ARBCREATE {},{}".format(cpd, nrf))
def _arbitrary_send_data_csv(self, cpd, csv, command):
length, csvint = prepare_for_sending(cpd, csv)
cmd = "{} {},{},{}".format(command, cpd, str(length),
",".join([str(i) for i in csvint]))
self.sendcmd(cmd)
def _arbitrary_send_data(self, cpd, csv, command):
length, csvint = prepare_for_sending(cpd, csv)
bin_data = struct.pack('>{}h'.format(length), *csvint)
size_str = str(len(bin_data))
len_size_str = len(size_str)
header = '#{}{}'.format(len_size_str, size_str)
cmd = "{} {},{},{}{}".format(command, cpd, str(length), header,
bin_data)
self.sendcmd(cmd)
def arbitrary_define_csv(self, cpd, csv):
"""
Define a new or existing arbitrary waveform from a list.
:type cpd: `str`
:type csv: `iterable`
"""
self._arbitrary_send_data_csv(cpd, csv, "ARBDEFCSV")
def arbitrary_define(self, cpd, csv):
"""
Define a new or existing arbitrary waveform from a list.
:type cpd: `str`
:type csv: `iterable`
"""
self._arbitrary_send_data(cpd, csv, "ARBDEF")
def arbitrary_get_data_csv(self, cpd):
"""
Returns the arbitrary waveform data as ASCII data.
:rtype: `str`
"""
check_arb_name(cpd)
self.query("ARBDATACSV? {}".format(cpd))
def arbitray_edit_limits(self, nrf1, nrf2):
"""
Define editing limits for the currently edited arbitrary waveform.
:type nrf1: `int`
:type nrf2: `int`
"""
self.sendcmd("ARBEDLMTS {},{}".format(nrf1, nrf2))
def arbitrary_data_csv(self, cpd, csv):
self._arbitrary_send_data_csv(cpd, csv, "ARBDATACSV")
def arbitrary_data(self, cpd, csv):
self._arbitrary_send_data(cpd, csv, "ARBDATA")
phase = unitful_property(command="PHASE",
units=u.degree,
writeonly=True,
doc="""
Sets the phase for the output waveform.
:units: As specified, or assumed to be degrees (:math:`{}^{\\circ}`)
otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
sweep_start_frequency = unitful_property(command="SWPSTARTFRQ",
units=u.Hz,
writeonly=True,
doc="""
Sets the sweep start frequency. Minimum is 1 mHz.
:units: As specified, or assumed to be Hz otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
sweep_stop_frequency = unitful_property(command="SWPSTOPFRQ",
units=u.Hz,
writeonly=True,
doc="""
Sets the sweep stop frequency. Maximum is 16 MHz for all waveforms,
including triangle, ramp and square wave.
:units: As specified, or assumed to be Hz otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
sweep_centre_frequency = unitful_property(command="SWPCENTFRQ",
units=u.Hz,
writeonly=True,
doc="""
Sets the sweep centre frequency.
:units: As specified, or assumed to be Hz otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
sweep_span = unitful_property(command="SWPSPAN",
units=u.Hz,
writeonly=True,
doc="""
Sets the sweep frequency span.
:units: As specified, or assumed to be Hz otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
sweep_time = unitful_property(command="SWPTIME",
units=u.s,
writeonly=True,
doc="""
Sets the sweep time. 0.03s to 999s with 3-digit resolution.
:units: As specified, or assumed to be s otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
sweep_type = enum_property(command="SWPTYPE",
enum=SweepType,
writeonly=True,
doc="""
Sets the sweep type.
:type: `~Wavetek39A.SweepType`
""")
sweep_direction = enum_property(command="SWPDIRN",
enum=SweepDirection,
writeonly=True,
doc="""
Sets the sweep direction.
:type: `~Wavetek39A.SweepDirection`
""")
sweep_sync = bool_property("SWPSYNC",
inst_true="ON",
inst_false="OFF",
writeonly=True,
doc="""
Sets the sweep syncs on and off. If on (default), the generator steps from the stop
frequency to zero frequency and then starts the next sweep from the first point of the
waveform, synchronized to the internally generated trigger signal.
""")
sweep_spacing = enum_property(command="SWPSPACING",
enum=SweepSpacing,
writeonly=True,
doc="""
Sets the sweep spacing.
:type: `~Wavetek39A.SweepSpacing`
""")
sweep_marker = unitful_property(command="SWPMARKER",
units=u.Hz,
writeonly=True,
doc="""
Sets the sweep marker (rear panel CURSOR/MARKER OUT socket).
:units: As specified, or assumed to be Hz otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
sweep_manual_speed = enum_property(command="SWPMANUAL",
enum=SweepManualSpeed,
writeonly=True,
doc="""
Sets the manual step size.
:type: `~Wavetek39A.SweepManualSpeed`
""")
sweep_manual_wrap = bool_property("SWPMANUAL",
inst_true="WRAPON",
inst_false="WRAPOFF",
writeonly=True,
doc="""
Sets the sweep wrapping on/off.
""")
output = bool_property("OUTPUT",
inst_true="ON",
inst_false="OFF",
writeonly=True,
doc="""
Sets the output on and off.
""")
output_mode = enum_property(command="OUTPUT",
enum=OutputMode,
writeonly=True,
doc="""
Sets the output mode (normal vs. inverted).
:type: `~Wavetek39A.OutputMode`
""")
mode = enum_property(command="MODE",
enum=Mode,
writeonly=True,
doc="""
Sets the mode.
:type: `~Wavetek39A.Mode`
""")
syncout = bool_property("SYNCOUT",
inst_true="ON",
inst_false="OFF",
writeonly=True,
doc="""
Sets the sync output on and off.
""")
syncout_mode = enum_property(command="SYNCOUT",
enum=SyncOutMode,
writeonly=True,
doc="""
Sets the sync output mode.
:type: `~Wavetek39A.SyncOut`
""")
trigger_input = enum_property(command="TRIGIN",
enum=TriggerInput,
writeonly=True,
doc="""
Sets the trigger input.
:type: `~Wavetek39A.TriggerInput`
""")
trigger_input_edge = enum_property(command="TRIGIN",
enum=TriggerInputEdge,
writeonly=True,
doc="""
Sets the edge for external trigger input.
:type: `~Wavetek39A.TriggerInputEdge`
""")
trigger_period = unitful_property(command="TRIGPER",
units=u.s,
writeonly=True,
doc="""
Sets the internal trigger period.
:units: As specified, or assumed to be seconds otherwise.
:type: `float` or `~quantities.quantity.Quantity`
""")
def reset(self):
"""
Resets the instrument parameters to their default values.
"""
self.sendcmd("*RST")
def force_trigger(self):
"""
Force a trigger
"""
self.sendcmd("FORCETRG")
burst_count = int_property(command="BSTCNT",
writeonly=True,
doc="""
Sets the burst count.
:units: Number of cycles.
:type: `int`
""")
def recall(self, nrf):
"""
Recall the set up in store 'nrf'. 0-9. 0 are default settings.
"""
if not 0 <= nrf <= 9:
raise RuntimeError("out of range {}".format(nrf))
self.sendcmd("*RCL {}".format(nrf))
def save(self, nrf):
"""
Save the set up in store 'nrf'. 1-9.
"""
if not 1 <= nrf <= 9:
raise RuntimeError("out of range {}".format(nrf))
self.sendcmd("*SAV {}".format(nrf))
def manual_trigger(self):
"""
Same as pressing the MAN TRIG key.
"""
self.sendcmd("*TRG")
holdmode = enum_property(command="HOLD",
enum=HoldMode,
writeonly=True,
doc="""
Sets the hold mode.
:type: `~Wavetek39A.HoldMode`
""")
filter = enum_property(command="FILTER",
enum=Filter,
writeonly=True,
doc="""
Sets the output filter type.
:type: `~Wavetek39A.Filter`
""")
beepmode = enum_property(command="BEEPMODE",
enum=BeepMode,
writeonly=True,
doc="""
Sets the beep mode.
:type: `~Wavetek39A.BeepMode`
""")
def beep(self):
"""
Beep once
"""
self.sendcmd("BEEP")
def local(self):
"""
Returns the instrument to local operation and unlock the keyboard.
"""
self.sendcmd("LOCAL")
class HP6632b(SCPIInstrument, HP6652a):
"""
The HP6632b is a system dc power supply with an output rating of 0-20V/0-5A,
precision low current measurement and low output noise.
According to the manual this class MIGHT be usable for any HP power supply
with a model number
- HP663Xb with X in {1, 2, 3, 4},
- HP661Xc with X in {1,2, 3, 4} and
- HP663X2A for X in {1, 3}, without the additional measurement capabilities.
HOWEVER, it has only been tested by the author with HP6632b supplies.
Example usage:
>>> import instruments as ik
>>> psu = ik.hp.HP6632b.open_gpibusb('/dev/ttyUSB0', 6)
>>> psu.voltage = 10 # Sets voltage to 10V.
>>> psu.output = True # Enable output
>>> psu.voltage
array(10.0) * V
>>> psu.voltage_trigger = 20 # Set transient trigger voltage
>>> psu.init_output_trigger() # Prime instrument to initiated state, ready for trigger
>>> psu.trigger() # Send trigger
>>> psu.voltage
array(10.0) * V
"""
# ENUMS ##
class ALCBandwidth(IntEnum):
"""
Enum containing valid ALC bandwidth modes for the hp6632b
"""
normal = 1.5e4
fast = 6e4
class DigitalFunction(Enum):
"""
Enum containing valid digital function modes for the hp6632b
"""
remote_inhibit = 'RIDF'
data = 'DIG'
class DFISource(Enum):
"""
Enum containing valid DFI sources for the hp6632b
"""
questionable = 'QUES'
operation = 'OPER'
event_status_bit = 'ESB'
request_service_bit = 'RQS'
off = 'OFF'
class ErrorCodes(IntEnum):
"""
Enum containing generic-SCPI error codes along with codes specific
to the HP6632b.
"""
no_error = 0
# -100 BLOCK: COMMAND ERRORS ##
command_error = -100
invalid_character = -101
syntax_error = -102
invalid_separator = -103
data_type_error = -104
get_not_allowed = -105
# -106 and -107 not specified.
parameter_not_allowed = -108
missing_parameter = -109
command_header_error = -110
header_separator_error = -111
program_mnemonic_too_long = -112
undefined_header = -113
header_suffix_out_of_range = -114
unexpected_number_of_parameters = -115
numeric_data_error = -120
invalid_character_in_number = -121
exponent_too_large = -123
too_many_digits = -124
numeric_data_not_allowed = -128
suffix_error = -130
invalid_suffix = -131
suffix_too_long = -134
suffix_not_allowed = -138
character_data_error = -140
invalid_character_data = -141
character_data_too_long = -144
character_data_not_allowed = -148
string_data_error = -150
invalid_string_data = -151
string_data_not_allowed = -158
block_data_error = -160
invalid_block_data = -161
block_data_not_allowed = -168
expression_error = -170
invalid_expression = -171
expression_not_allowed = -178
macro_error_180 = -180
invalid_outside_macro_definition = -181
invalid_inside_macro_definition = -183
macro_parameter_error = -184
# -200 BLOCK: EXECUTION ERRORS ##
# -300 BLOCK: DEVICE-SPECIFIC ERRORS ##
# Note that device-specific errors also include all positive numbers.
# -400 BLOCK: QUERY ERRORS ##
# OTHER ERRORS ##
#: Raised when the instrument detects that it has been turned from
#: off to on.
power_on = -500 # Yes, SCPI 1999 defines the instrument turning on as
# an error. Yes, this makes my brain hurt.
user_request_event = -600
request_control_event = -700
operation_complete = -800
# -200 BLOCK: EXECUTION ERRORS
execution_error = -200
data_out_of_range = -222
too_much_data = -223
illegal_parameter_value = -224
out_of_memory = -225
macro_error_270 = -270
macro_execution_error = -272
illegal_macro_label = -273
macro_recursion_error = -276
macro_redefinition_not_allowed = -277
# -300 BLOCK: DEVICE-SPECIFIC ERRORS
system_error = -310
too_many_errors = -350
# -400 BLOCK: QUERY ERRORS
query_error = -400
query_interrupted = -410
query_unterminated = -420
query_deadlocked = -430
query_unterminated_after_indefinite_response = -440
# DEVICE ERRORS
ram_rd0_checksum_failed = 1
ram_config_checksum_failed = 2
ram_cal_checksum_failed = 3
ram_state_checksum_failed = 4
ram_rst_checksum_failed = 5
ram_selftest = 10
vdac_idac_selftest1 = 11
vdac_idac_selftest2 = 12
vdac_idac_selftest3 = 13
vdac_idac_selftest4 = 14
ovdac_selftest = 15
digital_io_selftest = 80
ingrd_recv_buffer_overrun = 213
rs232_recv_framing_error = 216
rs232_recv_parity_error = 217
rs232_recv_overrun_error = 218
front_panel_uart_overrun = 220
front_panel_uart_framing = 221
front_panel_uart_parity = 222
front_panel_uart_buffer_overrun = 223
front_panel_uart_timeout = 224
cal_switch_prevents_cal = 401
cal_password_incorrect = 402
cal_not_enabled = 403
computed_readback_cal_const_incorrect = 404
computed_prog_cal_constants_incorrect = 405
incorrect_seq_cal_commands = 406
cv_or_cc_status_incorrect = 407
output_mode_must_be_normal = 408
too_many_sweep_points = 601
command_only_applic_rs232 = 602
curr_or_volt_fetch_incompat_with_last_acq = 603
measurement_overrange = 604
class RemoteInhibit(Enum):
"""
Enum containing vlaid remote inhibit modes for the hp6632b.
"""
latching = 'LATC'
live = 'LIVE'
off = 'OFF'
class SenseWindow(Enum):
"""
Enum containing valid sense window modes for the hp6632b.
"""
hanning = 'HANN'
rectangular = 'RECT'
# PROPERTIES ##
voltage_alc_bandwidth = enum_property(
"VOLT:ALC:BAND",
ALCBandwidth,
input_decoration=lambda x: int(float(x)),
readonly=True,
doc="""
Get the "automatic level control bandwidth" which for the HP66332A and
HP6631-6634 determines if the output capacitor is in circuit. `Normal`
denotes that it is, and `Fast` denotes that it is not.
:type: `~HP6632b.ALCBandwidth`
"""
)
voltage_trigger = unitful_property(
"VOLT:TRIG",
u.volt,
doc="""
Gets/sets the pending triggered output voltage.
Note there is no bounds checking on the value specified.
:units: As specified, or assumed to be :math:`\\text{V}` otherwise.
:type: `float` or `~quantities.Quantity`
"""
)
current_trigger = unitful_property(
"CURR:TRIG",
u.amp,
doc="""
Gets/sets the pending triggered output current.
Note there is no bounds checking on the value specified.
:units: As specified, or assumed to be :math:`\\text{A}` otherwise.
:type: `float` or `~quantities.Quantity`
"""
)
init_output_continuous = bool_property(
"INIT:CONT:SEQ1",
"1",
"0",
doc="""
Get/set the continuous output trigger. In this state, the power supply
will remain in the initiated state, and respond continuously on new
incoming triggers by applying the set voltage and current trigger
levels.
:type: `bool`
"""
)
current_sense_range = unitful_property(
'SENS:CURR:RANGE',
u.ampere,
doc="""
Get/set the sense current range by the current max value.
A current of 20mA or less selects the low-current range, a current
value higher than that selects the high-current range. The low current
range increases the low current measurement sensitivity and accuracy.
:units: As specified, or assumed to be :math:`\\text{A}` otherwise.
:type: `float` or `~quantities.quantity.Quantity`
"""
)
output_dfi = bool_property(
'OUTP:DFI',
'1',
'0',
doc="""
Get/set the discrete fault indicator (DFI) output from the dc
source. The DFI is an open-collector logic signal connected to the read
panel FLT connection, that can be used to signal external devices when
a fault is detected.
:type: `bool`
"""
)
output_dfi_source = enum_property(
"OUTP:DFI:SOUR",
DFISource,
doc="""
Get/set the source for discrete fault indicator (DFI) events.
:type: `~HP6632b.DFISource`
"""
)
output_remote_inhibit = enum_property(
"OUTP:RI:MODE",
RemoteInhibit,
doc="""
Get/set the remote inhibit signal. Remote inhibit is an external,
chassis-referenced logic signal routed through the rear panel INH
connection, which allows an external device to signal a fault.
:type: `~HP6632b.RemoteInhibit`
"""
)
digital_function = enum_property(
"DIG:FUNC",
DigitalFunction,
doc="""
Get/set the inhibit+fault port to digital in+out or vice-versa.
:type: `~HP6632b.DigitalFunction`
"""
)
digital_data = int_property(
"DIG:DATA",
valid_set=range(0, 8),
doc="""
Get/set digital in+out port to data. Data can be an integer from 0-7.
:type: `int`
"""
)
sense_sweep_points = unitless_property(
"SENS:SWE:POIN",
doc="""
Get/set the number of points in a measurement sweep.
:type: `int`
"""
)
sense_sweep_interval = unitful_property(
"SENS:SWE:TINT",
u.second,
doc="""
Get/set the digitizer sample spacing. Can be set from 15.6 us to 31200
seconds, the interval will be rounded to the nearest 15.6 us increment.
:units: As specified, or assumed to be :math:`\\text{s}` otherwise.
:type: `float` or `~quantities.Quantity`
"""
)
sense_window = enum_property(
"SENS:WIND",
SenseWindow,
doc="""
Get/set the measurement window function.
:type: `~HP6632b.SenseWindow`
"""
)
output_protection_delay = unitful_property(
"OUTP:PROT:DEL",
u.second,
doc="""
Get/set the time between programming of an output change that produces
a constant current condition and the recording of that condigition in
the Operation Status Condition register. This command also delays over
current protection, but not overvoltage protection.
:units: As specified, or assumed to be :math:`\\text{s}` otherwise.
:type: `float` or `~quantities.Quantity`
"""
)
# FUNCTIONS ##
def init_output_trigger(self):
"""
Set the output trigger system to the initiated state. In this state,
the power supply will respond to the next output trigger command.
"""
self.sendcmd('INIT:NAME TRAN')
def abort_output_trigger(self):
"""
Set the output trigger system to the idle state.
"""
self.sendcmd('ABORT')
# SCPIInstrument commands that need local overrides
@property
def line_frequency(self):
raise NotImplementedError
@line_frequency.setter
def line_frequency(self, newval):
raise NotImplementedError
@property
def display_brightness(self):
raise NotImplementedError
@display_brightness.setter
def display_brightness(self, newval):
raise NotImplementedError
@property
def display_contrast(self):
raise NotImplementedError
@display_contrast.setter
def display_contrast(self, newval):
raise NotImplementedError
def check_error_queue(self):
"""
Checks and clears the error queue for this device, returning a list of
:class:`~SCPIInstrument.ErrorCodes` or `int` elements for each error
reported by the connected instrument.
"""
done = False
result = []
while not done:
err = int(self.query('SYST:ERR?').split(',')[0])
if err == self.ErrorCodes.no_error:
done = True
else:
result.append(
self.ErrorCodes(err)
if any(err == item.value for item in self.ErrorCodes)
else err
)
return result
class Agilent33220a(SCPIFunctionGenerator):
"""
The `Agilent/Keysight 33220a`_ is a 20MHz function/arbitrary waveform
generator. This model has been replaced by the Keysight 33500 series
waveform generators. This class may or may not work with these newer
models.
Example usage:
>>> import instruments as ik
>>> import instruments.units as u
>>> inst = ik.agilent.Agilent33220a.open_gpibusb('/dev/ttyUSB0', 1)
>>> inst.function = inst.Function.sinusoid
>>> inst.frequency = 1 * u.kHz
>>> inst.output = True
.. _Agilent/Keysight 33220a: http://www.keysight.com/en/pd-127539-pn-33220A
"""
# ENUMS #
class Function(Enum):
"""
Enum containing valid functions for the Agilent/Keysight 33220a
"""
sinusoid = "SIN"
square = "SQU"
ramp = "RAMP"
pulse = "PULS"
noise = "NOIS"
dc = "DC"
user = "******"
class LoadResistance(Enum):
"""
Enum containing valid load resistance for the Agilent/Keysight 33220a
"""
minimum = "MIN"
maximum = "MAX"
high_impedance = "INF"
class OutputPolarity(Enum):
"""
Enum containg valid output polarity modes for the
Agilent/Keysight 33220a
"""
normal = "NORM"
inverted = "INV"
# PROPERTIES #
function = enum_property(
command="FUNC",
enum=Function,
doc="""
Gets/sets the output function of the function generator
:type: `Agilent33220a.Function`
""",
set_fmt="{}:{}"
)
duty_cycle = int_property(
command="FUNC:SQU:DCYC",
doc="""
Gets/sets the duty cycle of a square wave.
Duty cycle represents the amount of time that the square wave is at a
high level.
:type: `int`
""",
valid_set=range(101)
)
ramp_symmetry = int_property(
command="FUNC:RAMP:SYMM",
doc="""
Gets/sets the ramp symmetry for ramp waves.
Symmetry represents the amount of time per cycle that the ramp wave is
rising (unless polarity is inverted).
:type: `int`
""",
valid_set=range(101)
)
output = bool_property(
command="OUTP",
inst_true="ON",
inst_false="OFF",
doc="""
Gets/sets the output enable status of the front panel output connector.
The value `True` corresponds to the output being on, while `False` is
the output being off.
:type: `bool`
"""
)
output_sync = bool_property(
command="OUTP:SYNC",
inst_true="ON",
inst_false="OFF",
doc="""
Gets/sets the enabled status of the front panel sync connector.
:type: `bool`
"""
)
output_polarity = enum_property(
command="OUTP:POL",
enum=OutputPolarity,
doc="""
Gets/sets the polarity of the waveform relative to the offset voltage.
:type: `~Agilent33220a.OutputPolarity`
"""
)
@property
def load_resistance(self):
"""
Gets/sets the desired output termination load (ie, the impedance of the
load attached to the front panel output connector).
The instrument has a fixed series output impedance of 50ohms. This
function allows the instrument to compensate of the voltage divider
and accurately report the voltage across the attached load.
:units: As specified (if a `~quantities.quantity.Quantity`) or assumed
to be of units :math:`\\Omega` (ohm).
:type: `~quantities.quantity.Quantity` or `Agilent33220a.LoadResistance`
"""
value = self.query("OUTP:LOAD?")
try:
return int(value) * u.ohm
except ValueError:
return self.LoadResistance(value.strip())
@load_resistance.setter
def load_resistance(self, newval):
if isinstance(newval, self.LoadResistance):
newval = newval.value
else:
newval = assume_units(newval, u.ohm).rescale(u.ohm).magnitude
if (newval < 0) or (newval > 10000):
raise ValueError(
"Load resistance must be between 0 and 10,000")
self.sendcmd("OUTP:LOAD {}".format(newval))
@property
def phase(self):
raise NotImplementedError
@phase.setter
def phase(self, newval):
raise NotImplementedError
class TekDPO70000(SCPIInstrument, Oscilloscope):
"""
The Tektronix DPO70000 series is a multi-channel oscilloscope with analog
bandwidths ranging up to 33GHz.
This class inherits from `~instruments.generic_scpi.SCPIInstrument`.
Example usage:
>>> import instruments as ik
>>> tek = ik.tektronix.TekDPO70000.open_tcpip("192.168.0.2", 8888)
>>> [x, y] = tek.channel[0].read_waveform()
"""
# CONSTANTS #
# The number of horizontal and vertical divisions.
HOR_DIVS = 10
VERT_DIVS = 10
# ENUMS #
class AcquisitionMode(Enum):
"""
Enum containing valid acquisition modes for the Tektronix 70000 series
oscilloscopes.
"""
sample = "SAM"
peak_detect = "PEAK"
hi_res = "HIR"
average = "AVE"
waveform_db = "WFMDB"
envelope = "ENV"
class AcquisitionState(Enum):
"""
Enum containing valid acquisition states for the Tektronix 70000 series
oscilloscopes.
"""
on = 'ON'
off = 'OFF'
run = 'RUN'
stop = 'STOP'
class StopAfter(Enum):
"""
Enum containing valid stop condition modes for the Tektronix 70000
series oscilloscopes.
"""
run_stop = 'RUNST'
sequence = 'SEQ'
class SamplingMode(Enum):
"""
Enum containing valid sampling modes for the Tektronix 70000
series oscilloscopes.
"""
real_time = "RT"
equivalent_time_allowed = "ET"
interpolation_allowed = "IT"
class HorizontalMode(Enum):
"""
Enum containing valid horizontal scan modes for the Tektronix 70000
series oscilloscopes.
"""
auto = "AUTO"
constant = "CONST"
manual = "MAN"
class WaveformEncoding(Enum):
"""
Enum containing valid waveform encoding modes for the Tektronix 70000
series oscilloscopes.
"""
# NOTE: For some reason, it uses the full names here instead of
# returning the mneonics listed in the manual.
ascii = "ASCII"
binary = "BINARY"
class BinaryFormat(Enum):
"""
Enum containing valid binary formats for the Tektronix 70000
series oscilloscopes (int, unsigned-int, floating-point).
"""
int = "RI"
uint = "RP"
float = "FP" # Single-precision!
class ByteOrder(Enum):
"""
Enum containing valid byte order (big-/little-endian) for the
Tektronix 70000 series oscilloscopes.
"""
little_endian = "LSB"
big_endian = "MSB"
class TriggerState(Enum):
"""
Enum containing valid trigger states for the Tektronix 70000
series oscilloscopes.
"""
armed = "ARMED"
auto = "AUTO"
dpo = "DPO"
partial = "PARTIAL"
ready = "READY"
# STATIC METHODS #
@staticmethod
def _dtype(binary_format, byte_order, n_bytes):
return "{}{}{}".format({
TekDPO70000.ByteOrder.big_endian: ">",
TekDPO70000.ByteOrder.little_endian: "<"
}[byte_order], {
TekDPO70000.BinaryFormat.int: "i",
TekDPO70000.BinaryFormat.uint: "u",
TekDPO70000.BinaryFormat.float: "f"
}[binary_format], n_bytes)
# CLASSES #
class DataSource(OscilloscopeDataSource):
"""
Class representing a data source (channel, math, or ref) on the
Tektronix DPO 70000.
.. warning:: This class should NOT be manually created by the user. It
is designed to be initialized by the `TekDPO70000` class.
"""
@property
def name(self):
return self._name
@abc.abstractmethod
def _scale_raw_data(self, data):
"""
Takes the int16 data and figures out how to make it unitful.
"""
# pylint: disable=protected-access
def read_waveform(self, bin_format=True):
# We want to get the data back in binary, as it's just too much
# otherwise.
with self:
self._parent.select_fastest_encoding()
n_bytes = self._parent.outgoing_n_bytes
dtype = self._parent._dtype(
self._parent.outgoing_binary_format,
self._parent.outgoing_byte_order, n_bytes)
self._parent.sendcmd("CURV?")
raw = self._parent.binblockread(n_bytes, fmt=dtype)
# Clear the queue by trying to read.
# FIXME: this is a hack-y way of doing so.
if hasattr(self._parent._file, 'flush_input'):
self._parent._file.flush_input()
else:
self._parent._file.read()
return self._scale_raw_data(raw)
def __enter__(self):
self._old_dsrc = self._parent.data_source
if self._old_dsrc != self:
# Set the new data source, and let __exit__ cleanup.
self._parent.data_source = self
else:
# There's nothing to do or undo in this case.
self._old_dsrc = None
def __exit__(self, type, value, traceback):
if self._old_dsrc is not None:
self._parent.data_source = self._old_dsrc
class Math(DataSource):
"""
Class representing a math channel on the Tektronix DPO 70000.
This class inherits from `TekDPO70000.DataSource`.
.. warning:: This class should NOT be manually created by the user. It
is designed to be initialized by the `TekDPO70000` class.
"""
def __init__(self, parent, idx):
self._parent = parent
self._idx = idx + 1 # 1-based.
# Initialize as a data source with name MATH{}.
super(TekDPO70000.Math, self).__init__(parent,
"MATH{}".format(self._idx))
def sendcmd(self, cmd):
"""
Wraps commands sent from property factories in this class with
identifiers for the specified math channel.
:param str cmd: Command to send to the instrument
"""
self._parent.sendcmd("MATH{}:{}".format(self._idx, cmd))
def query(self, cmd, size=-1):
"""
Wraps queries sent from property factories in this class with
identifiers for the specified math channel.
:param str cmd: Query command to send to the instrument
:param int size: Number of characters to read from the response.
Default value reads until a termination character is found.
:return: The query response
:rtype: `str`
"""
return self._parent.query("MATH{}:{}".format(self._idx, cmd), size)
class FilterMode(Enum):
"""
Enum containing valid filter modes for a math channel on the
TekDPO70000 series oscilloscope.
"""
centered = "CENT"
shifted = "SHIF"
class Mag(Enum):
"""
Enum containing valid amplitude units for a math channel on the
TekDPO70000 series oscilloscope.
"""
linear = "LINEA"
db = "DB"
dbm = "DBM"
class Phase(Enum):
"""
Enum containing valid phase units for a math channel on the
TekDPO70000 series oscilloscope.
"""
degrees = "DEG"
radians = "RAD"
group_delay = "GROUPD"
class SpectralWindow(Enum):
"""
Enum containing valid spectral windows for a math channel on the
TekDPO70000 series oscilloscope.
"""
rectangular = "RECTANG"
hamming = "HAMM"
hanning = "HANN"
kaiser_besse = "KAISERB"
blackman_harris = "BLACKMANH"
flattop2 = "FLATTOP2"
gaussian = "GAUSS"
tek_exponential = "TEKEXP"
define = string_property("DEF",
doc="""
A text string specifying the math to do, ex. CH1+CH2
""")
filter_mode = enum_property("FILT:MOD", FilterMode)
filter_risetime = unitful_property("FILT:RIS", u.second)
label = string_property("LAB:NAM",
doc="""
Just a human readable label for the channel.
""")
label_xpos = unitless_property("LAB:XPOS",
doc="""
The x position, in divisions, to place the label.
""")
label_ypos = unitless_property(
"LAB:YPOS",
doc="""The y position, in divisions, to place the label.
""")
num_avg = unitless_property("NUMAV",
doc="""
The number of acquisistions over which exponential averaging is
performed.
""")
spectral_center = unitful_property("SPEC:CENTER",
u.Hz,
doc="""
The desired frequency of the spectral analyzer output data span
in Hz.
""")
spectral_gatepos = unitful_property("SPEC:GATEPOS",
u.second,
doc="""
The gate position. Units are represented in seconds, with respect
to trigger position.
""")
spectral_gatewidth = unitful_property("SPEC:GATEWIDTH",
u.second,
doc="""
The time across the 10-division screen in seconds.
""")
spectral_lock = bool_property("SPEC:LOCK",
inst_true="ON",
inst_false="OFF")
spectral_mag = unitful_property("SPEC:MAG",
Mag,
doc="""
Whether the spectral magnitude is linear, db, or dbm.
""")
spectral_phase = unitful_property("SPEC:PHASE",
Mag,
doc="""
Whether the spectral phase is degrees, radians, or group delay.
""")
spectral_reflevel = unitless_property("SPEC:REFL",
doc="""
The value that represents the topmost display screen graticule.
The units depend on spectral_mag.
""")
spectral_reflevel_offset = unitless_property("SPEC:REFLEVELO")
spectral_resolution_bandwidth = unitful_property("SPEC:RESB",
u.Hz,
doc="""
The desired resolution bandwidth value. Units are represented in
Hertz.
""")
spectral_span = unitful_property("SPEC:SPAN",
u.Hz,
doc="""
Specifies the frequency span of the output data vector from the
spectral analyzer.
""")
spectral_suppress = unitless_property("SPEC:SUPP",
doc="""
The magnitude level that data with magnitude values below this
value are displayed as zero phase.
""")
spectral_unwrap = bool_property("SPEC:UNWR",
inst_true="ON",
inst_false="OFF",
doc="""
Enables or disables phase wrapping.
""")
spectral_window = enum_property("SPEC:WIN", SpectralWindow)
threshhold = unitful_property("THRESH",
u.volt,
doc="""
The math threshhold in volts
""")
unit_string = string_property("UNITS",
doc="""
Just a label for the units...doesn"t actually change anything.
""")
autoscale = bool_property("VERT:AUTOSC",
inst_true="ON",
inst_false="OFF",
doc="""
Enables or disables the auto-scaling of new math waveforms.
""")
position = unitless_property("VERT:POS",
doc="""
The vertical position, in divisions from the center graticule.
""")
scale = unitful_property("VERT:SCALE",
u.volt,
doc="""
The scale in volts per division. The range is from
``100e-36`` to ``100e+36``.
""")
def _scale_raw_data(self, data):
# TODO: incorperate the unit_string somehow
return self.scale * (
(TekDPO70000.VERT_DIVS / 2) * data.astype(float) /
(2**15) - self.position)
class Channel(DataSource, OscilloscopeChannel):
"""
Class representing a channel on the Tektronix DPO 70000.
This class inherits from `TekDPO70000.DataSource`.
.. warning:: This class should NOT be manually created by the user. It
is designed to be initialized by the `TekDPO70000` class.
"""
def __init__(self, parent, idx):
self._parent = parent
self._idx = idx + 1 # 1-based.
# Initialize as a data source with name CH{}.
super(TekDPO70000.Channel, self).__init__(self._parent,
"CH{}".format(self._idx))
def sendcmd(self, cmd):
"""
Wraps commands sent from property factories in this class with
identifiers for the specified channel.
:param str cmd: Command to send to the instrument
"""
self._parent.sendcmd("CH{}:{}".format(self._idx, cmd))
def query(self, cmd, size=-1):
"""
Wraps queries sent from property factories in this class with
identifiers for the specified channel.
:param str cmd: Query command to send to the instrument
:param int size: Number of characters to read from the response.
Default value reads until a termination character is found.
:return: The query response
:rtype: `str`
"""
return self._parent.query("CH{}:{}".format(self._idx, cmd), size)
class Coupling(Enum):
"""
Enum containing valid coupling modes for the oscilloscope channel
"""
ac = "AC"
dc = "DC"
dc_reject = "DCREJ"
ground = "GND"
coupling = enum_property("COUP",
Coupling,
doc="""
Gets/sets the coupling for the specified channel.
Example usage:
>>> import instruments as ik
>>> inst = ik.tektronix.TekDPO70000.open_tcpip("192.168.0.1", 8080)
>>> channel = inst.channel[0]
>>> channel.coupling = channel.Coupling.ac
""")
bandwidth = unitful_property('BAN', u.Hz)
deskew = unitful_property('DESK', u.second)
termination = unitful_property('TERM', u.ohm)
label = string_property('LAB:NAM',
doc="""
Just a human readable label for the channel.
""")
label_xpos = unitless_property('LAB:XPOS',
doc="""
The x position, in divisions, to place the label.
""")
label_ypos = unitless_property('LAB:YPOS',
doc="""
The y position, in divisions, to place the label.
""")
offset = unitful_property('OFFS',
u.volt,
doc="""
The vertical offset in units of volts. Voltage is given by
``offset+scale*(5*raw/2^15 - position)``.
""")
position = unitless_property('POS',
doc="""
The vertical position, in divisions from the center graticule,
ranging from ``-8`` to ``8``. Voltage is given by
``offset+scale*(5*raw/2^15 - position)``.
""")
scale = unitful_property('SCALE',
u.volt,
doc="""
Vertical channel scale in units volts/division. Voltage is given
by ``offset+scale*(5*raw/2^15 - position)``.
""")
def _scale_raw_data(self, data):
return self.scale * (
(TekDPO70000.VERT_DIVS / 2) * data.astype(float) /
(2**15) - self.position) + self.offset
# PROPERTIES ##
@property
def channel(self):
return ProxyList(self, self.Channel, range(4))
@property
def math(self):
return ProxyList(self, self.Math, range(4))
@property
def ref(self):
raise NotImplementedError
# For some settings that probably won't be used that often, use
# string_property instead of setting up an enum property.
acquire_enhanced_enob = string_property('ACQ:ENHANCEDE',
bookmark_symbol='',
doc="""
Valid values are AUTO and OFF.
""")
acquire_enhanced_state = bool_property(
'ACQ:ENHANCEDE:STATE',
inst_false='0', # TODO: double check that these are correct
inst_true='1')
acquire_interp_8bit = string_property('ACQ:INTERPE',
bookmark_symbol='',
doc="""
Valid values are AUTO, ON and OFF.
""")
acquire_magnivu = bool_property('ACQ:MAG',
inst_true='ON',
inst_false='OFF')
acquire_mode = enum_property('ACQ:MOD', AcquisitionMode)
acquire_mode_actual = enum_property('ACQ:MOD:ACT',
AcquisitionMode,
readonly=True)
acquire_num_acquisitions = int_property('ACQ:NUMAC',
readonly=True,
doc="""
The number of waveform acquisitions that have occurred since starting
acquisition with the ACQuire:STATE RUN command
""")
acquire_num_avgs = int_property('ACQ:NUMAV',
doc="""
The number of waveform acquisitions to average.
""")
acquire_num_envelop = int_property('ACQ:NUME',
doc="""
The number of waveform acquisitions to be enveloped
""")
acquire_num_frames = int_property('ACQ:NUMFRAMESACQ',
readonly=True,
doc="""
The number of frames acquired when in FastFrame Single Sequence and
acquisitions are running.
""")
acquire_num_samples = int_property('ACQ:NUMSAM',
doc="""
The minimum number of acquired samples that make up a waveform
database (WfmDB) waveform for single sequence mode and Mask Pass/Fail
Completion Test. The default value is 16,000 samples. The range is
5,000 to 2,147,400,000 samples.
""")
acquire_sampling_mode = enum_property('ACQ:SAMP', SamplingMode)
acquire_state = enum_property('ACQ:STATE',
AcquisitionState,
doc="""
This command starts or stops acquisitions.
""")
acquire_stop_after = enum_property('ACQ:STOPA',
StopAfter,
doc="""
This command sets or queries whether the instrument continually
acquires acquisitions or acquires a single sequence.
""")
data_framestart = int_property('DAT:FRAMESTAR')
data_framestop = int_property('DAT:FRAMESTOP')
data_start = int_property('DAT:STAR',
doc="""
The first data point that will be transferred, which ranges from 1 to
the record length.
""")
# TODO: Look into the following troublesome datasheet note: "When using the
# CURVe command, DATa:STOP is ignored and WFMInpre:NR_Pt is used."
data_stop = int_property('DAT:STOP',
doc="""
The last data point that will be transferred.
""")
data_sync_sources = bool_property('DAT:SYNCSOU',
inst_true='ON',
inst_false='OFF')
@property
def data_source(self):
"""
Gets/sets the data source for the oscilloscope. This will return
the actual Channel/Math/DataSource object as if it was accessed
through the usual `TekDPO70000.channel`, `TekDPO70000.math`, or
`TekDPO70000.ref` properties.
:type: `TekDPO70000.Channel` or `TekDPO70000.Math`
"""
val = self.query('DAT:SOU?')
if val[0:2] == 'CH':
out = self.channel[int(val[2]) - 1]
elif val[0:2] == 'MA':
out = self.math[int(val[4]) - 1]
elif val[0:2] == 'RE':
out = self.ref[int(val[3]) - 1]
else:
raise NotImplementedError
return out
@data_source.setter
def data_source(self, newval):
if not isinstance(newval, self.DataSource):
raise TypeError("{} is not a valid data source.".format(
type(newval)))
self.sendcmd("DAT:SOU {}".format(newval.name))
# Some Tek scopes require this after the DAT:SOU command, or else
# they will stop responding.
if not self._testing:
time.sleep(0.02)
horiz_acq_duration = unitful_property('HOR:ACQDURATION',
u.second,
readonly=True,
doc="""
The duration of the acquisition.
""")
horiz_acq_length = int_property('HOR:ACQLENGTH',
readonly=True,
doc="""
The record length.
""")
horiz_delay_mode = bool_property('HOR:DEL:MOD',
inst_true='1',
inst_false='0')
horiz_delay_pos = unitful_property('HOR:DEL:POS',
u.percent,
doc="""
The percentage of the waveform that is displayed left of the center
graticule.
""")
horiz_delay_time = unitful_property('HOR:DEL:TIM',
u.second,
doc="""
The base trigger delay time setting.
""")
horiz_interp_ratio = unitless_property('HOR:MAI:INTERPR',
readonly=True,
doc="""
The ratio of interpolated points to measured points.
""")
horiz_main_pos = unitful_property('HOR:MAI:POS',
u.percent,
doc="""
The percentage of the waveform that is displayed left of the center
graticule.
""")
horiz_unit = string_property('HOR:MAI:UNI')
horiz_mode = enum_property('HOR:MODE', HorizontalMode)
horiz_record_length_lim = int_property('HOR:MODE:AUTO:LIMIT',
doc="""
The recond length limit in samples.
""")
horiz_record_length = int_property('HOR:MODE:RECO',
doc="""
The recond length in samples. See `horiz_mode`; manual mode lets you
change the record length, while the length is readonly for auto and
constant mode.
""")
horiz_sample_rate = unitful_property('HOR:MODE:SAMPLER',
u.Hz,
doc="""
The sample rate in samples per second.
""")
horiz_scale = unitful_property('HOR:MODE:SCA',
u.second,
doc="""
The horizontal scale in seconds per division. The horizontal scale is
readonly when `horiz_mode` is manual.
""")
horiz_pos = unitful_property('HOR:POS',
u.percent,
doc="""
The position of the trigger point on the screen, left is 0%, right
is 100%.
""")
horiz_roll = string_property('HOR:ROLL',
bookmark_symbol='',
doc="""
Valid arguments are AUTO, OFF, and ON.
""")
trigger_state = enum_property('TRIG:STATE', TriggerState)
# Waveform Transfer Properties
outgoing_waveform_encoding = enum_property('WFMO:ENC',
WaveformEncoding,
doc="""
Controls the encoding used for outgoing waveforms (instrument → host).
""")
outgoing_binary_format = enum_property("WFMO:BN_F",
BinaryFormat,
doc="""
Controls the data type of samples when transferring waveforms from
the instrument to the host using binary encoding.
""")
outgoing_byte_order = enum_property("WFMO:BYT_O",
ByteOrder,
doc="""
Controls whether binary data is returned in little or big endian.
""")
outgoing_n_bytes = int_property("WFMO:BYT_N",
valid_set=set((1, 2, 4, 8)),
doc="""
The number of bytes per sample used in representing outgoing
waveforms in binary encodings.
Must be either 1, 2, 4 or 8.
""")
# METHODS #
def select_fastest_encoding(self):
"""
Sets the encoding for data returned by this instrument to be the
fastest encoding method consistent with the current data source.
"""
self.sendcmd("DAT:ENC FAS")
def force_trigger(self):
"""
Forces a trigger event to happen for the oscilloscope.
"""
self.sendcmd('TRIG FORC')
# TODO: consider moving the next few methods to Oscilloscope.
def run(self):
"""
Enables the trigger for the oscilloscope.
"""
self.sendcmd(":RUN")
def stop(self):
"""
Disables the trigger for the oscilloscope.
"""
self.sendcmd(":STOP")
class PicowattAVS47(SCPIInstrument):
"""
The Picowatt AVS 47 is a resistance bridge used to measure the resistance
of low-temperature sensors.
Example usage:
>>> import instruments as ik
>>> bridge = ik.picowatt.PicowattAVS47.open_gpibusb('/dev/ttyUSB0', 1)
>>> print bridge.sensor[0].resistance
"""
def __init__(self, filelike):
super(PicowattAVS47, self).__init__(filelike)
self.sendcmd("HDR 0") # Disables response headers from replies
# INNER CLASSES #
class Sensor:
"""
Class representing a sensor on the PicowattAVS47
.. warning:: This class should NOT be manually created by the user. It is
designed to be initialized by the `PicowattAVS47` class.
"""
def __init__(self, parent, idx):
self._parent = parent
self._idx = idx # The AVS47 is actually zero-based indexing! Wow!
@property
def resistance(self):
"""
Gets the resistance. It first ensures that the next measurement
reading is up to date by first sending the "ADC" command.
:units: :math:`\\Omega` (ohms)
:rtype: `~quantities.Quantity`
"""
# First make sure the mux is on the correct channel
if self._parent.mux_channel != self._idx:
self._parent.input_source = self._parent.InputSource.ground
self._parent.mux_channel = self._idx
self._parent.input_source = self._parent.InputSource.actual
# Next, prep a measurement with the ADC command
self._parent.sendcmd("ADC")
return float(self._parent.query("RES?")) * u.ohm
# ENUMS #
class InputSource(IntEnum):
"""
Enum containing valid input source modes for the AVS 47
"""
ground = 0
actual = 1
reference = 2
# PROPERTIES #
@property
def sensor(self):
"""
Gets a specific sensor object. The desired sensor is specified like
one would access a list.
:rtype: `~PicowattAVS47.Sensor`
.. seealso::
`PicowattAVS47` for an example using this property.
"""
return ProxyList(self, PicowattAVS47.Sensor, range(8))
remote = bool_property(
command="REM",
inst_true="1",
inst_false="0",
doc="""
Gets/sets the remote mode state.
Enabling the remote mode allows all settings to be changed by computer
interface and locks-out the front panel.
:type: `bool`
"""
)
input_source = enum_property(
command="INP",
enum=InputSource,
input_decoration=int,
doc="""
Gets/sets the input source.
:type: `PicowattAVS47.InputSource`
"""
)
mux_channel = int_property(
command="MUX",
doc="""
Gets/sets the multiplexer sensor number.
It is recommended that you ground the input before switching the
multiplexer channel.
Valid mux channel values are 0 through 7 (inclusive).
:type: `int`
""",
valid_set=range(8)
)
excitation = int_property(
command="EXC",
doc="""
Gets/sets the excitation sensor number.
Valid excitation sensor values are 0 through 7 (inclusive).
:type: `int`
""",
valid_set=range(8)
)
display = int_property(
command="DIS",
doc="""
Gets/sets the sensor that is displayed on the front panel.
Valid display sensor values are 0 through 7 (inclusive).
:type: `int`
""",
valid_set=range(8)
)