nimodinst 1.3.0

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	National Instruments

About

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

• NI-DCPower (Python module: nidcpower)

• NI-Digital Pattern Driver (Python module: nidigital)

• NI-DMM (Python module: nidmm)

• NI-FGEN (Python module: nifgen)

• NI-ModInst (Python module: nimodinst)

• NI-SCOPE (Python module: niscope)

• NI Switch Executive (Python module: nise)

• NI-SWITCH (Python module: niswitch)

• NI-TClk (Python module: nitclk)

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 follows Python Software Foundation support policy for different versions. At this time this includes Python 3.5 and above using CPython.

NI-ModInst Python API Status

NI-ModInst (nimodinst)
Driver Version Tested Against	20.0.0
PyPI Version
Supported Python Version
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.3.0

Or easy_install from setuptools:

$ python -m easy_install nimodinst

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

Additional examples for NI-ModInst are located in src/nimodinst/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.

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.