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)

  • NI Switch Executive (Python module: nise)

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

18.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~=1.1.0

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 specific to NI Modular Instruments Python bindings (nimi-python), please use the GitHub issues page.

Fill in the issue template as completely as possible and we will respond as soon as we can.

For hardware support or any other questions not specific to this GitHub project, please visit [NI Community Forums](https://forums.ni.com/). .. _documentation-section:

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-1.1.0.tar.gz (36.2 kB view details)

Uploaded Source

Built Distribution

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

niswitch-1.1.0-py2.py3-none-any.whl (38.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: niswitch-1.1.0.tar.gz
  • Upload date:
  • Size: 36.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/2.7.12

File hashes

Hashes for niswitch-1.1.0.tar.gz
Algorithm Hash digest
SHA256 c9b5bd5eba8927008efdc09033f4aeb4dbb06247c839b0d5f53a75feb4e56998
MD5 98179e2fbfc8a62d0ad9d6097a71cc4d
BLAKE2b-256 8a20ee101b5efeef26cb19683e88c069242b8812512cd259b9113f497c69f58b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: niswitch-1.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 38.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/2.7.12

File hashes

Hashes for niswitch-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f38ac62124a5fdb495b462c43adaa4ab14073f0a333df622ccf8d6187f518f48
MD5 2549fec9a389d01690d588220696d72b
BLAKE2b-256 0614e2373a894425ea23f03265a01707c0f97ca9f00218946f2a8f93b8256979

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