NI CompactRIO Waveform Reference Library

Overview

The following installer contains host VIs, FPGA templates, and example projects for performing waveform data acquisition on NI RIO hardware. The configuration and acquisition VIs incorporate optimizations and best practices for the RIO platform, and you can easily modify the examples to jump-start your application development.

Downloads

Filename: crio_wfm_acq_260.zip
Requirements: View

Filename: criowfm_401_installer.zip
Requirements: View

Filename: criowfm_305_installer.zip
Requirements: View

Filename: crio_wfm_acq_271.zip
Requirements: View

Downloads

Direct Download Options:
criowfm_400_installer.zip
is compatible with LabVIEW 2012 or later and is not backwards compatible with previous versions of the library.  It includes new LabVIEW features including floating point on FPGA and C Series sample rate abstractions.

criowfm_305_installer.zip is compatible with LabVIEW 2010 or later

VIPM Download: 
Get the cRIO Waveform Reference Library from the LabVIEW Tools Network.  The Tools Network allows for easy installation and automatically notifies you when new updates are released.

 

Introduction

Many reconfigurable I/O (RIO) applications acquire continuous blocks of data from multiple synchronized NI C Series modules. This tutorial presents CompactRIO data acquisition VIs that incorporate RIO optimizations and best practices, and offers several examples to jump-start your application development.

Figure 1. Continuous Acquisition Example

 

Features

Palette Overview (LabVIEW 2010 and later)

The cRIO Wfm Library installs to the user.lib directory and appears under the User Libraries palette.

Figure 2: cRIO Wfm Reference Library Palette

 

Example Project Overview

cRIO Wfm Examples.lvproj demonstrates common acquisition modes and how to link host code to FPGA code.  The project is located at: 

National Instruments\LabVIEW [Version]\user.lib\cRIO Wfm\_exampleProjects

You will likely need to move this example to another FPGA target and then use a "save as" on all VIs to avoid editing the source install.  For more information refer to ni.com/info and enter info code fpgaex.

Figure 3. Example Project Overview

  1. The Host Examples section demonstrate various flavors of continuous and finite acquisition.
  2. The FPGA Templates section has one template for Delta Sigma based modules and one template for SAR based modules.  Under the FPGA target you will also find the DMA Channel, and a PDF document describing how to customize the FPGA VIs for your hardware configuration.

 

Example Program Architectures

Finite Acquisition: The finite acquisition mode tells the FPGA to acquire a certain number of samples and then terminate the acquisition. In this acquisition mode, ConfigTiming.vi calls BufferConfig.vi and sets the host application's data buffer size equal to the number of points in the finite acquisition.

Finite Acquisition with Subset Reads: Again a finite acquisition allocates exactly enough memory to hold all of the requested samples per channel. Read(poly).vi has a control named Samps Read per Chan that you can use to specify the block size returned by each call, so you can read the finite acquisition in multiple subsets - a useful feature in many processing applications. 

Finite Acquisition with Rearming Software Start Trigger: When a finite acquisition terminates, the FPGA automatically rearms itself for another acquisition. You simply need to call Start.vi to perform another finite acquisition.

Continuous Acquisition: The continuous acquisition mode tells the FPGA to acquire points indefinitely until a stop command is issued or until an error is encountered (FIFO overflow, module underflow, and so on). In this acquisition mode, use BufferCfg.vi to explicitly set the host application's data buffer to be many times larger than the read size. The examples use a 10X size by default. If the host application's data buffer fills, then the FPGA experiences a FIFO overflow causing the acquisition to stop.

Continuous Acquisition with Start/Stop or Pause Functionality: If a finite acquisition is too large for the amount of memory available on the host controller, then perform a continuous acquisition for a finite period of time via a state machine. When you call Stop.vi, the FPGA stops the acquisition and immediately rearms itself waiting for Start.vi to be called. The stop VI also flushes the host application's data buffer so subsequent acquisitions do not return old data.

 

Continuous Acquisition Benchmarks

For each of the controllers listed, the CompactRIO Continuous Acquisition Example acquired data continuously and streamed it to either a local technical data management streaming (TDMS) file, a local binary file, or a remote host through TCP/IP. The bandwidth values represent the amount of data that can be streamed indefinitely (or until the hard drive is filled).

Stream to Disk [TDMS]: sample rate = 51.2 kS/s

Controller 1D Wfm SGL 2D Array SGL Interleaved SGL
NI 9074 6 chan (1.23 MB/s) 7 chan (1.43 MB/s) 8 chan (1.64 MB/s)
NI 9014 8 chan (1.64 MB/s) 10 chan (2.05 MB/s) 13 chan (2.66 MB/s)
NI 9076 9 chan (1.84 MB/s) 12 chan (2.45 MB/s) 15 chan (3.07 MB/s)
NI 9022 10 chan (2.05 MB/s) 13 chan (2.66 MB/s) 19 chan (3.89 MB/s)
NI 9024 15 chan (3.07 MB/s) 19 chan (3.89 MB/s) 27 chan (5.53 MB/s)

 

Stream to Disk [Binary]: sample rate = 51.2 kS/s

Controller Interleaved SGL
NI 9074 8 chan (1.64 MB/s)
NI 9014 18 chan (3.69 MB/s)
NI 9076 20 chan (4.10 MB/s)
NI 9022 25 chan (5.12 MB/s)
NI 9024 36 chan (7.37 MB/s)

 

Stream over TCP/IP: sample rate = 51.2 kS/s

Controller 1D Wfm SGL 2D Array SGL Interleaved SGL
NI 9074 12 chan (2.46 MB/s) 13 chan (2.66 MB/s) 18 chan (3.69 MB/s)
NI 9014 12 chan (2.46 MB/s) 14 chan (2.87 MB/s) 23 chan (4.71 MB/s)
NI 9022 16 chan (3.28 MB/s) 20 chan (4.10 MB/s) 35 chan (7.17 MB/s)
NI 9024 29 chan (5.94 MB/s) 32 chan (6.55 MB/s) 54 chan (11.08 MB/s)

   

Related Links

Developer Zone: cRIO Vibration Data Logger Reference Design - A LabVIEW reference design with a focus on embedded vibration monitoring, data logging, communications, and headless configuration.

Developer Zone: Reference Applications for cRIO Order Analysis using a High Speed Tach - A LabVIEW reference design demonstrating how to acquire vibration and a tachometer at different rates and how to synchronize that data to perform order analysis.

Developer Zone: cRIO Reference Designs for Structural Health Monitoring - A LabVIEW reference design with a focus on structural health monitoring including shunt calibration and data logging.

 

Discussion and Feedback

This reference application was created by the NI Systems Engineering group. 

We do not regularly monitor Reader Comments posted on this page. Please submit your feedback to the CompactRIO Waveform Reference Applications discussion forum.

Requirements

Filename: crio_wfm_acq_260.zip

Software Requirements:


Application Software: LabVIEW Full Development System 8.6
Toolkits and Add-Ons: LabVIEW FPGA Module 8.6, LabVIEW Real-Time Module 8.6
Language(s): LabVIEW

Hardware Requirements:


Hardware Group: CompactRIO
Driver: NI-RIO 3.1
Filename: criowfm_401_installer.zip

Software Requirements:


Application Software: LabVIEW Development System 2012
Toolkits and Add-Ons: LabVIEW Real-Time Module 2012, LabVIEW FPGA Module 2012

Hardware Requirements:


Hardware Group: CompactRIO
Driver: NI-RIO 5.0
Filename: criowfm_305_installer.zip

Software Requirements:


Application Software: LabVIEW Full Development System 2010
Toolkits and Add-Ons: LabVIEW Real-Time Module 2010, LabVIEW FPGA Module 2010

Hardware Requirements:


Hardware Group: CompactRIO
Driver: NI-RIO 3.5
Filename: crio_wfm_acq_271.zip

Software Requirements:


Application Software: LabVIEW Full Development System 8.6
Toolkits and Add-Ons: LabVIEW Real-Time Module 8.6, LabVIEW FPGA Module 8.6
Language(s): LabVIEW

Hardware Requirements:


Hardware Group: CompactRIO
Driver: NI-RIO 3.1