PyVISA-py

Warnings

• gotcha Using PyVISA-py within a Virtual Machine (VM) or Docker container can lead to unexpected timeouts or connectivity issues when accessing hardware-dependent resources like USB or GPIB. VMs might not properly forward hardware responses, and Docker containers might disconnect idle connections.
  Fix: For VMs, consult the VM manual for proper hardware passthrough/configuration. For Docker (especially with TCP/IP instruments), consider enabling keepalive packets for the VISA session using `inst.set_visa_attribute(pyvisa.constants.ResourceAttribute.tcpip_keepalive, True)` to prevent idle connections from being dropped.
• gotcha PyVISA-py's ability to communicate with different instrument types (Serial, USB, GPIB) depends on specific optional Python libraries (e.g., PySerial, PyUSB, linux-gpib, gpib-ctypes). If these are not installed, PyVISA-py may only be able to access TCPIP resources.
  Fix: Install the relevant optional dependencies for the instrument interface you intend to use (e.g., `pip install pyvisa-py pyserial pyusb`). Refer to the PyVISA-py documentation for a full list of dependencies per resource type.
• gotcha For USB instruments, `PyUSB` (a dependency for PyVISA-py's USB support) requires an underlying USB driver library (e.g., `libusb`). On Unix-like systems, `udev` rules may need to be modified to grant non-root users access to USB devices. On Windows, you might need to uninstall USBTMC-specific drivers and install a generic driver.
  Fix: Ensure `libusb` or a compatible USB driver library is installed. Consult `PyUSB` documentation and your operating system's guides for specific driver installation and permissions setup (e.g., `udev` rules on Linux).
• breaking While not directly in `pyvisa-py`, the underlying `PyVISA` library introduced significant breaking changes in versions 1.5 and 1.6. Key changes include the removal of the direct `pyvisa.instrument()` function in favor of `ResourceManager().open_resource()` and modifications to `ask()`/`query()` methods and event handler arguments.
  Fix: Update your code to use `pyvisa.ResourceManager().open_resource()` instead of `pyvisa.instrument()`. Replace `instrument.ask()` with `instrument.query()`. Review PyVISA's migration guide if upgrading from versions older than 1.5.
• gotcha Incorrect `read_termination` or `write_termination` characters, or an incorrect baud rate, are common issues when communicating with serial instruments. The default baud rate is often 9600, but instrument manuals should be consulted.
  Fix: Always check your instrument's manual for the correct baud rate, stop bits, parity, and flow control settings. Explicitly set `instrument.read_termination` and `instrument.write_termination` to match the instrument's requirements (e.g., `\n`, `\r`, or an empty string for no termination).

Install

• pip install pyvisa-py Install core library

Imports

• ResourceManager

  import pyvisa
  rm = pyvisa.ResourceManager('@py')

  When using `pyvisa-py`, you must explicitly specify the '@py' backend for ResourceManager. Otherwise, PyVISA will attempt to load a system-installed VISA library (e.g., NI-VISA) by default, which may not be present or desired.

Quickstart

This quickstart demonstrates how to initialize the `ResourceManager` specifically with the `pyvisa-py` backend, list available instrument resources, and attempt to open and query a resource. Note that connecting to and querying a real instrument requires the instrument to be physically connected and the corresponding optional dependencies (e.g., `PySerial` for serial, `PyUSB` for USB) to be installed. Without a connected instrument or emulator, `list_resources()` might return an empty tuple.

import pyvisa

# Initialize the Resource Manager with the PyVISA-py backend
# This tells PyVISA to use the pure Python implementation.
rm = pyvisa.ResourceManager('@py')

# List available resources (instruments)
# The output will vary based on connected and supported hardware/emulators
resources = rm.list_resources()
print(f"Available resources: {resources}")

# Example of opening a (possibly simulated) instrument
# This line might fail if no such resource exists or is not properly configured
# For demonstration, we'll try to open a generic ASRL resource if available.
# Replace 'ASRL1::INSTR' with an actual resource from your 'resources' list.
if resources:
    try:
        # Choose the first resource or a known one, e.g., 'ASRL1::INSTR'
        # Ensure the chosen resource type has its optional dependencies installed (e.g., PySerial for ASRL)
        instrument_address = resources[0]
        # Fallback to a common dummy address if real ones aren't found, for demonstration
        if not instrument_address.startswith(('ASRL', 'USB', 'TCPIP', 'GPIB')):
             instrument_address = 'ASRL1::INSTR' # This will likely fail without PySerial/a real ASRL port

        inst = rm.open_resource(instrument_address)
        print(f"Successfully opened: {instrument_address}")
        
        # Example: Query instrument identification (standard SCPI command)
        # This will likely only work if you have a real instrument or a simulator running
        try:
            idn = inst.query('*IDN?')
            print(f"Instrument IDN: {idn.strip()}")
        except pyvisa.errors.VisaIOError as e:
            print(f"Could not query *IDN? on {instrument_address}: {e}")
        finally:
            inst.close()
            print(f"Closed {instrument_address}")

    except pyvisa.errors.VisaIOError as e:
        print(f"Could not open resource {instrument_address}: {e}")
    except IndexError:
        print("No resources found to open.")
else:
    print("No resources found by PyVISA-py backend.")