nimodinst 1.4.6

NI-ModInst Python API

Overall Status

master branch status
GitHub status

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

About

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

Support Policy

nimodinst supports all the Operating Systems supported by NI-ModInst.

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

NI-ModInst Python API Status

NI-ModInst (nimodinst)
Driver Version Tested Against	2023 Q2
PyPI Version
Supported Python Version
Documentation
Open Issues
Open Pull Requests

Installation

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

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

$ python -m pip install nimodinst~=1.4.6

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 nimodinst module to retrieve information on all High Speed Digitizers currently in the system.

import nimodinst
with nimodinst.Session("niscope") as session:
    for device in session:
        print("{: >20} {: >15} {: >10}".format(device.device_name, device.device_model, device.serial_number))

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