fluidlab.instruments.features

Features for defining drivers (fluidlab.instruments.features)

Todo

Work on the documentation of fluidlab.instruments.features.

Provides:

class fluidlab.instruments.features.Feature(name, doc='')

class fluidlab.instruments.features.WriteCommand(name, doc='', command_str='')

_build_driver_class(Driver)

Add a “write function” to the driver class

class fluidlab.instruments.features.QueryCommand(name, doc='', command_str='', parse_result=None)

_build_driver_class(Driver)

Add a “query function” to the driver class

class fluidlab.instruments.features.Value(name, doc='', command_set=None, command_get=None, check_instrument_value=True, pause_instrument=0.0, channel_argument=False, possible_values=None, possible_channels=None, default_channel=0)

get(channel=None)

Get the value from the instrument. Optional argument ‘channel’ is used for multichannel instrument. Then command_get should include ‘{channel:}’

set(value, channel=None)

Set the value in the instrument. Optional argument ‘channel’ is used for multichannel instrument. Then command_set argument should include ‘{channel:}’ and ‘{value:}’

class fluidlab.instruments.features.BoolValue(name, doc='', command_set=None, command_get=None, check_instrument_value=True, pause_instrument=0.0, channel_argument=False, true_string='1', false_string='0', possible_channels=None, default_channel=0)

class fluidlab.instruments.features.StringValue(name, doc='', command_set=None, command_get=None, valid_values=None, check_instrument_value=True, pause_instrument=0.0, channel_argument=False, possible_values=None, possible_channels=None, default_channel=0)

class fluidlab.instruments.features.NumberValue(name, doc='', command_set=None, command_get=None, limits=None, check_instrument_value=True, pause_instrument=0.0, channel_argument=False, possible_values=None, possible_channels=None, default_channel=0)

class fluidlab.instruments.features.IntValue(name, doc='', command_set=None, command_get=None, limits=None, check_instrument_value=True, pause_instrument=0.0, channel_argument=False, possible_values=None, possible_channels=None, default_channel=0)

class fluidlab.instruments.features.FloatValue(name, doc='', command_set=None, command_get=None, limits=None, check_instrument_value=True, pause_instrument=0.0, channel_argument=False, possible_values=None, possible_channels=None, default_channel=0)

class fluidlab.instruments.features.RegisterValue(name, doc='', command_set=None, command_get=None, keys=None, default_value=0, check_instrument_value=True, pause_instrument=0.0, channel_argument=False, possible_values=None, possible_channels=None, default_channel=0)

get_as_number()

Get the register as number.

get()

Get the register as dictionary.

set(value)

Set the register.

Parameters:

value{dict, int}

The value as a dictionnary or an integer.

Functions

custom_formatwarning(message, category, ...)

Classes

BoolValue(name[, doc, command_set, ...])
DecimalInt16Value(name[, doc, address, ...])
Feature(name[, doc])
Float32Value(name[, doc, command_set, ...])
FloatScientificValue(name[, doc, ...])
FloatValue(name[, doc, command_set, ...])
Int16StringValue(name[, doc, int_dict, adress])
Int16Value(name[, doc, command_set, ...])
IntValue(name[, doc, command_set, ...])
NumberValue(name[, doc, command_set, ...])
QueryCommand(name[, doc, command_str, ...])
ReadOnlyBoolValue(name[, doc, command_set, ...])
ReadOnlyFloat32Value(name[, doc, ...])
ReadOnlyInt16Value(name[, doc, command_set, ...])
RegisterValue(name[, doc, command_set, ...])
StringValue(name[, doc, command_set, ...])
SuperValue(name[, doc])
Value(name[, doc, command_set, command_get, ...])
WriteCommand(name[, doc, command_str])