Skip to content

Latest commit

 

History

History
553 lines (383 loc) · 22.7 KB

README.rst

File metadata and controls

553 lines (383 loc) · 22.7 KB
Raw

Overall Status

MIT License

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

NI-DCPower Python API Status

NI-DCPower (nidcpower)  
Driver Version Tested Against 2023 Q2
PyPI Version Latest NI-DCPower Version
Supported Python Version NI-DCPower supported Python versions
Documentation NI-DCPower Documentation Status
Open Issues Open Issues + Pull Requests for NI-DCPower
Open Pull Requests Pull Requests for NI-DCPower

NI-Digital Pattern Driver Python API Status

NI-Digital Pattern Driver (nidigital)  
Driver Version Tested Against 2023 Q2
PyPI Version Latest NI-Digital Pattern Driver Version
Supported Python Version NI-Digital Pattern Driver supported Python versions
Documentation NI-Digital Pattern Driver Documentation Status
Open Issues Open Issues + Pull Requests for NI-Digital Pattern Driver
Open Pull Requests Pull Requests for NI-Digital Pattern Driver

NI-DMM Python API Status

NI-DMM (nidmm)  
Driver Version Tested Against 2023 Q1.1
PyPI Version Latest NI-DMM Version
Supported Python Version NI-DMM supported Python versions
Documentation NI-DMM Documentation Status
Open Issues Open Issues + Pull Requests for NI-DMM
Open Pull Requests Pull Requests for NI-DMM

NI-FGEN Python API Status

NI-FGEN (nifgen)  
Driver Version Tested Against 2023 Q1.1
PyPI Version Latest NI-FGEN Version
Supported Python Version NI-FGEN supported Python versions
Documentation NI-FGEN Documentation Status
Open Issues Open Issues + Pull Requests for NI-FGEN
Open Pull Requests Pull Requests for NI-FGEN

NI-ModInst Python API Status

NI-ModInst (nimodinst)  
Driver Version Tested Against 2023 Q2
PyPI Version Latest NI-ModInst Version
Supported Python Version NI-ModInst supported Python versions
Documentation NI-ModInst Documentation Status
Open Issues Open Issues + Pull Requests for NI-ModInst
Open Pull Requests Pull Requests for NI-ModInst

NI-SCOPE Python API Status

NI-SCOPE (niscope)  
Driver Version Tested Against 2023 Q1.1
PyPI Version Latest NI-SCOPE Version
Supported Python Version NI-SCOPE supported Python versions
Documentation NI-SCOPE Documentation Status
Open Issues Open Issues + Pull Requests for NI-SCOPE
Open Pull Requests Pull Requests for NI-SCOPE

NI Switch Executive Python API Status

NI Switch Executive (nise)  
Driver Version Tested Against 2023 Q1
PyPI Version Latest NI Switch Executive Version
Supported Python Version NI Switch Executive supported Python versions
Documentation NI Switch Executive Documentation Status
Open Issues Open Issues + Pull Requests for NI Switch Executive
Open Pull Requests Pull Requests for NI Switch Executive

NI-SWITCH Python API Status

NI-SWITCH (niswitch)  
Driver Version Tested Against 2023 Q1
PyPI Version Latest NI-SWITCH Version
Supported Python Version NI-SWITCH supported Python versions
Documentation NI-SWITCH Documentation Status
Open Issues Open Issues + Pull Requests for NI-SWITCH
Open Pull Requests Pull Requests for NI-SWITCH

NI-TClk Python API Status

NI-TClk (nitclk)  
Driver Version Tested Against 2023 Q2
PyPI Version Latest NI-TClk Version
Supported Python Version NI-TClk supported Python versions
Documentation NI-TClk Documentation Status
Open Issues Open Issues + Pull Requests for NI-TClk
Open Pull Requests Pull Requests for NI-TClk

Installation

Driver specific installation instructions can be found on Read the Docs:

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 nidmm module to open a session to a DMM and perform a 5.5 digits of resolution voltage measurement in the 10 V range.

import nidmm
with nidmm.Session("Dev1") as session:
    session.configureMeasurementDigits(nidmm.Function.DC_VOLTS, 10, 5.5)
    print("Measurement: " + str(session.read()))

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 on Read the Docs:

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