ug_gpib

A Python3 pyUSB driver for the LQ Electronics Corp UGPlus USB to GPIB Controller.

Tested using Linux, should work for Mac OSX, Windows and any OS with Python pyUSB support.

:warning: The device must be IEEE 488.1 compliant. It must assert the EOI line to signal the end of a line. If this is not the case, the controller cannot be used. Older devices, typically only send CR, LF, or CR-LF.

The UGPlus is a fairly cheap controller, that supports simple GPIB read and write operations only. It does not support advanced GPIB features like serial polling for example, and it does not have line drivers to support long cables and lots of devices on the bus.

The UGPlus does have several firmware bugs, I have tried to mitigate them to the best of my knowledge. See below for details.

If you are looking for advanced features I suggest buying either a Prologix GPIB adapter or one of the NI USB adapters. I can recommend the following libraries for both Prologix GPIB adapter and Linux GPIB.

The library is fully type-hinted.

Setup

To install the library in a virtual environment (always use venvs with every project):

virtualenv env  # virtual environment, optional
source env/bin/activate
pip install ug-gpib

Linux

To access the raw usb port in Linux, root privileges are required. It is possible to use udev to change ownership of the usb port on creation. This can be done via a rules file.

sudo cp 98-ugsimple.rules /etc/udev/rules.d/.
sudo udevadm control --reload-rules

Usage

Initialize UGSimpleGPIB

from ug_gpib import UGPlusGpib

gpib_controller = UGPlusGpib()

Writing "*IDN?" a command to address 0x02. Do note the GPIB commands must be byte strings.

gpib_controller.write(2, b"*IDN?\n")

Reading from address 0x02 and decoding the byte string to a unicode string.

data = gpib_controller.read(2)
print(data.decode())

See examples/ for more working examples. Including an example that shows how to use the library from the command line.

Firmware Bugs

There are several bugs in the firmware of the UGPlus most of those are off-by-one errors and consequently out-of-bounds reads. I documented them here. Some of these bugs are also evident when using the software supplied by the manufacturer. The most obvious ones are the following:

• Out-of-bounds read when reading the firmware version. The controller sends one more byte than requested.
• Out-of-bounds read when discovering GPIB devices. The controller sends one more byte than requested.
• Out-of-bounds read when the GPIB device does not return any data. The controller sends one more byte than requested.

Versioning

I use SemVer for versioning. For the versions available, see the tags on this repository.

Documentation

I use the Numpydoc style for documentation.

Authors

• Jacob Alexander - Initial work for the UGSimple Jacob Alexander
• Patrick Baus - Complete rewrite for the UGPlus - PatrickBaus

License

This project is licensed under the GPL v3 license - see the LICENSE file for details