Skip to main content

NI-SWITCH Python API

Project description

Overall Status

master branch status

Build 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

NI

About

The niswitch module provides a Python API for NI-SWITCH. The code is maintained in the Open Source repository for nimi-python.

Support Policy

niswitch supports all the Operating Systems supported by NI-SWITCH.

It follows Python Software Foundation support policy for different versions of CPython.

NI-SWITCH Python API Status

NI-SWITCH (niswitch)

Driver Version Tested Against

2025 Q1

PyPI Version

Latest NI-SWITCH Version

Supported Python Version

NI-SWITCH supported Python versions

Documentation

NI-SWITCH Python API Documentation Status

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.4.9

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')

Other usage examples can be found on GitHub.

Support / Feedback

For support specific to the Python API, follow the processs in Bugs / Feature Requests. For support with hardware, the driver runtime or any other questions not specific to the Python API, please visit NI Community Forums.

Bugs / Feature Requests

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

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

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.

gRPC Features

For driver APIs that support it, passing a GrpcSessionOptions instance as a parameter to Session.__init__() is subject to the NI General Purpose EULA (see NILICENSE).

Project details


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

Uploaded Source

Built Distribution

niswitch-1.4.9-py3-none-any.whl (61.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: niswitch-1.4.9.tar.gz
  • Upload date:
  • Size: 58.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for niswitch-1.4.9.tar.gz
Algorithm Hash digest
SHA256 0347702d2f4c83a428b149adef3baf782d53a367b1134aacd75424f17cc4742a
MD5 5c05c7f15f74af446ebd9c3ff75a720e
BLAKE2b-256 8fff9178a738570ce8f0bec405c4177acc8801684522d82595b1fcc051628d02

See more details on using hashes here.

File details

Details for the file niswitch-1.4.9-py3-none-any.whl.

File metadata

  • Download URL: niswitch-1.4.9-py3-none-any.whl
  • Upload date:
  • Size: 61.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for niswitch-1.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 416c5ececcaa47cfc68ffbc26ba5eaee5369ac68a06afd28c29fc04a75518edf
MD5 2ec43318c70ce3693c318ef0cb3aabde
BLAKE2b-256 904ce06a401d839579937323f46ac839a12695e9353519431587e3cd75be0924

See more details on using hashes here.

Supported by

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