API Documentation

Although this package contains many classes and functions, the only object that you must initialize in your application is Config and perhaps EquipmentRecord’s (depending on the format that is chosen to store the Databases).

Find Equipment

To find equipment that can be connected to, you may either call the find_equipment() function or run the find-equipment executable from a terminal. To see the help for the executable, run

find-equipment --help

Running either the function or the executable will return/display a description about the equipment and the address(es) that may be used to connect to the equipment.

Connection Classes

The following Connection classes are available to communicate with the equipment (although you should never need to instantiate these classes directly):

ConnectionDemo

Simulate a connection to the equipment

ConnectionGPIB

Equipment that use the IEEE-488 bus (GPIB)

ConnectionMessageBased

Equipment that use message-based communication

ConnectionPrologix

Equipment that is connected through a Prologix Controller

ConnectionSDK

Equipment that use the manufacturer’s SDK for the connection

ConnectionSerial

Equipment that is connected through a Serial port

ConnectionSocket

Equipment that is connected through a Socket

ConnectionTCPIPVXI11

Equipment that use the VXI-11 protocol

ConnectionTCPIPHiSLIP

Equipment that use the HiSLIP protocol

ConnectionZeroMQ

Equipment that use the ZeroMQ protocol

and the Connection classes that are available from external Python libraries are:

ConnectionPyVISA

Uses PyVISA to establish a connection to the equipment

ConnectionNIDAQ

Uses NI-DAQ to establish a connection to the equipment

Package Structure