NI-DCPower Python API
Project description
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 nidcpower module provides a Python API for NI-DCPower. The code is maintained in the Open Source repository for nimi-python.
Support Policy
nidcpower supports all the Operating Systems supported by NI-DCPower.
It follows Python Software Foundation support policy for different versions of CPython.
NI-DCPower Python API Status
NI-DCPower (nidcpower) |
|
|---|---|
Driver Version Tested Against |
2023 Q2 |
PyPI Version |
|
Supported Python Version |
|
Documentation |
|
Open Issues |
|
Open Pull Requests |
Installation
As a prerequisite to using the nidcpower module, you must install the NI-DCPower runtime on your system. Visit ni.com/downloads to download the driver runtime for your devices.
The nimi-python modules (i.e. for NI-DCPower) can be installed with pip:
$ python -m pip install nidcpower~=1.4.7
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 nidcpower module to open a session to a Source Meter Unit and measure voltage and current.
import nidcpower
# Configure the session.
with nidcpower.Session(resource_name='PXI1Slot2/0') as session:
session.measure_record_length = 20
session.measure_record_length_is_finite = True
session.measure_when = nidcpower.MeasureWhen.AUTOMATICALLY_AFTER_SOURCE_COMPLETE
session.voltage_level = 5.0
session.commit()
print('Effective measurement rate: {0} S/s'.format(session.measure_record_delta_time / 1))
samples_acquired = 0
print('Channel Num Voltage Current In Compliance')
row_format = '{0:15} {1:3d} {2:8.6f} {3:8.6f} {4}'
with session.initiate():
channel_indices = '0-{0}'.format(session.channel_count - 1)
channels = session.get_channel_names(channel_indices)
for i, channel_name in enumerate(channels):
samples_acquired = 0
while samples_acquired < 20:
measurements = session.channels[channel_name].fetch_multiple(count=session.fetch_backlog)
samples_acquired += len(measurements)
for i in range(len(measurements)):
print(row_format.format(channel_name, i, measurements[i].voltage, measurements[i].current, measurements[i].in_compliance))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).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nidcpower-1.4.7-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee8a2c93b52507a24ef715fa133667a40ab5b76193b7fccdfb45c356f90fe71b |
|
| MD5 | 5a54d46c4613553c8719a9ff45d7c383 |
|
| BLAKE2b-256 | 9ab7fbcd28e07c9f0098aa24f1eea51b759c7fb6d1d6908490ca0316c4783405 |
