Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Python API for interacting with National Instrument's LabVIEW FPGA Devices

Project description

FPGA Interface Python API
=======

Overview
--------
The National Instruments FPGA Interface Python API is used for communication between processor and FPGA within NI reconfigurable I/O (RIO) hardware such as NI CompactRIO, NI Single-Board RIO, NI FlexRIO, and NI R Series multifunction RIO.

With the FPGA Interface Python API, developers can use LabVIEW FPGA to program the FPGA within NI hardware and communicate to it from Python running on a host computer. This gives engineers and scientists with Python expertise the ability to take advantage of compiled LabVIEW FPGA bitfiles, also the option to reuse existing Python code.

Installation
------------
NiFpga can be installed by cloning the master branch and then in a command
line in the directory of setup.py run:

pip install --pre .

Or by installing from PyPI using:

pip install nifpga

Examples
--------

The FPGA Interface Python API is session based. LabVIEW FPGA will generate
bitfiles (.lvbitx) that can be used to program the hardware. For additional
information on sessions view our Read the docs documentation

Example usage of FPGA configuration functions:

with Session(bitfile="BitfilePath.lvbitx", resource="RIO0") as session:
try:
session.run()
except FpgaAlreadyRunningWarning:
pass
session.download()
session.abort()
session.reset()
my_control = session.registers["MyControl"]
my_control.write(4)
data = my_control.read()


See our [readthedocs page](http://nifpga-python.readthedocs.io/en/latest/) for more detailed examples and documentation.

Project details


Release history Release notifications

History Node

18.0.0

This version
History Node

17.0.0.post2

History Node

17.0.0.post1

History Node

17.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
nifpga-17.0.0.post2-py2.py3-none-any.whl (23.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Apr 21, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page