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).

Connection Classes

Use the following functions to find equipment that are connected to a computer or that are on the network

list_resources()

A dict of all equipment that are available to connect to

print_resources()

Print a summary of all equipment that are available to connect to

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

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

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