hedgehog-pyvisa 2.0.0
Python VISA bindings for GPIB, RS232, and USB instruments
License: MIT License
Keywords: VISA GPIB USB serial RS232 measurement acquisition

PyVISA
======

A Python package for support of the "Virtual Instrument Software
Architecture" (VISA), in order to control measurement devices and
test equipment via GPIB, RS232, Ethernet or USB.


Description
-----------

The programming of measurement instruments can be real pain. There are many
different protocols, sent over many different interfaces and bus systems
(GPIB, RS232, USB). For every programming language you want to use, you have to
find libraries that support both your device and its bus system.

In order to ease this unfortunate situation, the Virtual Instrument Software Architecture
(VISA_) specification was defined in the middle of the 90'. Today VISA is implemented on
all significant operating systems. A couple of vendors offer VISA libraries, partly
with free download. These libraries work together with arbitrary peripherical devices,
although they may be limited to certain interface devices, such as the vendor’s GPIB card.

The VISA specification has explicit bindings to Visual Basic, C, and G (LabVIEW’s graphical
language. However, you can use VISA with any language capable of calling functions in a DLL.
Python is such a language.

.. _VISA: http://www.ivifoundation.org/specifications/default.aspx


VISA and Python
---------------

Python has a couple of features that make it very interesting for measurement controlling:

- Python is an easy-to-learn scripting language with short development cycles.
- It represents a high abstraction level [2], which perfectly blends with the abstraction
  level of measurement programs.
- It has a very rich set of native libraries, including numerical and plotting modules for
  data analysis and visualisation.
- A large set of books (in many languages) and on-line publications is available.


Requirements
------------

- VISA (tested with NI-VISA 3.2, WinXP, from www.ni.com/visa)
- Python (tested with 2.6 and 3.2+)


Installation
--------------

Using pip:

    $ pip install pyvisa

or easy_install:

    $ easy_install pyvisa

or download and unzip the source distribution file and:

    $ python setup.py install


Documentation
--------------

The documentation can be read online at https://pyvisa.readthedocs.org


PyVISA was originally programmed by Torsten Bronger and Gregor Thalhammer, Innsbruck, Austria. It is based on earlier experiences by Thalhammer.

It was maintained from March 2012 to August 2013 by Florian Bauer.
It is currently maintained by Hernan E. Grecco <hernan.grecco@gmail.com>.

Other contributors, listed alphabetically, are:

* bauflo3 <bauflo3@516c0664-e049-0410-bc6e-8f9a6051a51d>
* bkstein <Bernd.Krietenstein@rohde-schwarz.com>
* bronger>
* Christian Lupien <christian.lupien@usherbrooke.ca>
* Colin Marquardt <github@marquardt-home.de>
* crazyfermions <brain-stormer@web.de>
* gnbl <l@eleif.net>
* Gregor Thalhammer <gregor.thalhammer@gmail.com>
* HummingBrid
* kcsaff
* lordoftheflies <laszlo.hegedus@cherubits.hu>
* Martin Ritter <ritter@mpp.mpg.de>
* Matthew94 <matthewlove94@gmail.com>
* Matthieu Dartiailh <marul@laposte.net>
* mordoror <mordoror@gmail.com>
* Tobias Müller <Tobias_Mueller@twam.info>
* Yves Delley <hack@delley.net>

If you think your name should be here, please let me know.


PyVISA Changelog
================


1.9 (unreleased)
----------------

- Nothing changed yet.


1.8 (2015-08-24)
----------------

- Fixed error reporting with Unicode filenames.
  (Issue #136)
- Improved documentation.
- Clarify timeout getter and setter.
  (Issue #167)
- In open_resource, return a Resource object and warns if resource class not registered.
- Register resource class for empty resource class.
- Allow registering parent resource classes.
- Changed types in wrapper to be platform independent (viStatus is always 32 bit).
  (Issue #134)
- Fix a not a invalid EventType bug.
  (Thanks lupien)
- Added optional resource_pyclass to open_resource.
- Fixed bug in serial flush.
  (Thanks bkstein)
- Implemented resource name parsing in pure python.


1.7 (2015-05-16)
----------------

- Removed find_next and find_resources from VisaLibraryBase.
  (Issue also #135, thanks)
- Implemented parse_resource and parse_resource_extended.
- Created rname module to parse Resource Names.
- Properly cleanup visa handlers upon resource close.
  (thanks lupien)
- Improved gpib classes
  (thanks lupien)
- Fixed bug in binary data writing.
  (Issue #140, thanks burnpack)
- Fix reseting of line termination for serial.
  (Issue #147, thanks lupien)
- Added property to resource name returning the InterfaceType value.
- Added backend information to logging.
- Added the flow_control attribute to ASRL resources.
  (Issue #144, thanks lupien)
- Remove empty entry in resources caused by attribute registration.
  (Issue #144, thanks lupien)
- Make container=numpy.array work consistently.
  (Issue #142, thanks Martin Ritter)
- Create compact/struct.py for python2/3 compatibility.
  (thanks Martin Ritter)
- Improve install and uninstall handlers
  (Issue #138, #139, #151 thanks lupien)
- Prevents cygwin segfaults.
  (Issue #131)
- Better error reporting when a resource cannot be found.
  (Issue #129)
- Suppress VI_SUCCESS_MAX_CNT warning on read raw.
  (Issue #116)
- Implemented smarter query values based on looking how many bytes are expected.
  (Issue #118)
- Fix UnicodeDecodeError on wrong file for library load
  (Issue #136, thanks lupien)


1.6.3 (2015-02-08)
------------------

- Added support to Rhode and Schwartz Passport driver.
  (Issue #115)
- Fixed access to the interface_type property.
  (Issue #114, thanks mordoror)
- Imported constants module in visa module.
  (Issue #72)


1.6.2 (2014-12-29)
------------------

- Proper handling of VI_ERROR_RSRC_NFOUND.
- Added conditional dependency for unittest2 in Python2.6
  (Issue #107)
- Fixed Shell on Windows.
  (Issue #101)
- Moved Lantz Shell to PyVISA.
- Easier way to get debug information.
- Better debug info for backends.


1.6.1 (2014-10-28)
------------------

- Add ignore_warning methods to Resource and ResourceManager.
- Added more formats to binary values.
  (Issue #92)
- Fixed exception raising in legacy read_values.
  (Issue #91)
- Provide a backend hook to display debug info.
- Better debug info for binary libraries.
- Fixed exceptions formatting
  (thanks Matthew94)
  


1.6 (2014-09-28)
----------------

- 13 Resource Classes covering all resource types.
- Attributes classes provided introspection to VISA attributes.
- Many VISA attributes added to Resource Classes.
- Use of IntEnum for common constants.
- Better documentation.
- Implementation of discoverable backends.
- New functions to encode and decode of IEEE blocks.
- New functions to encode and decode of ASCII blocks.
- New API to transfer values from the instrument.
- Renamed ask/ask_delay/ask_for_values to ask/query_delay/query_values.
  Old names still available for backwards compatibility.
- Implemented Group Execute Trigger for GPIBInterface.
  (Issue #67)
- Make setuptools a requirement.
  (Issue #64 and 68)
- Simplified testing.
- Removed legacy subpackage.
- Removed string handling wrappers.
- Removed Instrument class in favour of Resource.
- Removed status and implemented thread-safe, per instrument, last_status.
- Refactored warning ignoring mechanisms to a thread-safe one.
- Added enum34 requirement for Python < 3.4.
- Removed deprecated term_chars.


1.5 (2014-06-24)
----------------

- Python 3.2+ compatibility.
  (Issue #32)
- Change source encoding to utf-8.
- Reorganized package structure.
  (Issue #13)
- Improved installation.
- Moved tests inside the package.
- Added CI using Travis.
- Created new wrapper for the underlying library.
- Moved vpp43 code to legacy subpackage.
- Moved documentation to readthedocs.
- Make documentation mobile-friendly.
  (Issue #2)
- Removed latex documentation.
- ResourceManager is no longer a singleton.
  (Issue #8)
- VisaLibrary is no longer a singleton.
  (Issue #7)
- VISA functions are VisaLibrary methods.
  (Issue #11)
- Improved detection of VISA library path in all OS.
- Added diagnostics functions to help debugging.
- Added extensive logging to help debugging.
  (Issue #12)
- Improved error messages.
- Added encoding parameter to read and write.
  (Issue #38)
- Added termination parameter to read and write.
  (Issue #38)
- Added size to read_raw.
  (Issue #37)
- Removed delay parameter in favor of ask_delay
  (Issue #34)
- Added 64 bits VISA library methods.
- Cleaned up code.


1.4 (2012-05-13)
----------------

- add coverage
- add tox testing


1.3 (2008-03-26)
----------------

- Changed licence to MIT.
- Made determination of resource class even more careful.


1.2 (2007-09-19)
----------------

- Changed some __getattr__ to getattr in order to have working exceptions again
  (e.g. timeouts) in vpp43
- Softened the test for "INSTR" even further.  Introduced the "stb" property for
  GPIB instruments.
- Changed "is not an INSTR" error to a warning.
- Added correct prefix for RPM in setup.cfg.


1.1 (2006-11-21)
----------------

- Mentioned possible AttributeError with viParseRsrcEx.
- Made secure against missing viParseRsrcEx.
- Removed superfluous calls to parse_resource_extended.
- setup.py Script can now handle installation with or without setuptools.
- setup.py: Switched to new distutils version.

1.0 (2006-01-23)
----------------

- New properties of SerialInstrument explained.
- Added many further properties to SerialInstrument.


0.9.7 (2005-09-21)
------------------

- Renamed timeout parameter in open() to open_timeout.
- Renamed Timeout parameter in open() to open_timeout.
- Added section about SerialInstrument.
- Added class SerialInstrument. Made termination characters even more robust.


0.9.6 (2005-08-31)
------------------

- Renamed TypeError to VisaTypeError.
- Added InvalidBinaryFormat. Renamed TypeError to VisaTypeError.
- Added a lot of docstrings. Fixed bug with ValueError exception raising.
- Eliminated string exceptions. A little bit of code clean-up.
- Added old distutils inclusion for RPM that cause trouble with my setuptools
  installation.
- Set default for term_chars to None and implemented it in write() method.
- Described new default for term_chars.
- Added instrument(). Fixed bugs in __repr()__.
- Improved documentation.
- Switched from distutils to setuptools.


0.9.5 (2005-08-27)
------------------

- Changed package name to "PyVISA".
- visa_attributes.py: 0xFFFFFFFF -> 0xFFFFFFFFL.
- Switched from distutils to setuptools.


0.9.4 (2005-08-12)
------------------

- Added filename selection for VISA DLL with Windows in vpp43.py.
- Added code to skip over header before binary data.
- Cleaned up whitespace.
- Added support for endianess in case of binary transfers.
- Improved binary reading; now it also accepts things like "#267...".


0.9.3 (2005-07-21)
------------------

- Changed default termination characters to "" for GPIB instruments. LF and CR
  are completely stripped from the end of read string, no matter how the
  termination characters are set.


0.9.2 (2005-07-19)
------------------

- Added remaining keyword arguments for Instrument constructor.  Added CR and LF.
  Added working support for reading binary data.
- Added ask() and ask_for_values().
- Partially implemented binary reading.
- Split the old term_chars in term_chars, delay, and send_end.
- Implemented warning system for invalid keyword arguments.  Added test for valid
  float values in read_floats(). Added full term_char string in __get_term_char().
- Standard timeout increased from 2 to 5 seconds.
- read_floats() returns *always* a list.
- Moved trigger() method to Instrument class.
- Fixed bug in regular expression for termination characters.
- Fixed bug with ignored term_char attribute for GPIB instruments.
- Increased chunk_size's default value and added it to the keyword arguments of the constructor.


0.9.1 (2005-07-03)
------------------

- Added properties resource_name and resource_class to ResourceTemplate.  Used
  both to simplify code.


0.9 (2005-06-29)
----------------

- First usable release. See ChangeLog for more information.