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):
Simulate a connection to the equipment |
|
Equipment that use the IEEE-488 bus (GPIB) |
|
Equipment that use message-based communication |
|
Equipment that is connected through a Prologix Controller |
|
Equipment that use the manufacturer’s SDK for the connection |
|
Equipment that is connected through a Serial port |
|
Equipment that is connected through a Socket |
|
Equipment that use the VXI-11 protocol |
|
Equipment that use the HiSLIP protocol |
|
Equipment that use the ZeroMQ protocol |
and the Connection
classes that are available from external Python libraries are:
Uses PyVISA to establish a connection to the equipment |
|
Uses NI-DAQ to establish a connection to the equipment |
Package Structure
- msl.equipment
- msl.equipment.config
- msl.equipment.connection
- msl.equipment.connection_demo
- msl.equipment.connection_gpib
- msl.equipment.connection_message_based
- msl.equipment.connection_nidaq
- msl.equipment.connection_prologix
- msl.equipment.connection_pyvisa
- msl.equipment.connection_sdk
- msl.equipment.connection_serial
- msl.equipment.connection_socket
- msl.equipment.connection_tcpip_hislip
- msl.equipment.connection_tcpip_vxi11
- msl.equipment.connection_zeromq
- msl.equipment.constants
- msl.equipment.database
- msl.equipment.dns_service_discovery
- msl.equipment.exceptions
- msl.equipment.factory
- msl.equipment.hislip
- msl.equipment.record_types
- msl.equipment.resources
- msl.equipment.utils
- msl.equipment.vxi11