Skip to content

Latest commit

 

History

History
88 lines (74 loc) · 3.22 KB

README.md

File metadata and controls

88 lines (74 loc) · 3.22 KB

pylint PyPI PyPI - Python Version PyPI - Status License: GPL v3 code style

async_gpib

Python3 asyncio Linux GPIB Wrapper. The library requires Python asyncio and is a thin wrapper for the threaded Linux GPIB Wrapper library.

The library is fully type-hinted.

Supported Devices

Instruments

Device Supported Tested Comments
Fluke 5440B ✔️ ✔️
HP 3478A ✔️ ✔️

Setup

There are currently no packages for Linux GPIB available on all platforms. To install the library it is required to install Linux GPIB.

Linux GPIB:

These instructions are for Ubuntu:

sudo apt install subversion build-essential autoconf libtool flex bison python3-dev
svn checkout svn://svn.code.sf.net/p/linux-gpib/code/trunk linux-gpib-code
cd ~/linux-gpib-code/linux-gpib-kernel
make
sudo make install  # ignore the signing errors
sudo groupadd gpib  # seems not to be installed
sudo modprobe ni_usb_gpib
cd ~/linux-gpib-code/linux-gpib-user
./bootstrap
./configure --sysconfdir=/etc
make
sudo make install
sudo ldconfig

Linux GPIB Python module:

Once Linux GPIB is installed, you can either install the python package or use the gpib-ctypes package.

python3 -m venv env  # virtual environment, optional
source env/bin/activate
pip install -e ~/linux-gpib-code/linux-gpib-user/language/python/

async_gpib Python module

The package can be directly installed via Pypi:

python3 -m venv env  # virtual environment, optional
source env/bin/activate
pip install async-gpib

Usage

Initialize the GPIB adapter

from async_gpib import AsyncGpib

# Create a controller and talk to device address 22
async with AsyncGpib(name=0, pad=22) as gpib_device:
    # Add your code here
    ...

See examples/ for more working examples.

Support for Multiple Devices

⚠️ Concurrency with multiple devices: Note, that when using a single adapter to control multiple devices, there is no concurrency on the GPIB bus. This means, there is no speed increase, when making asynchronous reads from multiple devices on the bus regarding the transfer time.

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

License

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