Skip to main content

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


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

nifpga-17.0.0.post2-py2.py3-none-any.whl (23.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file nifpga-17.0.0.post2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for nifpga-17.0.0.post2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1e23418e50fde4b495e954742ef31e588f167e9e3f9509f91934343701ee1e86
MD5 bb89ca3099c1de05d66058e10c238be8
BLAKE2b-256 422b5785fec3ff589a6eeefd363154e3e04f2f953843eb25c047a64ea81d2372

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page