VirtualBench VI Reference Help

SPI Initialize (VI)

  • Updated2023-09-07
  • 4 minute(s) read

SPI Initialize (VI)

Owning Palette: Serial Peripheral Interface
Installed With: NI-VirtualBench application development support

Creates and returns a new VirtualBench SPI session on the SPI engine for the device. The session is used in all subsequent VirtualBench SPI VI calls. This VI should be called once per session.

SPI Initialize

cio.gif

Bus specifies the name of the bus channel of the device. The valid channel to use is <device name>/spi/0. For spi/0, the clock is output on dig/0, MOSI is on dig/1, MISO is on dig/2, and CS is output on dig/3.

cbool.gif

Reset specifies whether to reset the device after initialization. If set to true, configuration is set to the default values. Refer to the Reset VI for more information.

cerrcodeclst.gif

error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. If an error occurs while this VI or function runs, the VI or function runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source identifies where an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.

iio.gif

Instrument Handle Out is a reference to the instrument.

ierrcodeclst.gif

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, error out describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source identifies where and why an error occurred. The source string includes the name of the VI that produced the error, what inputs are in error, and how to eliminate the error.