Pre-release

This release is a pre-release and may not be stable for production use.

LabVIEW FPGA HDL Tools

Pre-release command-line tools (nihdl) for building customized FPGA designs for use with the ni/flexrio repository. They move, generate, and process the files needed to take a top-level HDL design through Vivado to a LabVIEW FPGA bitfile — and to build hybrid LabVIEW + HDL targets.

Documentation

Doc What's in it
Theory of Operation The architecture, the supported workflows, and how the pieces fit together. Start here.
Command Reference Every nihdl command, its options, the command flow, and per-command required settings.
Settings Reference The nihdlsettings.py model: hooks, context, --set overrides, and the full list of setters.
LVTargetCustomIO Reference The custom I/O CSV format used to define HDL ↔ LabVIEW FPGA signals.

Prerequisites

External tools

You need the external tools your flow uses:

  • Vivado — for gen-vivado, check-vivado, and compile-vivado (use the version your FlexRIO release targets).
  • LabVIEW + LabVIEW FPGA and the LabVIEW FPGA Compilation Tool for Vivado — for gen-lvbitx and custom LabVIEW FPGA targets.
  • ModelSim — only for simulation (gen-modelsim, sim-modelsim, launch-modelsim, compile-modelsim-lib). compile-modelsim-lib also needs Vivado to compile the Xilinx simulation libraries.
  • Git and Python (Python 3.11 is the officially tested version).

Installing the tools

nihdl is published to PyPI and is normally installed into a per-target Python virtual environment by the host repository's setup script. From a target folder that contains nihdlsettings.py (for example, c:/dev/github/flexrio-custom/targets/pxie-7903custom), run:

nisetup

This creates and activates a virtual environment and installs the version of labview-fpga-hdl-tools pinned in the repository's dependencies.toml. Re-run nisetup in every new terminal — the environment is only active for the current session, and you'll see the environment name (for example, (flexrio-custom)) in your prompt when it is active.

To install the package directly instead (for example, outside a flexrio-custom checkout):

pip install labview-fpga-hdl-tools

Required Files

Every target folder must contain a nihdlsettings.py file. It configures all paths, tool locations, and project settings via setter calls, and defines hook functions that run before/after each command. The CLI exits with an error if it is not found.

A complete starter template lives at labview_fpga_hdl_tools/nihdlsettings_default.py — copy it into your target folder as nihdlsettings.py and customize it. See the Settings Reference for details.

All nihdl commands are run from the target folder unless noted otherwise:

nihdl --help

By default nihdl prints results inline and collects any warnings and errors into a single summary at the end. Add -v (--verbose) to any command for full step-by-step status with warnings and errors also shown inline; the end summary still appears, so verbose is additive to the default. See the Command Reference for details.

Quickstart: HDL to Bitfile

Run these from your target folder (the one with nihdlsettings.py), with the Python environment active (run nisetup once per terminal — see Prerequisites):

# 1. Pull in GitHub dependencies declared in dependencies.toml
nihdl install-deps

# 2. Create the Vivado project from your settings + HDL file lists
#    (this also runs gen-hdl and gen-xdc automatically)
nihdl gen-vivado --overwrite

# 3. Fast RTL elaboration check before a full compile
nihdl check-vivado

# 4. Full compile to a bitstream and LabVIEW FPGA bitfile
#    (this runs gen-lvbitx automatically at the end)
nihdl compile-vivado

Open the project interactively at any point with nihdl launch-vivado.

Building a Custom LabVIEW FPGA Target (hybrid flow)

To expose your HDL to LabVIEW FPGA as a custom target, define your I/O in the custom I/O CSV, then:

# Generate target support files (BoardIO/Clock XML, Window VHDL, plugin content)
nihdl gen-target

# Install the generated plugin into your LabVIEW FPGA install
nihdl install-target

Simulating with ModelSim

# Create the ModelSim project and compile all VHDL (vcom -autoorder -2008)
# When XilinxSimLibFolder is configured, this also compiles the Xilinx
# simulation libraries (unisim, secureip, ...) on the first run, which can
# take several minutes. Run it standalone with: nihdl compile-modelsim-lib
nihdl gen-modelsim

# Launch the GUI, or run headless with --batch
nihdl launch-modelsim

For the complete command list, options, and required settings, see the Command Reference.

Validating Without External Tools

To exercise settings and file generation without launching Vivado or ModelSim, set skip flags in your nihdlsettings.py:

def pre_all(context):
    config = context.config
    # ... configure settings ...
    config.set_skip_vivado(True)
    config.set_skip_modelsim(True)

Troubleshooting / FAQ

Error: Settings file not found: ...nihdlsettings.py Run the command from the target folder that contains nihdlsettings.py, or pass --config path/to/nihdlsettings.py.

A command reports a missing required setting. Each command validates the settings it needs before running. Check the Per-Command Setting Requirements table and confirm the corresponding setter is called in pre_all(). Remember that relative paths resolve from the nihdlsettings.py file's directory.

A relative path isn't resolving the way I expect. All hooks run with the working directory set to the nihdlsettings.py file's directory, and path setters resolve relative paths from there. Use forward slashes (/) on every platform.

launch-vivado / check-vivado / compile-vivado can't find the project. Run nihdl gen-vivado --overwrite first; these commands require an existing .xpr.

gen-lvbitx warns it isn't in the right place. It is intended to run from VivadoProject/<project>.runs/impl_1. It also needs to locate createBitfile.exe; it auto-discovers the latest installed LabVIEW (2023–2030), or set set_labview_path(...) to point at a specific install.

A dependency file collides by name with a target-specific copy. Use add_exclude_hdl_file_list(...) to drop the unwanted copy from the assembled HDL file list.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Stable release available (1.1.8)

Owner

PyPI data
Data sourced directly from PyPI's database.

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ssantolu from gravatar.com ssantolu

Credits

Author: Salvador Santolucito

License

MIT License (MIT)

Requires

Python <4.0, >=3.8

Classifiers

Report project as malware

Download files

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

Source Distribution

labview_fpga_hdl_tools-2.0.0.dev0.tar.gz (79.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

labview_fpga_hdl_tools-2.0.0.dev0-py3-none-any.whl (96.1 kB view details)

Uploaded Python 3

File details

Details for the file labview_fpga_hdl_tools-2.0.0.dev0.tar.gz.

File metadata

File hashes

Hashes for labview_fpga_hdl_tools-2.0.0.dev0.tar.gz
Algorithm Hash digest
SHA256 12d0ced4fa5368196a559677de4bd6fc0f8872f01108fc0cbe18eba23ec69b56
MD5 cfb5d0d0097b80dfbf8089816ec15872
BLAKE2b-256 5e0d031fb282b0fa0fdd87752e246c8ed328516dfe6e20fe4b73426c66bfa6b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for labview_fpga_hdl_tools-2.0.0.dev0.tar.gz:

Publisher: publish.yml on ni/labview-fpga-hdl-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file labview_fpga_hdl_tools-2.0.0.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for labview_fpga_hdl_tools-2.0.0.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a340120c6067a683e407d949a889de24db8a85630f11900cfc42ae99d25848e
MD5 4ba5d0027576ba9e9b109cacbbda20d2
BLAKE2b-256 4e5cded4b07cca63ccb1152ea3d6f09908e4dd5f9a6b8b8584e56110cefd9126

See more details on using hashes here.

Provenance

The following attestation bundles were made for labview_fpga_hdl_tools-2.0.0.dev0-py3-none-any.whl:

Publisher: publish.yml on ni/labview-fpga-hdl-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Pre-release

2.0.0.dev5

2 files

Pre-release

2.0.0.dev4

2 files

Pre-release

2.0.0.dev3

2 files

Pre-release

2.0.0.dev2

2 files

Pre-release

2.0.0.dev1

2 files

This release
Pre-release

2.0.0.dev0 This release

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

0.4.11

2 files

0.4.10

2 files

0.4.9

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.25

2 files

0.0.24

2 files

0.0.23

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.15

2 files

0.0.14

2 files

Supported by

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