pylablib.devices.AmericanMagnetics package

Submodules

pylablib.devices.AmericanMagnetics.base module

exception pylablib.devices.AmericanMagnetics.base.AmericanMagneticsError

Bases: DeviceError

Generic American Magnetics devices 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.AmericanMagnetics.base.AmericanMagneticsBackendError(exc)

Bases: AmericanMagneticsError, DeviceBackendError

Generic American Magnetics 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.

class pylablib.devices.AmericanMagnetics.base.AM1700(conn)

Bases: SCPIDevice

American Magnetics 1700 level monitor.

Parameters:

conn – connection parameters; usually port or a tuple containing port and baudrate for serial connection, or a network/IP address and port (if not specified, use default 7180 port) for Ethernet connection

Error

alias of AmericanMagneticsError

ReraiseError

alias of AmericanMagneticsBackendError

get_default_channel()

Get the default channel ("He", "LN", or None if no connected channel is found)

get_connected_channels()

Get all connected channels

get_channel_configuration(channel=None)

Get the sensor configuration for the given channel ("He" or "LN"); "none" means that the channel is not connected

get_unit(channel=None)

Get default units ("perc", "in", or "cm") on the given channel ("He" or "LN")

set_unit(unit='perc', channel=None)

Set default units ("perc", "in", or "cm") on the given channel ("He" or "LN")

get_level(channel=None, unit='perc')

Get level reading on a given channel

get_refill_channel()

Get channel for autofill control ("He", "N2", or "none" if disabled)

set_refill_channel(channel)

Set channel for autofill control ("He", "N2", or "none" if disabled)

get_low_level()

Get low level (automated refill start) setting in the current units

set_low_level(level)

Set low level (automated refill start) setting in the current units

get_high_level()

Get high level (automated refill stop) setting in the current units

set_high_level(level)

Set high level (automated refill stop) setting in the current units

get_relay_channel(relay)

Get channel for relay (1 or 2) control ("He", "N2", or "none" if disabled)

set_relay_channel(relay, channel)

Set channel for for relay (1 or 2) control ("He", "N2", or "none" if disabled)

get_relay_level(relay)

Get trigger level setting for a given relay (1 or 2) in the current units

set_relay_level(relay, level)

Set trigger level setting for a given relay (1 or 2) in the current units

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_relay_mode(relay)

Get trigger level setting for a given relay (1 or 2)

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.

set_relay_mode(relay, mode)

Set trigger level setting for a given relay (1 or 2)

Module contents