pylablib.devices.Agilent package

Submodules

pylablib.devices.Agilent.base module

exception pylablib.devices.Agilent.base.AgilentError

Bases: DeviceError

Generic Agilent device error

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception pylablib.devices.Agilent.base.AgilentBackendError(exc)

Bases: AgilentError, DeviceBackendError

Generic Agilent backend communication error

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

pylablib.devices.Agilent.pressure module

class pylablib.devices.Agilent.pressure.TXGS600DeviceInfo(main_board_rev, boards_rev)

Bases: tuple

boards_rev

main_board_rev

class pylablib.devices.Agilent.pressure.XGS600(conn, addr=0)

Bases: ICommBackendWrapper

Agilent XGS-600 pressure gauge controller.

Parameters:

• conn – serial connection parameters (usually port or a tuple containing port and baudrate)

• addr – device address if RS485 communication is used (for RS232 must be kept 0)

Error

alias of AgilentError

query(comm, arg='')

Send the command (with an optional arguments) to the device and return the result

get_device_info()

Get device info as a tuple (main_board_rev, boards_rev)

list_boards()

Return a list of the board types installed.

The type can be "HFIG", "IMG", "CNV", "analog", or "none".

get_units()

Get device units for indication/reading ("mbar", "torr", or "pa")

set_units(units)

Set device units for indication/reading ("mbar", "torr", or "pa")

to_Pa(value, units=None)

Convert value in the given units to Pa.

If units is None, use the current display units.

from_Pa(value, units=None)

Convert value in the given units from Pa.

If units is None, use the current display units.

get_all_pressures(display_units=False)

Get pressures of all available gauges as a list.

Includes pressures from all the connected cards from left to right (front view). If the gauge is not connected, the value is "nocbl".

apply_settings(settings)

Apply the settings.

settings is the dict {name: value} of the device available settings. Non-applicable settings are ignored.

close()

Close the backend

get_device_variable(key)

Get the value of a settings, status, or full info parameter

get_full_info(include=0)

Get dict {name: value} containing full device information (including status and settings).

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

get_full_status(include=0)

Get dict {name: value} containing the device status (including settings).

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

get_settings(include=0)

Get dict {name: value} containing all the device settings.

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

is_opened()

Check if the device is connected

lock(timeout=None)

Lock the access to the device from other threads/processes (isn’t necessarily implemented)

locking(timeout=None)

Context manager for lock & unlock

open()

Open the backend

set_device_variable(key, value)

Set the value of a settings parameter

unlock()

Unlock the access to the device from other threads/processes (isn’t necessarily implemented)

pylablib.devices.Agilent.vna module

class pylablib.devices.Agilent.vna.AgilentE5071C(addr)

Bases: SCPIDevice

Agilent E5071C vector network analyzer.

Parameters:

addr – device address; usually a VISA address string such as "USB0::0x0957::0x0D09::MY00000000::0::INSTR"

Error

alias of AgilentError

ReraiseError

alias of AgilentBackendError

get_sens_channel()

Return the current default sens channel

set_sens_channel(channel=1)

Set the default sens channel

get_source_channel()

Return the current default source channel

set_source_channel(channel=1)

Set the default source channel

is_output_enabled()

Check if the output is enabled

enable_output(enable=True)

Enable or disable the output

get_output_level(channel=None)

Get the power level the the given source channel (in dB)

set_output_level(level, channel=None)

Set the power level the the given source channel (in dB)

get_bandwidth(channel=None)

Get the IF bandwidth at the given channel

set_bandwidth(bandwidth, channel=None)

Set the IF bandwidth at the given channel

get_averaging_parameters(channel=None)

Get the averaging parameters (enabled, number)

setup_averaging(enabled=None, number=None, channel=None)

Set up whether the averaging is enabled and the number of traces to average

reset_averaging(channel=None)

Reset averaging at the given channel

get_frequency_range(channel=None)

Get current sweep frequency range

set_frequency_range(rng, channel=None)

Set the current frequency range

get_trace_format()

Return trace data format as a tuple (data_format, data_border)

set_trace_format(data_format=None, data_border=None)

Set trace data format and byte order.

data_format can be "ascii", "float64", or "float32", and data_border can be "normal" or "swapped"

read_frequency_trace(fmt=None, channel=None)

Get the frequency trace for the given channel

read_S_parameters(param=('S11', 'S12', 'S21', 'S22'), add_frequency=False, fmt=None, channel=None)

Get the S parameters trace for the given channel.

param can be either a single string specifying the parameters (e.g., "S12"), or a tuple or list of strings. add_frequency specifies whether the frequency axis should be added to the result. If raw==True, return the raw (un-corrected) parameters; otherwise, return corrected parameters.

If add_frequency==False, return a single 1D complex array for the single channel, or a multi-column complex array for several channels. If add_frequency==True, return a multi-column array, where the first column is the frequency, and the rest are the parameters.

BackendError

alias of DeviceBackendError

apply_settings(settings)

Apply the settings.

settings is a dict {name: value} of the available device settings. Non-applicable settings are ignored.

ask(msg, data_type='string', delay=0.0, timeout=None, read_echo=False)

Write a message and read a reply.

msg is the query message, delay is the delay between write and read. Other parameters are the same as in read(). If read_echo==True, assume that the device first echoes the input and skip it.

close()

Close the backend

flush(one_line=False)

Flush the read buffer (read all the available data and return the number of bytes read).

If one_line==True, read only a single line.

static get_arg_type(arg)

Autodetect argument type

get_device_variable(key)

Get the value of a settings, status, or full info parameter

get_esr(timeout=None)

Get the device status register (by default, "*ESR?" command)

get_full_info(include=0)

Get dict {name: value} containing full device information (including status and settings).

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

get_full_status(include=0)

Get dict {name: value} containing the device status (including settings).

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

get_id(timeout=None)

Get the device IDN. (query SCPI '*IDN?' command)

get_settings(include=0)

Get dict {name: value} containing all the device settings.

include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or "all" (all available variables). Since the lowest priority is -10, setting include=-10 queries all available variables, which is equivalent to include="all".

is_opened()

Check if the device is connected

lock(timeout=None)

Lock the access to the device from other threads/processes (isn’t necessarily implemented)

locking(timeout=None)

Context manager for lock & unlock

open()

Open the backend

static parse_array_data(data, fmt, include_header=False)

Parse the data returned by the device. fmt is DataFormat description in numpy format (e.g., "<u2").

If include_header==True, the data is assumed to be in a (somewhat) standard SCPI format: b'#', then a single digit s denoting length of the size block, then s digits denoting length of the data (in bytes) followed by the actual data. Otherwise (include_header==False), assume that the header is already removed.

read(data_type='string', timeout=None)

Read data from the device.

data_type determines the type of the data. Can be 'raw' (just raw data), 'string' (with trailing and leading spaces stripped), 'int', 'float', 'bool' (interprets 0 or 'off' as False, anything else as True), 'value' (returns tuple (value, unit), where value is float), a callable (return the result of this callable applied to the string value), a dictionary (return the stored value corresponding to the string value, or to the value converted into integer if the string value is not present), or a list of data types (the result is treated as a list of values with the given types separated by commas). timeout overrides the default value.

read_binary_array_data(include_header=False, timeout=None, flush_term=True)

Read a binary data in the from the device.

The data assumes the standard binary transfer header consisting of "#" symbol, then a single digit with the size of the length string, then the length string containing the length of the binary data (in bytes). If include_header==True, return the data with the header; otherwise, return only the content. If flush_term==True, flush the following line to skip terminator characters after the binary data, which are added by some devices. timeout overrides the default value.

reconnect(new_instrument=True, ignore_error=True)

Remake the connection.

If new_instrument==True, create a new backend instance. If ignore_error==True, ignore errors on closing.

reset()

Reset the device (by default, "*RST" command)

set_device_variable(key, value)

Set the value of a settings parameter

sleep(delay)

Wait for delay seconds

unlock()

Unlock the access to the device from other threads/processes (isn’t necessarily implemented)

using_write_buffer()

Context manager for using a write buffer.

While it’s active, all the consecutive write() operations are bundled together with ; delimiter. The actual write is performed at the read()/ask() operation or at the end of the block.

wait(wait_type='sync', timeout=None, wait_callback=None)

Pause execution until device overlapped commands are complete.

wait_type is either 'sync' (perform wait_sync()), 'dev' (perform wait_dev()) or 'none' (do nothing).

wait_dev()

Pause execution of the device commands until device overlapped commands (e.g., taking sweeps) are complete.

Note that the code execution is not paused.

wait_sync(timeout=None, wait_callback=None)

Pause execution of the script until device overlapped commands (e.g., taking sweeps) are complete.

timeout and wait_callback override default constructor parameters.

write(msg, arg=None, arg_type=None, unit=None, bool_selector=None, wait_sync=None, read_echo=False, read_echo_delay=0.0)

Send a command.

Parameters:

• msg (str) – Text message.

• arg – Optional argument to append in the end. If a list of arguments is supplied, the result is joined with ",".

• arg_type (str) – Argument type. Can be 'raw' (in which case data is sent raw), 'string', 'int', 'float', 'bool', a format string (such as '{:.3f}') or a list of argument types (for an iterable argument); if format string is used and the argument is a list or a tuple, then it is expanded as a list of arguments (e.g., arg_type='{0};{1}' with arg=[1,2] will produce a string '1;2'); if a list of types is used, each element of arg is converted using the corresponding type, and the result is joined with ",".

• unit (str) – If not None, use it as a unit to append after the value.

• bool_selector (tuple) – A tuple (false_value, true_value) of two strings to represent bool argument; by default, use ._bool_selector attribute.

• wait_sync – if True, append the sync command (specified as ._wait_sync_comm attribute, "*OPC?" by default) after the message and pause the execution command is complete; useful in long set operations, where the device might ignore later inputs until the current command is complete; if None, use the class default ._default_write_sync attribute (False by default).

• read_echo (bool) – If True, read a single line after write.

• read_echo_delay (float) – The delay between write and read if read_echo==True.

Module contents