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='')[source]

Bases: object

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

Bases: fluidlab.instruments.features.Feature

_build_driver_class(Driver)[source]

Add a “write function” to the driver class

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

Bases: fluidlab.instruments.features.Feature

_build_driver_class(Driver)[source]

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)[source]

Bases: fluidlab.instruments.features.SuperValue

get(channel=0)[source]

Get the value from the instrument. Optional argument ‘channel’ is used for multichannel instrument. Then command_get should include ‘%d’

set(value, channel=0)[source]

Set the value in the instrument. Optional argument ‘channel’ is used for multichannel instrument. Then command_set argument should include ‘%d’

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')[source]

Bases: fluidlab.instruments.features.Value

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)[source]

Bases: fluidlab.instruments.features.Value

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)[source]

Bases: fluidlab.instruments.features.Value

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)[source]

Bases: fluidlab.instruments.features.NumberValue

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)[source]

Bases: fluidlab.instruments.features.NumberValue

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)[source]

Bases: fluidlab.instruments.features.NumberValue

get_as_number()[source]

Get the register as number.

get()[source]

Get the register as dictionary.

set(value)[source]

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, …])
Feature(name[, doc])
FloatValue(name[, doc, command_set, …])
IntValue(name[, doc, command_set, …])
NumberValue(name[, doc, command_set, …])
QueryCommand(name[, doc, command_str, …])
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])