Skip to main content

Overall Status

master branch status

Build Status - master branch Documentation Status - master branch MIT License Test Coverage - master branch

GitHub status

Open Issues + Pull Requests Open Pull Requests

Info

Python bindings for NI Modular Instrument drivers. See GitHub for the latest source.

Author

National Instruments

NI Digital Multimeter with Python logo

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

Latest NI-SWITCH Version

Supported Python Version

NI-SWITCH supported Python versions

Open Issues

Open Issues + Pull Requests for NI-SWITCH

Open Pull Requests

Pull Requests for NI-SWITCH

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

niswitch-0.7.0.tar.gz (34.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

niswitch-0.7.0-py2.py3-none-any.whl (39.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file niswitch-0.7.0.tar.gz.

File metadata

  • Download URL: niswitch-0.7.0.tar.gz
  • Upload date:
  • Size: 34.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for niswitch-0.7.0.tar.gz
Algorithm Hash digest
SHA256 6d0a12a41c583debf62fe4846a24b8a64e47bbfdb142b6265df8c25f000fb2e3
MD5 4d4338165900e29a4ea7caf0f8565336
BLAKE2b-256 24a343721d37d84729481ec257cfbb4d359b88695d8d22496f7ec1eab24e99c1

See more details on using hashes here.

File details

Details for the file niswitch-0.7.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for niswitch-0.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 858715c3bb36f529fc0e7245c1e9919416e1b381766850d84e03bdad837dcfb9
MD5 9dda1b520d72533411c81f27b7671663
BLAKE2b-256 1d3a25b767c8d9dd4cfef0a4453a055d821720ebe6765142c38033320754c39a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page