FlexRIO API Reference

FlexRIO API Reference

The FlexRIO API enables streaming with FlexRIO devices with integrated I/O without programming the FPGA. The FlexRIO API provides the same functionality both in LabVIEW as VIs and in C/C++.

Programming Flow

The following steps indicate the basic programming flow for using the FlexRIO API in your own applications.

1. Open a session. Open downloads the default bitfile to the FPGA and establishes communication with the device.
2. Configure the stream. Configuration VIs allow you to configure streaming properties such as channels enabled in the stream and clocks.
3. Acquire data. Use Start Stream to activate the stream and Read Stream to read data from the stream.
4. Close the session. Use Close to terminate the streaming session, destroy the session reference, and deallocate resources associated with the streaming session. You must call Close for every session you open with Open.

Error Handling

LabVIEW VIs provide standard error in and error out functionality. C functions return status information. Use niFlexRIO_GetError to get a description of errors.

Examples

FlexRIO API examples demonstrate the programming flow and proper use of FlexRIO API functions and properties. FlexRIO LabVIEW examples are installed in <LabVIEW>\examples\FlexRIO.