pylab_ml.base_instrument.GeneralVisa

class GeneralVisa(**kwargs)

Bases: Instrument

Interface to any Visa Instrument.

The GeneralVisa baseclass can connect to Visa usbserial & gpib instruments Very limited capabilities, but general purpose for low level access to inst Use this class to debug an instrument.inst, note there is no init()

Initialization arguments:

addrint or str

Interface address

interfaceInterface

GPIB, USBSerial

backendstr

VISA backend is either ‘@ivi’ (or ‘@ni’) for NI-Library or ‘@py’ for pure python pyvisa-py backend. On default it uses ‘@ivi’ (or ‘@ni’) on win32 and ‘@py’ on other platforms.

Example: Initialization

>>> instrument = GeneralVisa(addr=24)       # GPIB or USB address

close()

terminate interface

inst.write('*RST')

write direct to instrument

ask=inst.query('

READ?’) write and read the answer

Properties:

id

Get IDN string

__init__(**kwargs)

Methods

__init__(**kwargs)
close([force])	Close connection to instrument.
find_names()	find_names() returns list of identifiers strings, lhs of = assignments
help()	Print the docstring of the instrument class.
identify([showInstName])	Identify message.
init([identify])	Optional init for interlock startup after identification.
message([msg])	There is no message implemented.
mqtt_add(client, instrument[, liste, qos])	Add the instrument to mqtt.
mqtt_disconnect()	Remove the instrument from mqtt.
publish(topic, value)	Publish topic as type='cmd' with payload=value.
publish_get(function_name, value)	Publish function_name as type='get' with paylad=value.
publish_set(function_name, value)	Publish function_name as type='set' with paylad=value.
reset()	There is no reset implemented.
setup_inst()	Setup the instrument settings.

Attributes

command
id	Query IDN.
idtry	Query IDN.
interchoices
mqtt_enable
mqtt_list
mqtt_status	Getter for the mqtt_status.

close(force=False)

Close connection to instrument.

find_names()

find_names() returns list of identifiers strings, lhs of = assignments

Returns:

obj_names – List of identifier strings

Return type:

list of str

help()

Print the docstring of the instrument class.

property id

Query IDN.

identify(showInstName=False)

Identify message.

property idtry

Query IDN.

init(identify=False)

Optional init for interlock startup after identification.

json = <module 'json' from '/home/runner/miniconda3/envs/test/lib/python3.9/json/__init__.py'>

message(msg=None)

There is no message implemented.

mqtt_add(client, instrument, liste='#', qos=0)

Add the instrument to mqtt. Calling from base_instrument, after the instrument (device) has been create. Normally you have not to use this function, only base_instrument use it.

Parameters:

• client (mqtt_init) – The MQTT client instance to which the instrument should be added.

• instrument (object) – The instrument to be added to the MQTT client.

• liste (list or str) – A list of attributes for which MQTT messages should be sent. If set to “#”, all attributes will be included (default: “#”).

• qos (int) – The Quality of Service level for MQTT messages (default: 0).

Return type:

None

mqtt_disconnect()

Remove the instrument from mqtt. Calling from base_instrument, if the instrument are closing. Normally you have not to use this function, only base_instrument use it.

property mqtt_status

Getter for the mqtt_status.

publish(topic, value)

Publish topic as type=’cmd’ with payload=value.

Parameters:

• topic (str) – The name of the topic to publish.

• value (any) – The value to be published.

Return type:

None

publish_get(function_name, value)

Publish function_name as type=’get’ with paylad=value.

Parameters:

• function_name (str) – The name of the function to be published as a ‘get’ command.

• value (any) – The value to be published as the payload of the ‘get’ command.

Return type:

None

publish_set(function_name, value)

Publish function_name as type=’set’ with paylad=value.

Parameters:

• function_name (str) – The name of the function to be published as a ‘set’ command.

• value (any) – The value to be published as the payload of the ‘set’ command.

Return type:

None

reset()

There is no reset implemented.

setup_inst()

Setup the instrument settings.