niswitch 0.8.0.dev0

NI-SWITCH Python API

Overall Status

master branch status
GitHub status

Info	Python bindings for NI Modular Instrument drivers. See GitHub for the latest source.
Author	National Instruments

About

The nimi-python repository generates Python bindings (Application Programming Interface) for interacting with the Modular Instrument drivers. Currently, the following drivers are supported:

• NI-DCPower (Python module: nidcpower)

• NI-DMM (Python module: nidmm)

• NI-FGEN (Python module: nifgen)

• NI-SCOPE (Python module: niscope)

• NI-SWITCH (Python module: niswitch)

• NI-ModInst (Python module: nimodinst)

It is implemented as a set of Mako templates and per-driver metafiles that produce a Python module for each driver. The driver is called through its public C API using the ctypes Python library.

nimi-python supports all the Operating Systems supported by the underlying driver.

nimi-python supports Python 2.7, 3.4 and later using CPython or PyPy.

NI-SWITCH Python API Status

NI-SWITCH (niswitch)
Driver Version Tested Against	17.0.0
PyPI Version
Supported Python Version
Open Issues
Open Pull Requests

Installation

As a prerequisite to using the niswitch module, you must install the NI-SWITCH runtime on your system. Visit ni.com/downloads to download the driver runtime for your devices.

The nimi-python modules (i.e. for NI-SWITCH) can be installed with pip:

$ python -m pip install niswitch

Or easy_install from setuptools:

$ python -m easy_install niswitch

Contributing

We welcome contributions! You can clone the project repository, build it, and install it by following these instructions.

Usage

The following is a basic example of using the niswitch module to open a session to a Switch and connect channels.

import niswitch
with niswitch.Session("Dev1") as session:
    session.connect(channel1='r0', channel2='c0')

Additional examples for NI-SWITCH are located in src/niswitch/examples/ directory.

Support / Feedback

The packages included in nimi-python package are supported by NI. For support, open a request through the NI support portal at ni.com.

Bugs / Feature Requests

To report a bug or submit a feature request, please use the GitHub issues page.

Information to Include When Asking for Help

Please include all of the following information when opening an issue:

• Detailed steps on how to reproduce the problem and full traceback, if applicable. Code samples are encouraged!

• The python version used:

  $ python -c "import sys; print(sys.version)"

• The module (i.e. nidmm) and its version:

  $ python -m pip list

• The version of the driver used (i.e. NI-DMM 17.1). Follow this KB article to determine the version you have installed.

• The operating system, version, and bitness. For example 64-bit Windows 7.

Documentation

Documentation is available here.

License

nimi-python is licensed under an MIT-style license (see LICENSE). Other incorporated projects may be licensed under different licenses. All licenses allow for non-commercial and commercial use.